https://github.com/nodesource/ah-preprocessors
Preprocessors of data provided by ah-collector.
https://github.com/nodesource/ah-preprocessors
Last synced: 4 months ago
JSON representation
Preprocessors of data provided by ah-collector.
- Host: GitHub
- URL: https://github.com/nodesource/ah-preprocessors
- Owner: nodesource
- License: mit
- Created: 2017-03-09T15:29:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-09T16:02:28.000Z (almost 9 years ago)
- Last Synced: 2024-11-15T00:38:36.827Z (about 1 year ago)
- Language: JavaScript
- Size: 1.13 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ah-preprocessors
Preprocessors of data provided by ah-collector.
## Installation
npm install ah-preprocessors
## [API](https://nodesource.github.io/ah-preprocessors)
### Cloner
Creates a Cloner instance which is just a thin wrapper
on top of [facile-clone](https://github.com/thlorenz/facile-clone) and clones an object preserving Buffers and
strings according to the options supplied.
**Parameters**
- `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** options applied when cloning objects
- `$0.bufferLength` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** determines how many elements of Buffers are
captured. By default not Buffer data is captured. (optional, default `0`)
- `$0.stringLength` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** determines how much of each string is
captured. By default no string data is captured. (optional, default `0`)
### cloner.clone
Clones the object according to the options supplied in the constructor.
**Parameters**
- `x` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the object to clone
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the cloned object
### ResourceProcesor
Creates an instance of ResourceProcessor.
Never call this directly, instead extend it to create a specific processor
for your particular resource type, i.e. `NetworkResourceProcessor`.
Makes sure that each resource is only processed once.
**Parameters**
- `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** options specifying if arguments and function source are captured and how they are cloned
- `$0.cloner` **[Cloner](#cloner)** used to clone the resource information
- `$0.captureArguments` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` arguments of callbacks
are captured when they are processed. (optional, default `false`)
- `$0.captureSource` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` the source code of callbacks
is captured when they are processed. (optional, default `false`)
### resourceProcessor.cleanAllResources
Cleans up all captured resources which means that they are processed,
meaningful data extracted and the reference to the actual resource removed
so it can be GCed.
**Parameters**
- `activities` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the activities whose resources should be cleaned
- `collectFunctionInfo` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` it will collect info of all
functions found on the hooks resources. (optional, default `false`)
### resourceProcessor.cleanupResource
Cleans the particular resource of the activity found by the uid as part of the activities.
If the uid isn't found in the activities or the activity is `null` this function returns
without doing anything.
**Parameters**
- `uid` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** the id that identifies the activity whose resource should be cleaned
- `activities` **[Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)<([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)), [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** the activities that contain the activity whose resource should be
cleaned
- `collectFunctionInfo` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` it will collect info of all
functions found on the hooks resources. (optional, default `false`)
### scoutFunctions
Scouts functions using [function-scout](https://github.com/nodesource/function-scout)
and then adapts the data according to the supplied options.
In the process clones function arguments as well and appends them to the returned
function info
This function is used by the `ResourceProcessor` and most likely you won't have to call
it directly.
Sample return value:
```js
[ { path: [ 'owner', '_events', 'connection' ],
key: 'connection',
level: 2,
info:
FunctionOrigin {
file: '/Volumes/d/dev/js/async-hooks/ah-net/test/one-tcp-server.listen+close.js',
line: 25,
column: 21,
inferredName: '',
name: 'onconnection' },
id: 2,
arguments: null }]
```
**Parameters**
- `ctx` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the context that should be scouted for functions
- `uid` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the id which is appended to each function info
- `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** options specifying if arguments and function source are captured and how they are cloned
- `$0.captureArguments` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` arguments of callbacks
are captured when they are processed. (optional, default `false`)
- `$0.captureSource` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` the source code of callbacks
is captured when they are processed. (optional, default `false`)
- `$0.cloner` **[Cloner](#cloner)** used to clone the function arguments
- `$0.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** if supplied it will be prepended to all function paths (optional, default `null`)
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** array of function information elements, one for each function encountered
## License
MIT