Global

Methods

createShimFromType(params) → {Shim}

Parameters:

Name Type Description

params

object

input params

Properties

Name	Type	Description
`type`	string	shim type
`agent`	Agent	instance of agent
`moduleName`	string	module name
`resolvedName`	string	fully resolved name of module
`shimName`	string	name of shim, used to associate multiple shim instances
`pkgVersion`	string	version of pkg

Source: lib/shim/index.js, line 37

Returns:

shim instance

Type:: Shim

Type Definitions

CallbackBindFunction(shim, func, name, segment, args)

Performs segment binding on a callback function. Useful when identifying a callback is more complex than a simple argument offset.

Parameters:

Name	Type	Description
`shim`	Shim	The shim this function was passed to.
`func`	function	The function being recorded.
`name`	string	The name of the function.
`segment`	TraceSegment	The segment that the callback should be bound to.
`args`	Array.<*>	The arguments being passed into the function.

Source: lib/shim/shim.js, line 225

ClassWrapSpecParams

Type:

object

Properties

Name	Type	Attributes
`es6`	boolean	<optional>
`pre`	function	<optional>
`post`	function	<optional>

Mixes In: WrapSpecParams
Source: lib/shim/specs/class.js, line 11

ConstructorHookFunction(shim, Base, name, args)

Pre/post constructor execution hook for wrapping classes.

Parameters:

Name	Type	Description
`shim`	Shim	The shim performing the wrapping/binding.
`Base`	function	The class that was wrapped.
`name`	string	The name of the `Base` class.
`args`	Array.<*>	The arguments to the class constructor.

Source: lib/shim/specs/class.js, line 19
See: ClassWrapSpec.pre

DatastoreParametersParams

Type:

object

Properties

Name	Type	Description
`host`	string	The host of the database server being interacted with. If provided, along with `port_path_or_id`, then an instance metric will also be generated for this database.
`port_path_or_id`	number \| string	The port number or path to domain socket used to connect to the database server.
`database_name`	string	The name of the database being queried or operated on.
`collection`	string	The name of the collection or table being queried or operated on.

Source: lib/shim/specs/params/datastore.js, line 8

InContextCallback(segment)

A function that will be invoked in the context of the current segment. Instrumentations that need to perform operations during the invocation of a method that has been instrumented can provide an InContextCallback function to accomplish their needs. The callback is invoked in the same async context as the instrumented function, i.e. concurrent to the execution of the instrumented function, and within the same segment.

Parameters:

Name	Type	Description
`segment`	TraceSegment	The current segment.

Source: lib/shim/specs/segment.js, line 10

InstrumentationDescriptorParams

Type:

object

Properties

Name	Type	Description
`absolutePath`	string
`module`	string
`moduleName`	string
`shimName`	string
`onError`	InstrumentationOnError
`onRequire`	InstrumentationOnRequire
`resolvedName`	string
`type`	string

Source: lib/instrumentation-descriptor.js, line 28

InstrumentationOnError(error)

Parameters:

Name	Type	Description
`error`	Error \| object	The error thrown by `onRequire` when there was an issue registering the instrumentation.

Source: lib/instrumentation-descriptor.js, line 21

InstrumentationOnRequire(shim, resolvedNodule, moduleName)

Parameters:

Name	Type	Description
`shim`	Shim	The shim instance to use for the instrumentation.
`resolvedNodule`	object	The module being instrumented as returned by Node's `require` function.
`moduleName`	string	The simple name of the module, i.e. the value passed to the `require` function.

Source: lib/instrumentation-descriptor.js, line 11

Throws:

Error | object

MessageBrokerHeadersFn(inject) → {Array.<object>}

Parameters:

Name	Type	Description
`inject`	function	A function with the signature `function(headers, useAlternateHeaderNames)`. The passed in headers object will be updated with distributed trace headers. When the second parameter is `true` (the default), alternate style (not HTTP style) header names will be used, i.e. names that are safe for non-HTTP transports.

Source: lib/shim/specs/message.js, line 23

Returns:

An array of objects, wherein each object will be updated with distributed trace headers.

Type:: Array.<object>

