Class OpenTelemetryExtensions

Namespace

Microsoft.Extensions.Hosting

Assembly

Stratara.ServiceDefaults.dll

OpenTelemetry wiring used by every Stratara host. Configures logging + metrics + tracing with HTTP, EF Core, RabbitMQ, and runtime instrumentation, and registers an OTLP exporter automatically when the OTEL_EXPORTER_OTLP_ENDPOINT configuration value is non-empty.

public static class OpenTelemetryExtensions

Inheritance

object

OpenTelemetryExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

When the OTLP exporter is enabled, the export timeout (OTEL_EXPORTER_OTLP_TIMEOUT) defaults to 5000 ms instead of the OTel spec default of 10 000 ms to keep host shutdown / metric flush reactive when the collector is unreachable. Consumers can override either default via the same environment variable or configuration key.

HTTP-client instrumentation registers an enrichment callback that overwrites any http.request.header.authorization / http.request.header.cookie / http.request.header.proxy-authorization / http.response.header.set-cookie tags with "REDACTED", in the dashed form the semantic conventions name them and in the underscore form older capture code wrote. This defends against bearer tokens or session cookies leaking into trace exporters when a consumer opts into header capture (via OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS or the SDK's own options). The default OTel behaviour without that opt-in is already to omit headers, so for most consumers this is a belt-and-braces safeguard.

Methods

ConfigureOpenTelemetry<TBuilder>(TBuilder, Action<MeterProviderBuilder>?, Action<TracerProviderBuilder>?)

Configures OpenTelemetry logging + metrics + tracing on the given host builder. Adds default instrumentation (HTTP client, EF Core, RabbitMQ, runtime) and wires the OTLP exporter when OTEL_EXPORTER_OTLP_ENDPOINT is set.

public static TBuilder ConfigureOpenTelemetry<TBuilder>(this TBuilder builder, Action<MeterProviderBuilder>? configureMetrics = null, Action<TracerProviderBuilder>? configureTracing = null) where TBuilder : IHostApplicationBuilder

Parameters

builder TBuilder

The host application builder.

configureMetrics Action<MeterProviderBuilder>

Optional callback to extend the metrics pipeline with host-specific meters/exporters.

configureTracing Action<TracerProviderBuilder>

Optional callback to extend the tracing pipeline with host-specific sources/exporters.

Returns

TBuilder

The same builder for chaining.

Type Parameters

TBuilder

The host-builder type.

Examples

Exports over OTLP when OTEL_EXPORTER_OTLP_ENDPOINT is set, and stays local when it is not:

builder.ConfigureOpenTelemetry();