@azure/core-tracing

Package version

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

Exception

Exception: ExceptionWithCode | ExceptionWithMessage | ExceptionWithName | string

An Exception for a Span.

HrTime

HrTime: [number, number]

Represents high resolution time.

SpanAttributeValue

SpanAttributeValue: string | number | boolean | Array<null | undefined | string> | Array<null | undefined | number> | Array<null | undefined | boolean>

Attribute values may be any non-nullish primitive value except an object.

null or undefined attribute values are invalid and will result in undefined behavior.

TimeInput

TimeInput: HrTime | number | Date

Used to represent a Time.

Variables

Const VERSION

VERSION: "00" = "00"

Const context

context: ContextAPI = otContext

Entrypoint for context API

Functions

extractSpanContextFromTraceParentHeader

extractSpanContextFromTraceParentHeader(traceParentHeader: string): SpanContext | undefined

- Defined in utils/traceParentHeader.ts:13
Generates a SpanContext given a traceparent header value.

Parameters
- traceParentHeader: string
Returns SpanContext | undefined

The SpanContext generated from the traceparent value.

getSpan

getSpan(context: Context): Span | undefined

- Defined in interfaces.ts:174
Return the span if one exists

Parameters
- context: Context
  
  context to get span from
Returns Span | undefined

getSpanContext

getSpanContext(context: Context): SpanContext | undefined

- Defined in interfaces.ts:204
Get the span context of the span if it exists.

Parameters
- context: Context
  
  context to get values from
Returns SpanContext | undefined

getTraceParentHeader

getTraceParentHeader(spanContext: SpanContext): string | undefined

- Defined in utils/traceParentHeader.ts:44
Generates a traceparent value given a span context.

Parameters
- spanContext: SpanContext
  
  Contains context for a specific span.
Returns string | undefined

The spanContext represented as a traceparent value.

getTracer

getTracer(): Tracer
getTracer(name: string, version?: undefined | string): Tracer

- Defined in interfaces.ts:233
Retrieves a tracer from the global tracer provider.

Returns Tracer
- Defined in interfaces.ts:237
Retrieves a tracer from the global tracer provider.

Parameters
- name: string
- Optional version: undefined | string
Returns Tracer

isSpanContextValid

isSpanContextValid(context: SpanContext): boolean

- Defined in interfaces.ts:226
Returns true of the given SpanContext is valid. A valid SpanContext is one which has a valid trace ID and span ID as per the spec.

Parameters
- context: SpanContext
  
  the SpanContext to validate.
Returns boolean

true if the SpanContext is valid, false otherwise.

isTracingDisabled

isTracingDisabled(): boolean

- Defined in createSpan.ts:36
Returns boolean

setSpan

setSpan(context: Context, span: Span): Context

- Defined in interfaces.ts:184
Set the span on a context

Parameters
- context: Context
  
  context to use as parent
- span: Span
  
  span to set active
Returns Context

setSpanContext

setSpanContext(context: Context, spanContext: SpanContext): Context

- Defined in interfaces.ts:195
Wrap span context in a NoopSpan and set as span in a new context

Parameters
- context: Context
  
  context to set active span on
- spanContext: SpanContext
  
  span context to be wrapped
Returns Context

Generated using TypeDoc