Class ContextTraceEnricher
- Namespace
- Excalibur.Dispatch.Observability.Context
- Assembly
- Excalibur.Dispatch.Observability.dll
OpenTelemetry integration component that adds context fields as span attributes, creates spans for context operations, links related traces via correlation IDs, and propagates baggage items across service boundaries.
public sealed class ContextTraceEnricher : IContextTraceEnricher, IDisposable
- Inheritance
-
ContextTraceEnricher
- Implements
- Inherited Members
- Extension Methods
Remarks
Initializes a new instance of the ContextTraceEnricher class.
Constructors
ContextTraceEnricher(ILogger<ContextTraceEnricher>, IOptions<ContextObservabilityOptions>, ITelemetrySanitizer)
OpenTelemetry integration component that adds context fields as span attributes, creates spans for context operations, links related traces via correlation IDs, and propagates baggage items across service boundaries.
public ContextTraceEnricher(ILogger<ContextTraceEnricher> logger, IOptions<ContextObservabilityOptions> options, ITelemetrySanitizer sanitizer)
Parameters
loggerILogger<ContextTraceEnricher>Logger for diagnostic output.
optionsIOptions<ContextObservabilityOptions>Configuration options.
sanitizerITelemetrySanitizerThe telemetry sanitizer for PII protection.
Remarks
Initializes a new instance of the ContextTraceEnricher class.
Methods
AddContextEvent(string, IMessageContext, IReadOnlyDictionary<string, object>?)
Adds a context event to the current span.
public void AddContextEvent(string eventName, IMessageContext context, IReadOnlyDictionary<string, object>? attributes = null)
Parameters
eventNamestringName of the event.
contextIMessageContextThe message context.
attributesIReadOnlyDictionary<string, object>Additional attributes for the event.
CreateContextOperationSpan(string, IMessageContext, ActivityKind)
Creates a span for a context operation.
[RequiresUnreferencedCode("Calls System.Text.Json.JsonSerializer.Serialize<TValue>(TValue, JsonSerializerOptions)")]
[RequiresDynamicCode("Calls System.Text.Json.JsonSerializer.Serialize<TValue>(TValue, JsonSerializerOptions)")]
public Activity? CreateContextOperationSpan(string operationName, IMessageContext context, ActivityKind kind = ActivityKind.Internal)
Parameters
operationNamestringName of the operation.
contextIMessageContextThe message context.
kindActivityKindThe activity kind.
Returns
- Activity
The created activity/span.
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()
EnrichActivity(Activity?, IMessageContext)
Enriches an activity with context information.
[RequiresUnreferencedCode("Calls System.Text.Json.JsonSerializer.Serialize<TValue>(TValue, JsonSerializerOptions)")]
[RequiresDynamicCode("Calls System.Text.Json.JsonSerializer.Serialize<TValue>(TValue, JsonSerializerOptions)")]
public void EnrichActivity(Activity? activity, IMessageContext context)
Parameters
activityActivityThe activity to enrich.
contextIMessageContextThe message context containing data to add.
ExtractContextFromBaggage(IDictionary<string, string>, IMessageContext)
Extracts context from baggage in incoming requests.
public void ExtractContextFromBaggage(IDictionary<string, string> carrier, IMessageContext context)
Parameters
carrierIDictionary<string, string>The carrier dictionary containing baggage.
contextIMessageContextThe message context to populate.
LinkRelatedTrace(Activity?, string, string)
Links related traces using correlation IDs.
public void LinkRelatedTrace(Activity? activity, string correlationId, string linkType = "correlation")
Parameters
activityActivityThe current activity.
correlationIdstringThe correlation ID to link.
linkTypestringType of link relationship.
PropagateContextAsBaggage(IMessageContext, IDictionary<string, string>)
Propagates context as baggage for cross-service communication.
public void PropagateContextAsBaggage(IMessageContext context, IDictionary<string, string> carrier)
Parameters
contextIMessageContextThe message context to propagate.
carrierIDictionary<string, string>The carrier dictionary for propagation.