MessageConsumerWrapperFunction(shim, consumer, name, queue) → {function}

Function that is used to wrap message consumer functions. Used alongside the MessageShim#recordSubscribedConsume API method.

Parameters:

Name	Type	Description
`shim`	MessageShim	The shim this function was handed to.
`consumer`	function	The message consumer to wrap.
`name`	string	The name of the consumer method.
`queue`	string	The name of the queue this consumer is being subscribed to.

Source: lib/shim/message-shim/index.js, line 148
See: MessageShim#recordSubscribedConsume
MessageShim#recordConsume

Returns:

The consumer method, possibly wrapped.

Type:: function

MessageFunction(shim, func, name, args) → {specs.MessageSpec}

Used for determining information about a message either being produced or consumed.

Parameters:

Name	Type	Description
`shim`	MessageShim	The shim this function was handed to.
`func`	function	The produce method or message consumer.
`name`	string	The name of the producer or consumer.
`args`	Array.<*>	The arguments being passed into the produce method or consumer.

Source: lib/shim/message-shim/index.js, line 107
See: MessageShim#recordProduce
MessageShim#recordConsume

Returns:

The specification for the message being produced or consumed.

Type:: specs.MessageSpec

MessageHandlerFunction(shim, func, name, args) → {specs.MessageSpec}

A function that is used to extract properties from a consumed message. This method is handed the results of a consume call. If the consume used a callback, then this method will receive the arguments to the callback. If the consume used a promise, then this method will receive the resolved value.

Parameters:

Name	Type	Description
`shim`	MessageShim	The shim this function was handed to.
`func`	function	The produce method or message consumer.
`name`	string	The name of the producer or consumer.
`args`	Array \| *	Either the arguments for the consumer callback function or the result of the resolved consume promise, depending on the mode of the instrumented method.

Source: lib/shim/message-shim/index.js, line 126
See: MessageShim#recordConsume

Returns:

The extracted properties of the consumed message.

Type:: specs.MessageSpec

MessageSpecParams

Type:

object

Properties

Name	Type	Attributes
`destinationName`	number \| string	<optional>
`destinationType`	string \| null	<optional>
`headers`	Object.<string, string> \| null	<optional>
`messageHeaders`	MessageBrokerHeadersFn \| null	<optional>
`messageHandler`	MessageHandlerFunction \| null	<optional>
`queue`	number \| string \| null	<optional>
`routingKey`	string \| null	<optional>

Mixes In: OperationSpecParams
Source: lib/shim/specs/message.js, line 11

MessageSubscribeSpecParams

Type:

object

Properties

Name	Type	Attributes	Description
`consumer`	number \| null	<optional>

Mixes In: MessageSpecParams
Source: lib/shim/specs/message-subscribe.js, line 11

MiddlewareMounterSpecParams

Type:

object

Properties

Name	Type	Attributes	Description
`route`	RouteParserFunction \| string \| number \| null	<optional>
`wrapper`	MiddlewareWrapperFunction	<optional>

Mixes In: MiddlewareSpecParams
Source: lib/shim/specs/middleware-mounter.js, line 44

MiddlewareSpecParams

Type:

object

Properties

Name	Type	Attributes
`appendPath`	boolean	<optional>
`next`	number \| RouteNextFunction	<optional>
`params`	RouteParameterFunction \| null	<optional>
`req`	number \| RouteRequestFunction	<optional>
`res`	number	<optional>
`route`	number \| string \| null	<optional>
`type`	string	<optional>

Mixes In: RecorderSpecParams
Source: lib/shim/specs/middleware.js, line 46

MiddlewareTypeNames

Type:

Object.<string, string>

Source: lib/shim/webframework-shim/common.js, line 11

MiddlewareWrapperFunction(shim, middleware, fnName, routeopt)

Called for each middleware passed to a mounting method. Should perform the wrapping of the middleware.

Parameters:

Name	Type	Attributes	Default	Description
`shim`	WebFrameworkShim			The shim used for instrumentation.
`middleware`	function			The middleware function to wrap.
`fnName`	string			The name of the middleware function.
`route`	string	<optional>	null	The route the middleware is mounted on if one was found.

