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

Attributes

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

Batching

Batching
FieldTypeRequiredDescription
batchBatchLogical batching hints shared with other outputs.

Connection

Connection
FieldTypeRequiredDescription
connectionConnectiongRPC client connection settings.

Diagnostics

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

Reliability

Reliability
FieldTypeRequiredDescription
retryRetryRetry policy applied to exporter failures.

Signals

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

Schema

Connection - Auth Options

OptionNameTypeDescription
basicBasicobject
bearerBearerobject

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).
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).
Default: false
wrap-as-jsonboolean (bool)Format the output batch as a JSON array.
Default: false

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 - OTel Client 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)Default: false

Connection Fields

FieldTypeRequiredDescription
endpointurl (string)Examples: https://example.com/path
timeoutstringTimeout for export requests (e.g., 30s).
headersmap (string)
authAuthAllowed values: basic, bearer
tlsOTel Client TLS

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

Resource Attributes Table

AttributeValue
service.namevalue

Value format: templated-text.

Connection - Headers Table

HeaderValue
Header-Namevalue

Value format: templated-text.

Batch - Mode Options

ValueNameDescription
fixedfixedFixed
documentdocumentDocument

Signals Options

ValueNameDescription
logslogsLogs
tracestracesTraces
metricsmetricsMetrics