Class TestTracer

Package version

A mock tracer useful for testing

Hierarchy

NoOpTracer
- TestTracer

Implements

Tracer

Index

Methods

Methods

bind

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

Inherited from NoOpTracer.bind
- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:325
Bind a Span as the target's scope

Type parameters
- T
Parameters
- target: T
  
  An object to bind the scope.
- Optional _span: Span
  
  A specific Span to use. Otherwise, use the current one.
Returns T

getActiveSpans

getActiveSpans(): TestSpan[]

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:791
Returns all Spans where end() has not been called

Returns TestSpan[]

getBinaryFormat

getBinaryFormat(): BinaryFormat

Inherited from NoOpTracer.getBinaryFormat
- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:334
Returns the BinaryFormat interface for serializing/deserializing Spans.

Returns BinaryFormat

getCurrentSpan

getCurrentSpan(): Span

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

Returns Span

getHttpTextFormat

getHttpTextFormat(): HttpTextFormat

Inherited from NoOpTracer.getHttpTextFormat
- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:338
Returns the HttpTextFormat interface for injecting/extracting Spans.

Returns HttpTextFormat

getKnownSpans

getKnownSpans(): TestSpan[]

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:787
Returns all Spans this Tracer knows about

Returns TestSpan[]

getRootSpans

getRootSpans(): TestSpan[]

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:783
Returns all Spans that were created without a parent

Returns TestSpan[]

getSpanGraph

getSpanGraph(traceId: string): SpanGraph

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:797
Return all Spans for a particular trace, grouped by their parent Span in a tree-like structure

Parameters
- traceId: string
  
  The traceId to return the graph for
Returns SpanGraph

recordSpanData

recordSpanData(_span: Span): void

Inherited from NoOpTracer.recordSpanData
- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:330
Send a pre-populated Span object to the exporter.

Parameters
- _span: Span
  
  The span to pass along.
Returns void

startSpan

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

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

Parameters
- name: string
  
  The name of the span.
- Optional options: SpanOptions
  
  The SpanOptions used during Span creation.
Returns TestSpan

withSpan

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

Inherited from NoOpTracer.withSpan
- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:319
Executes the given function within the context provided by a Span.

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

Generated using TypeDoc