Skip to main content

Interface: OtelCollectorExporter

OpenTelemetry Collector options for exporting metrics or traces

Properties​

otel​

otel: object

headers?​

optional headers?: Record<string, string>

Optional set of HTTP request headers to send to Collector (e.g. for authentication)

histogramBucketOverrides?​

optional histogramBucketOverrides?: Record<string, number[]>

Overrides boundary values for histogram metrics.

The key is the metric name and the value is the list of bucket boundaries.

For example:

{
  "request_latency": [1, 5, 10, 25, 50, 100, 250, 500, 1000],
}

The metric name will apply regardless of name prefixing.

See this doc for the exact meaning of boundaries.

http?​

optional http?: boolean

If set to true, the exporter will use OTLP/HTTP instead of OTLP/gRPC.

Default​
false meaning that the exporter will use OTLP/gRPC.

metricsExportInterval?​

optional metricsExportInterval?: Duration

Specify how frequently in metrics should be exported.

Format​

number of milliseconds or ms-formatted string

Default​
1 second

temporality?​

optional temporality?: "cumulative" | "delta"

Determines if the metrics exporter should use cumulative or delta temporality.

See the OpenTelemetry specification for more information.

Default​
'cumulative'

url​

url: string

URL of a gRPC OpenTelemetry collector.

Syntax generally looks like http://server:4317 or grpc://server:4317 for OTLP/gRPC exporters, or http://server:4318/v1/metrics for OTLP/HTTP exporters. Make sure to set the http option to true for OTLP/HTTP endpoints.

Format​

Starts with "grpc://" or "http://" for an unsecured connection (typical), or "grpcs://" or "https://" for a TLS connection.

useSecondsForDurations?​

optional useSecondsForDurations?: boolean

If set to true, the exporter will use seconds for durations instead of milliseconds.

Default​
false