Source: lib/shim/specs/middleware-mounter.js, line 26
See: WebFrameworkShim#recordMiddleware
WebFrameworkShim#recordParamware

OperationSpecParams

Type:

object

Properties

Name	Type	Attributes	Description
`parameters`	DatastoreParameters \| QueueMessageParameters \| null	<optional>
`record`	boolean	<optional>

Mixes In: RecorderSpecParams
Source: lib/shim/specs/operation.js, line 11

QueryFunction(shim, func, name, args) → {string}

Retrieves the query argument from an array of arguments.

Parameters:

Name	Type	Description
`shim`	Shim	The shim this function was passed to.
`func`	function	The function being recorded.
`name`	string	The name of the function.
`args`	Array.<*>	The arguments being passed into the function.

Source: lib/shim/specs/query.js, line 10

Returns:

The query string from the arguments list.

Type:: string

QueryParserFunction(query) → {ParsedQueryData}

Used to parse queries to extract the basic information about it.

Parameters:

Name	Type	Description
`query`	string	The query to be parsed.

Source: lib/shim/datastore-shim.js, line 141
See: DatastoreShim#setParser
ParsedQueryData

Returns:

An object containing the basic information about the query.

Type:: ParsedQueryData

QuerySpecFunction(shim, func, name, args) → {QuerySpec}

Used for determining information about a query when it can not be simply found in the arguments.

Parameters:

Name	Type	Description
`shim`	Shim	The shim this function was passed to.
`func`	function	The function being recorded.
`name`	string	The name of the function.
`args`	Array.<*>	The arguments being passed into the function.

Source: lib/shim/datastore-shim.js, line 122
See: DatastoreShim#recordQuery
DatastoreShim#recordBatchQuery
QuerySpec

Returns:

The spec for how this query should be recorded.

Type:: QuerySpec

QuerySpecParams

Type:

object

Properties

Name	Type	Attributes	Description
`query`	number \| string \| QueryFunction	<optional>

Mixes In: OperationSpecParams
Source: lib/shim/specs/query.js, line 22

QueueMessageParametersParams

Type:

object

Properties

Name	Type	Attributes
`correlation_id`	string	<optional>
`reply_to`	string	<optional>
`routing_key`	string	<optional>

Source: lib/shim/specs/params/queue-message.js, line 9

RecorderFunction(shim, func, name, args) → {string|RecorderSpec}

A function which is called to compose a segment for recording.

Parameters:

Name	Type	Description
`shim`	Shim	The shim this function was passed to.
`func`	function	The function being recorded.
`name`	string	The name of the function.
`args`	Array.<*>	The arguments being passed into the function.

Source: lib/shim/shim.js, line 210

Returns:

The desired properties for the new segment.

Type:: string | RecorderSpec

RecorderSpecParams

Type:

object

Properties

Name	Type	Attributes
`after`	SpecAfterFunction	<optional>
`callback`	number \| CallbackBindFunction	<optional>
`callbackRequired`	boolean	<optional>
`promise`	boolean	<optional>
`rowCallback`	number \| CallbackBindFunction	<optional>
`stream`	boolean \| string	<optional>

Mixes In: SegmentSpecParams
Source: lib/shim/specs/recorder.js, line 11

RenderSpecParams

Type:

object

Properties

Name	Type	Attributes	Description
`view`	number	<optional>

Mixes In: RecorderSpecParams
Source: lib/shim/specs/render.js, line 12

RouteNextFunction(shim, fn, fnName, args) → {object}

Used to wrap functions that users can call to continue to the next middleware.

Parameters:

Name	Type	Description
`shim`	WebFrameworkShim	The shim used for instrumentation.
`fn`	function	The middleware function.
`fnName`	string	The name of the middleware function.
`args`	Array	The arguments to the middleware function.

Source: lib/shim/specs/middleware.js, line 22

Returns:

The request object.

Type:: object

RouteParameterFunction(shim, fn, fnName, args) → {object}

Extracts the route parameters from the arguments to the middleware function.

Parameters:

Name	Type	Description
`shim`	WebFrameworkShim	The shim used for instrumentation.
`fn`	function	The middleware function.
`fnName`	string	The name of the middleware function.
`args`	Array	The arguments to the middleware function.

