Interface ITraceHost<CfgType>

Readonlyconfig

getActiveSpan

• getActiveSpan(createNew?): IReadableSpan

• Return the current active span, if no trace provider is available null will be returned but when a trace provider is available a span instance will always be returned, even if there is no active span (in which case a non-recording span will be returned).

  Parameters

  • OptionalcreateNew: boolean

    Optional flag to create a non-recording span if no active span exists, defaults to true. When false, returns the existing active span or null without creating a non-recording span, which can improve performance when only checking if an active span exists.

  Returns IReadableSpan

  The current active span or null if no trace provider is available or if createNew is false and no active span exists

  Since

  3.4.0

getTraceCtx

• getTraceCtx(createNew?): IDistributedTraceContext

• Gets the current distributed trace active context for this instance

  Parameters

  • OptionalcreateNew: boolean

    Optional flag to create a new instance if one doesn't currently exist, defaults to true. By default this will use any located parent as defined by the IConfiguration.traceHdrMode configuration for each new instance created.

  Returns IDistributedTraceContext

getTraceProvider

• getTraceProvider(): ITraceProvider

• Get the current trace provider.

  Returns ITraceProvider

  The current trace provider, or null if none is set

  Since

  3.4.0

setActiveSpan

• setActiveSpan(span): ISpanScope<ITraceHost<IConfiguration>>

• Set the current Active Span, if no trace provider is available the span will be not be set as the active span.

  Parameters

  • span: IReadableSpan

    The span to set as the active span

  Returns ISpanScope<ITraceHost<IConfiguration>>

  An ISpanScope instance that provides the current scope, the span will always be the span passed in even when no trace provider is available

  Since

  3.4.0

setTraceCtx

• setTraceCtx(newTraceCtx): void

• Sets the current distributed trace context for this instance if available

  Parameters

  • newTraceCtx: IDistributedTraceContext

  Returns void

startSpan

• startSpan(name, options?, parent?): IReadableSpan

• Start a new span with the given name and optional parent context.

  Note: This method only creates and returns the span. It does not automatically set the span as the active trace context. Context management should be handled separately using setTraceCtx() if needed.

  Parameters

  • name: string

    The name of the span
  • Optionaloptions: IOTelSpanOptions

    Options for creating the span (kind, attributes, startTime)
  • Optionalparent: IDistributedTraceContext

    Optional parent context. If not provided, uses the current active trace context

  Returns IReadableSpan

  A new span instance, or null if no trace provider is available

  Since

  3.4.0

  See

  • IReadableSpan - Interface for individual spans
  • IOTelSpanOptions - Configuration options for span creation