Function createDistributedTraceContext

  • createDistributedTraceContext(parent?): IDistributedTraceContext

  • Creates an IDistributedTraceContext instance that ensures a valid traceId is always available. The traceId will be inherited from the parent context if valid, otherwise a new random W3C trace ID is generated.

    Parameters

    • Optionalparent: IDistributedTraceInit | IDistributedTraceContext | IOTelSpanContext

      An optional parent IDistributedTraceContext or IOTelSpanContext to inherit trace context values from. If provided, the traceId and spanId will be copied from the parent if they are valid. When the parent is an IDistributedTraceContext, it will be set as the parentCtx property to maintain hierarchical relationships and enable parent context updates. When the parent is an IOTelSpanContext, the parentCtx will be null because OpenTelemetry span contexts are read-only data sources that don't support the same hierarchical management methods as IDistributedTraceContext. The core instance will create a wrapped IDistributedTraceContext instance from the IOTelSpanContext data to enable Application Insights distributed tracing functionality while maintaining OpenTelemetry compatibility.

    Returns IDistributedTraceContext

    A new IDistributedTraceContext instance with the following behavior:

    • traceId: Always present - either inherited from parent (if valid) or newly generated W3C trace ID
    • spanId: Inherited from parent if valid, otherwise empty string
    • traceFlags: Inherited from parent if available, otherwise undefined
    • pageName: Inherited from parent context or derived from current location, defaults to "unknown"
    • traceState: Lazily created W3C trace state, inheriting from parent if available

    Remarks

    This function ensures consistent distributed tracing by guaranteeing that every context has a valid traceId, which is essential for the refactored W3C trace state implementation. The spanId may be empty until a specific span is created, which is normal behavior for trace contexts.

    The distinction between IDistributedTraceContext and IOTelSpanContext parents is important:

    • IDistributedTraceContext parents enable bidirectional updates and hierarchical management
    • IOTelSpanContext parents are used only for initial data extraction and OpenTelemetry compatibility

Settings

Member Visibility