Source: lib/shim/specs/middleware.js, line 34

Returns:

A map of route parameter names to values.

Type:: object

RouteParserFunction(shim, fn, fnName, route) → {string|RegExp}

Called whenever new middleware are mounted using the instrumented framework, this method should pull out a representation of the mounted path.

Parameters:

Name	Type	Description
`shim`	WebFrameworkShim	The shim in use for this instrumentation.
`fn`	function	The function which received this route string/RegExp.
`fnName`	string	The name of the function to which this route was given.
`route`	string \| RegExp	The route that was given to the function.

Source: lib/shim/specs/middleware-mounter.js, line 10

Returns:

The mount point from the given route.

Type:: string | RegExp

RouteRequestFunction(shim, fn, fnName, args) → {object}

Extracts the request object from the arguments to the middleware function.

Parameters:

Name	Type	Description
`shim`	WebFrameworkShim	The shim used for instrumentation.
`fn`	function	The middleware function.
`fnName`	string	The name of the middleware function.
`args`	Array	The arguments to the middleware function.

Source: lib/shim/specs/middleware.js, line 11

Returns:

The request object.

Type:: object

SegmentFunction(shim, func, name, args) → {string|SegmentSpec}

A function which is called to compose a segment.

Parameters:

Name	Type	Description
`shim`	Shim	The shim this function was passed to.
`func`	function	The function the segment is created for.
`name`	string	The name of the function.
`args`	Array.<*>	The arguments being passed into the function.

Source: lib/shim/shim.js, line 195

Returns:

The desired properties for the new segment.

Type:: string | SegmentSpec

SegmentSpecParams

Type:

object

Properties

Name	Type	Attributes
`inContext`	InContextCallback	<optional>
`internal`	boolean	<optional>
`name`	string	<optional>
`opaque`	boolean	<optional>
`parameters`	Object.<string, *>	<optional>
`parent`	TraceSegment	<optional>
`recorder`	MetricFunction	<optional>

Source: lib/shim/specs/segment.js, line 23

SpecAfterFunction(params)

A callback invoked after an instrumented function has completed its work. The instrumented function must have been invoked synchronously.

Parameters:

Name Type Description

params

Object

params to function

Properties

Name	Type	Attributes	Description
`shim`	object		The shim used to instrument the external library.
`fn`	function		The function/method from the external library being instrumented.
`name`	string		The name of the current function.
`error`	Error \| null	<optional>	If the instrumented function threw an error, this will be that error. In the case of a callback this will be omitted.
`args`	Array	<optional>	arguments passed to a callback function getting instrumented.
`result`	*	<optional>	The result returned by the instrumented function. In the case of a wrapped callback, the data needed is in `params.args`.
`segment`	TraceSegment		The segment used while instrumenting the function.

Source: lib/shim/specs/recorder.js, line 22

TransactionSpecParams

Type:

object

Properties

Name	Type	Attributes	Description
`nest`	boolean	<optional>
`type`	string	<optional>

Mixes In: SegmentSpecParams
Source: lib/shim/specs/transaction.js, line 11

WrapFunction(shim, original, name) → {*}

A function which performs the actual wrapping logic.

If the return value of this function is not original then the return value will be marked as a wrapper.

Parameters:

Name	Type	Description
`shim`	Shim	The shim this function was passed to.
`original`	object \| function	The item which needs wrapping. Most of the time this will be a function.
`name`	string	The name of `original` if it can be determined, otherwise `'<anonymous>'`.

Source: lib/shim/shim.js, line 154

Returns:

The wrapper for the original, or the original value itself.

Type:: *

WrapSpecParams

Type:

object

Properties

Name	Type	Attributes	Description
`matchArity`	boolean	<optional>
`wrapper`	function	<optional>

Mixes In: SegmentSpecParams
Source: lib/shim/specs/wrap.js, line 11

startSegmentCallback(cb) → {Promise}

Parameters:

Name	Type	Description
`cb`	function	The function to time with the created segment.

Source: api.js, line 851

Returns:

Returns a promise if cb returns a promise.

Type:: Promise