MicrosoftOpenTelemetryOptions interface

Package:

@microsoft/opentelemetry

Microsoft OpenTelemetry Options

Top-level configuration for the Microsoft OpenTelemetry distribution. Global options (resource, sampling, instrumentations, processors) live here. Backend-specific options are scoped under their respective keys.

Properties

a365	A365 observability configuration. When provided with enabled: true, A365 export is enabled.
azureMonitor	Azure Monitor configuration. When provided, Azure Monitor export is enabled.
enableConsoleExporters	Enable console exporters for traces, metrics, and logs. Auto-enabled when no other exporter is active.
instrumentationOptions	OpenTelemetry Instrumentations configuration
logRecordProcessors	An array of log record processors to register to the logger provider.
metricReaders	An array of metric readers to register to the meter provider.
resource	OpenTelemetry Resource
samplingRatio	The rate of telemetry items tracked that should be transmitted (Default 1.0)
spanProcessors	An array of span processors to register to the tracer provider.
tracesPerSecond	The maximum number of traces to sample per second (Default 5). Set to 0 to use samplingRatio instead.
views	An array of metric views to register to the meter provider.

Property Details

a365

A365 observability configuration. When provided with enabled: true, A365 export is enabled.

a365?: A365Options

Property Value

A365Options

azureMonitor

Azure Monitor configuration. When provided, Azure Monitor export is enabled.

azureMonitor?: AzureMonitorOpenTelemetryOptions

Property Value

AzureMonitorOpenTelemetryOptions

enableConsoleExporters

Enable console exporters for traces, metrics, and logs. Auto-enabled when no other exporter is active.

enableConsoleExporters?: boolean

Property Value

boolean

instrumentationOptions

OpenTelemetry Instrumentations configuration

instrumentationOptions?: InstrumentationOptions

Property Value

InstrumentationOptions

logRecordProcessors

An array of log record processors to register to the logger provider.

logRecordProcessors?: LogRecordProcessor[]

Property Value

LogRecordProcessor[]

metricReaders

An array of metric readers to register to the meter provider.

metricReaders?: MetricReader[]

Property Value

MetricReader[]

resource

OpenTelemetry Resource

resource?: Resource

Property Value

Resource

samplingRatio

The rate of telemetry items tracked that should be transmitted (Default 1.0)

samplingRatio?: number

Property Value

number

spanProcessors

An array of span processors to register to the tracer provider.

spanProcessors?: SpanProcessor[]

Property Value

SpanProcessor[]

tracesPerSecond

The maximum number of traces to sample per second (Default 5). Set to 0 to use samplingRatio instead.

tracesPerSecond?: number

Property Value

number

views

An array of metric views to register to the meter provider.

views?: ViewOptions[]

Property Value

ViewOptions[]