Telemetry.md

Telemetry

Interface for a telemetry provider;

Kind: global class

• Telemetry
  • .init(vendor, config)
  • .notify(...args)
  • .setContext(...args)
  • .startSpan(...args)
  • .startChildSpan(...args)
  • .endSpan(...args)

telemetry.init(vendor, config)

Initialize a specefic telemetry provider class

Kind: instance method of Telemetry

Param	Type	Description
vendor	string	telemetry provider to use (currently supported: 'sentry')
config	object	options to initialize with

telemetry.notify(...args)

Call the telemetry provider's notify method to handle errors and messages.

Kind: instance method of Telemetry

Param	Type
...args	any

telemetry.setContext(...args)

Call the telemetry provider's setContext method (if it exists) to provide additonal data.

Kind: instance method of Telemetry

Param	Type
...args	any

telemetry.startSpan(...args)

Call the telemetry provider's startSpan method (if it exists) to start a tracking Span.

Kind: instance method of Telemetry

Param	Type
...args	any

telemetry.startChildSpan(...args)

Call the telemetry provider's startChildSpan method (if it exists) to start a tracking Span as child of an existing span.

Kind: instance method of Telemetry

Param	Type
...args	any

telemetry.endSpan(...args)

Call the telemetry provider's endSpan method (if it exists) to end an ongoing tracking Span.

Kind: instance method of Telemetry

Param	Type
...args	any