Tracer | @azure/app-configuration

Interface for Tracer Tracer provides an interface for creating Spans and propagating context in-process.

Users may choose to use manual or automatic Context propagation. Because of that this class offers APIs to facilitate both usages.

Hierarchy

TracerBase
- Tracer

Properties

active

active: boolean

Get the active status from tracer instance

activeTraceParams

activeTraceParams: TraceParams

A configuration object for trace parameters

currentRootSpan

currentRootSpan: Span

Get and set the currentRootSpan to tracer instance

eventListeners

eventListeners: SpanEventListener[]

Get the eventListeners from tracer instance

logger

logger: Logger

A configuration for starting the tracer

propagation

propagation: Propagation

A propagation instance

sampler

sampler: Sampler

A sampler that will decide if the span will be sampled or not

Methods

bind

bind<T>(target: T, span?: Span): T

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:875
Bind a span as the target's scope or propagate the current one.

Type parameters
- T
Parameters
- target: T
  
  Any object to which a scope need to be set
- Optional span: Span
Returns T

clearCurrentTrace

clearCurrentTrace(): 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/model/types.d.ts:460
Clear the currentRootSpan from tracer instance

Returns void

getBinaryFormat

getBinaryFormat(): BinaryFormat

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:895
Returns the BinaryFormat interface which can serialize/deserialize Spans.

If no tracer implementation is provided, this defaults to the W3C Trace Context binary format (BinaryFormat). For more details see W3C Trace Context binary protocol.

Returns BinaryFormat

getCurrentSpan

getCurrentSpan(): Span | null

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:852
Returns the current Span from the current context if available.

If there is no Span associated with the current context, null is returned.

Returns Span | null

Span The currently active Span

getHttpTextFormat

getHttpTextFormat(): HttpTextFormat

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:904
Returns the HttpTextFormat interface which can inject/extract Spans.

If no tracer implementation is provided, this defaults to the W3C Trace Context HTTP text format ({@link HttpTraceContext}). For more details see W3C Trace Context.

Returns HttpTextFormat

onEndSpan

onEndSpan(span: Span): void

Inherited from SpanEventListener.onEndSpan
- 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/model/types.d.ts:252
Happens when a span is ended

Parameters
- span: Span
Returns void

onStartSpan

onStartSpan(span: Span): void

Inherited from SpanEventListener.onStartSpan
- 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/model/types.d.ts:250
Happens when a span is started

Parameters
- span: Span
Returns void

recordSpanData

recordSpanData(span: Span): void

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:885
Send a pre-populated span object to the exporter. Sampling and recording decisions as well as other collection optimizations are the responsibility of a caller.

todo:

Pending API discussion. Revisit if Span or SpanData should be passed in here once this is sorted out.

Parameters
- span: Span
  
  Span Data to be reported to all exporters.
Returns void

registerSpanEventListener

registerSpanEventListener(listener: SpanEventListener): void

Inherited from TracerBase.registerSpanEventListener
- 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/model/types.d.ts:440
Register a OnEndSpanEventListener on the tracer instance

Parameters
- listener: SpanEventListener
  
  An OnEndSpanEventListener instance
Returns void

setCurrentRootSpan

setCurrentRootSpan(root: Span): void

Inherited from TracerBase.setCurrentRootSpan
- 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/model/types.d.ts:453
Sets the current root span.

Parameters
- root: Span
Returns void

start

start(config: TracerConfig): this

Inherited from TracerBase.start
- 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/model/types.d.ts:426
Start a tracer instance

Parameters
- config: TracerConfig
  
  Configuration for tracer instace
Returns this

A tracer instance started

startChildSpan

startChildSpan(options?: SpanOptions): Span

Inherited from TracerBase.startChildSpan
- 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/model/types.d.ts:451
Start a new Span instance to the currentRootSpan

Parameters
- Optional options: SpanOptions
Returns Span

The new Span instance started

startRootSpan

startRootSpan<T>(options: TraceOptions, fn: function): T

Inherited from TracerBase.startRootSpan
- 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/model/types.d.ts:435
Start a new RootSpan to currentRootSpan

Type parameters
- T
Parameters
- options: TraceOptions
  
  Options for tracer instance
- fn: function
  
  Callback function
  - - (root: Span): T
    - Parameters
      - root: Span
      Returns T
Returns T

The callback return

startSpan

startSpan(name: string, options?: SpanOptions): Span

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:859
Starts a new Span.

Parameters
- name: string
  
  The name of the span
- Optional options: SpanOptions
Returns Span

Span The newly created span

stop

stop(): this

Inherited from TracerBase.stop
- 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/model/types.d.ts:428
Stop the tracer instance

Returns this

unregisterSpanEventListener

unregisterSpanEventListener(listener: SpanEventListener): void

Inherited from TracerBase.unregisterSpanEventListener
- 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/model/types.d.ts:445
Unregisters an end span event listener.

Parameters
- listener: SpanEventListener
  
  The listener to unregister.
Returns void

withSpan

withSpan<T>(span: Span, fn: T): ReturnType<T>

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:868
Executes the function given by fn within the context provided by Span

example

tracer.withSpan(span, function() { ... });

Type parameters
- T: function
Parameters
- span: Span
  
  The span that provides the context
- fn: T
  
  The function to be executed inside the provided context
Returns ReturnType<T>

wrap

wrap<T>(fn: Func<T>): Func<T>

- 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/model/types.d.ts:468
Binds the trace context to the given function. This is necessary in order to create child spans correctly in functions that are called asynchronously (for example, in a network response handler).

Type parameters
- T
Parameters
- fn: Func<T>
  
  A function to which to bind the trace context.
Returns Func<T>

wrapEmitter

wrapEmitter(emitter: NodeJsEventEmitter): 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/model/types.d.ts:476
Binds the trace context to the given event emitter. This is necessary in order to create child spans correctly in event handlers.

Parameters
- emitter: NodeJsEventEmitter
  
  An event emitter whose handlers should have the trace context binded to them.
Returns void

Hierarchy

Index

Properties

Methods

Properties

active

activeTraceParams

currentRootSpan

eventListeners

logger

propagation

sampler

Methods

bind

Type parameters

T

Parameters

target: T

Optional span: Span

Returns T

clearCurrentTrace

Returns void

getBinaryFormat

Returns BinaryFormat

getCurrentSpan

Returns Span | null

getHttpTextFormat

Returns HttpTextFormat

onEndSpan

Parameters

span: Span

Returns void

onStartSpan

Parameters

span: Span

Returns void

recordSpanData

Parameters

span: Span

Returns void

registerSpanEventListener

Parameters

listener: SpanEventListener

Returns void

setCurrentRootSpan

Parameters

root: Span

Returns void

start

Parameters

config: TracerConfig

Returns this

startChildSpan

Parameters

Optional options: SpanOptions

Returns Span

startRootSpan

Type parameters

T

Parameters

options: TraceOptions

fn: function

Parameters

root: Span

Returns T

Returns T

startSpan

Parameters

name: string

Optional options: SpanOptions

Returns Span

stop

Returns this

unregisterSpanEventListener

Parameters

listener: SpanEventListener

Returns void

withSpan

Type parameters

T: function