Interface Tracing

Package version

Main interface for tracing.

Hierarchy

Tracing

Index

Properties

Methods

Properties

active

active: boolean

Gets active status

exporter

exporter: Exporter

Service to send collected traces to.

tracer

tracer: TracerBase

Object responsible for managing a trace.

Methods

registerExporter

registerExporter(exporter: Exporter): Tracing

- Defined in home/vsts/work/1/s/common/temp/node_modules/.registry.npmjs.org/@opencensus/web-types/0.0.7/node_modules/@opencensus/web-types/build/src/trace/types.d.ts:40
Registers an exporter to send the collected traces to.

Parameters
- exporter: Exporter
  
  The exporter to send the traces to.
Returns Tracing

The tracing object.

start

start(userConfig?: configTypes.Config): Tracing

- Defined in home/vsts/work/1/s/common/temp/node_modules/.registry.npmjs.org/@opencensus/web-types/0.0.7/node_modules/@opencensus/web-types/build/src/trace/types.d.ts:32
Starts tracing.

Parameters
- Optional userConfig: configTypes.Config
  
  A configuration object to start tracing.
Returns Tracing

The started Tracing instance.

stop

stop(): void

- Defined in home/vsts/work/1/s/common/temp/node_modules/.registry.npmjs.org/@opencensus/web-types/0.0.7/node_modules/@opencensus/web-types/build/src/trace/types.d.ts:34
Stops tracing.

Returns void

unregisterExporter

unregisterExporter(exporter: Exporter): Tracing

- Defined in home/vsts/work/1/s/common/temp/node_modules/.registry.npmjs.org/@opencensus/web-types/0.0.7/node_modules/@opencensus/web-types/build/src/trace/types.d.ts:45
Unregisters an exporter.

Parameters
- exporter: Exporter
  
  The exporter to stop sending traces to.
Returns Tracing

Generated using TypeDoc