Skip to content

OpenTelemetry

OpenTelemetry (open-telemetry)

Export events using the OpenTelemetry OTLP protocol.

Observability json

Minimal example

output:
open-telemetry:
connection:
endpoint: ""
JSON
{
"output": {
"open-telemetry": {
"connection": {
"endpoint": ""
}
}
}
}

Contents

Fields

FieldTypeRequiredDescription
connection ConnectionConnectiongRPC client connection settings.
retry ReliabilityRetryRetry policy applied to exporter failures.
batch BatchingBatchLogical batching hints shared with other outputs.
signals SignalsSignals[]Signals to render from events (default: logs, traces).
Allowed values: logs, traces, metrics
resource-attributes Attributesmap (string)Static resource attributes to attach to exported signals.
exporter-tracing Diagnosticsboolean (bool)Emit exporter-internal spans/logs to aid debugging collector connectivity. Only enable during troubleshooting; defaults to false.

Reliability

Show fields
FieldTypeRequiredDescription
retryRetryRetry policy applied to exporter failures.

Batching

Show fields
FieldTypeRequiredDescription
batchBatchLogical batching hints shared with other outputs.

Connection

Show fields
FieldTypeRequiredDescription
connectionConnectiongRPC client connection settings.

Signals

Show fields
FieldTypeRequiredDescription
signalsSignals[]Signals to render from events (default: logs, traces).
Allowed values: logs, traces, metrics

Attributes

Show fields
FieldTypeRequiredDescription
resource-attributesmap (string)Static resource attributes to attach to exported signals.

Diagnostics

Show fields
FieldTypeRequiredDescription
exporter-tracingboolean (bool)Emit exporter-internal spans/logs to aid debugging collector connectivity. Only enable during troubleshooting; defaults to false.

Schema

Connection - Auth Options

OptionNameTypeDescription
basicBasicobject
bearerBearerobject

Retry Fields

FieldTypeRequiredDescription
timeouttime-interval (string)timeout (e.g. 500ms, 2s etc. - default is 30).
Examples: 500ms, 2h
retriesnumber (integer)number of retries.
Examples: 42, 1.2e-10

Batch Fields

FieldTypeRequiredDescription
fixed-sizenumber (integer)maximum number of events in an output batch.
Examples: 42, 1.2e-10
modeModeIf ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
Allowed values: fixed, document
timeouttime-interval (string)interval after which the batch is sent, to keep throughput going (default 100ms).
Examples: 500ms, 2h
headermultiline-text (string)put a header line before the batch.
footermultiline-text (string)put a header line after the last line of the batch.
use-document-markerboolean (bool)Enrich the job metadata with a document marker (for document handling in batch mode).
wrap-as-jsonboolean (bool)Format the output batch as a JSON array.

Connection - Auth - Basic Fields

FieldTypeRequiredDescription
usernamestring
passwordstring

Connection - Auth - Bearer Fields

FieldTypeRequiredDescription
tokenstring
header-namestringOptional custom header name, defaults to authorization.
schemestringOptional scheme override, defaults to Bearer.

Connection - Tls Fields

FieldTypeRequiredDescription
ca-certificatepath (string)Examples: /path/to/file, c:\users\joe\data\file.txt
domainstring
client-certificatepath (string)Examples: /path/to/file, c:\users\joe\data\file.txt
client-keypath (string)Examples: /path/to/file, c:\users\joe\data\file.txt
insecure-skip-verifyboolean (bool)

Connection Fields

FieldTypeRequiredDescription
endpointurl (string)Examples: https://example.com/path
timeoutstringTimeout for export requests (e.g., 30s).
headersmap (string)
authAuth
tlsTls

Connection - Headers Table

HeaderValue
Header-Namevalue

Value format: templated-text.

Resource Attributes Table

AttributeValue
service.namevalue

Value format: templated-text.

Batch - Mode Options

ValueDescription
fixedFixed
documentDocument

Signals Options

ValueDescription
logsLogs
tracesTraces
metricsMetrics