@azure/core-tracing package
Interfaces
Instrumenter |
Represents an implementation agnostic instrumenter. |
InstrumenterSpanOptions |
Options passed to startSpan as a superset of TracingSpanOptions. |
OperationTracingOptions |
Tracing options to set on an operation. |
TracingClient |
Represents a client that can integrate with the currently configured Instrumenter. Create an instance using createTracingClient. |
TracingClientOptions |
Options that can be passed to createTracingClient |
TracingContext |
An immutable context bag of tracing values for the current operation. |
TracingSpan |
Represents an implementation agnostic tracing span. |
TracingSpanLink |
A pointer from the current TracingSpan to another span in the same or a different trace. |
TracingSpanOptions |
Options used to configure the newly created span. |
Type Aliases
OptionsWithTracingContext |
A utility type for when we know a TracingContext has been set as part of an operation's options. |
Resolved |
A narrower version of TypeScript 4.5's Awaited type which Recursively
unwraps the "awaited type", emulating the behavior of |
SpanStatus |
Represents the statuses that can be passed to setStatus. By default, all spans will be created with status "unset". |
SpanStatusError |
Status representing an error that can be sent to setStatus |
SpanStatusSuccess |
Status representing a successful operation that can be sent to setStatus |
TracingSpanKind |
The kind of span. |
Functions
create |
Creates a new tracing client. |
use |
Extends the Azure SDK with support for a given instrumenter implementation. |
Function Details
createTracingClient(TracingClientOptions)
Creates a new tracing client.
function createTracingClient(options: TracingClientOptions): TracingClient
Parameters
- options
- TracingClientOptions
Options used to configure the tracing client.
Returns
- An instance of TracingClient.
useInstrumenter(Instrumenter)
Extends the Azure SDK with support for a given instrumenter implementation.
function useInstrumenter(instrumenter: Instrumenter)
Parameters
- instrumenter
- Instrumenter
The instrumenter implementation to use.