TelemetryFilter

Experimental Filter

The TelemetryFilter integrates the OpenTelemetry standard to export observability data to a variety of open source and commercial backends.

Limitation

Most of the configuration options are global settings in the OTEL library, therefore only one TelemetryFilter should be configured per instance. If there are multiple Virtual Hosts, the TelemetryFilters should have the same configurations across the different web.xmls.

Classname

ch::nevis::nevisproxy::filter::telemetry::TelemetryFilter

Library

libNPTelemetryFilters.so.1

TraceGroup

BC.Tracer.DebugProfile.NPTelemetryFlt

Configuration

Trace

Type: Boolean
Usage Constraints: optional
Default: true

Enables or disables the traces feature of OpenTelemetry.

Trace.Exporter.Type

Type: Enum
Usage Constraints: optional
Possible values: OTLP_HTTP
Default: OTLP_HTTP

Configures the protocol used for communicating with the traces endpoint.

Trace.Exporter.Address

Type: String
Usage Constraints: required if traces are enabled
Syntax: <hostname>:<port>

Target URL to which the exporter is going to send spans. The /v1/traces path is automatically attached to it.

Trace.PropagateContext.Extract

Type: Boolean
Usage Constraints: optional
Default: true

If present, extracts the trace context from the HTTP request header and sets it as parent for the current span.

Trace.PropagateContext.Inject

Type: Boolean
Usage Constraints: optional
Default: true

Injects the current context (span ID, trace ID, etc) as a HTTP header to the request.

Trace.Resource.ServiceName

Type: String
Usage Constraints: optional
Default: nevisproxy

Allows the configuration of the service.name key-value pair resource attribute.