Skip to content

OpenTelemetry

Export events using the OpenTelemetry OTLP protocol.

Observability Enterprise edition json

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

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Attributes
Field Type Required Description
resource-attributes ✓ map (string) Static resource attributes to attach to exported signals.
Batching
Field Type Required Description
batch Batch Logical batching hints shared with other outputs.
Connection
Field Type Required Description
connection Connection ✅ gRPC client connection settings.
Diagnostics
Field Type Required Description
exporter-tracing ✓ boolean (bool) Emit exporter-internal spans/logs to aid debugging collector connectivity. Only enable during troubleshooting; defaults to false.
Default: false
Reliability
Field Type Required Description
retry Retry Retry policy applied to exporter failures.
Signals
Field Type Required Description
signals Signals[] Signals to render from events (default: logs, traces).
Allowed values: logs, traces, metrics
Option Name Type Description
basic Basic object
bearer Bearer object
Field Type Required Description
fixed-size ✓ number (integer) maximum number of events in an output batch.
Examples: 42, 1.2e-10
max-bytes ✓ number (integer) Close the batch before adding an event that would make the serialized request payload exceed this many bytes.
Examples: 42, 1.2e-10
mode Mode ✅ If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
Allowed values: fixed, document
timeout time-interval (string) ✅ interval after which the batch is sent, to keep throughput going (default 100ms).
Default: 100ms
Examples: 500ms, 2h
header multiline-text (string) put a header line before the batch.
footer multiline-text (string) put a header line after the last line of the batch.
use-document-marker ✓ boolean (bool) Enrich the job metadata with a document marker (for document handling in batch mode).
Default: false
wrap-as-json ✓ boolean (bool) Format the output batch as a JSON array.
Default: false
Field Type Required Description
username ✓ string ✅
password ✓ string ✅
Field Type Required Description
token ✓ string ✅
header-name string Optional custom header name, defaults to authorization.
scheme string Optional scheme override, defaults to Bearer.
Field Type Required Description
ca-certificate ✓ path (string) Examples: /path/to/file, c:\users\joe\data\file.txt
domain ✓ string
client-certificate ✓ path (string) Examples: /path/to/file, c:\users\joe\data\file.txt
client-key ✓ path (string) Examples: /path/to/file, c:\users\joe\data\file.txt
insecure-skip-verify ✓ boolean (bool) Default: false
Field Type Required Description
endpoint ✓ url (string) ✅ Examples: https://example.com/path
timeout string Timeout for export requests (e.g., 30s).
headers ✓ map (string)
auth Auth Allowed values: basic, bearer
tls Tls
Field Type Required Description
strategy Strategy Backoff strategy to use (default exponential).
Allowed values: exponential, linear, fixed
base string Base delay before retrying (e.g. “200ms”).
max string Maximum delay between retries.
jitter ✓ boolean (bool) Whether to add jitter to retry delays.
Default: false
Field Type Required Description
max-attempts number (integer) Maximum attempts before giving up.
Examples: 42, 1.2e-10
forever ✓ boolean (bool) Retry indefinitely until cancelled.
Default: false
backoff Backoff Backoff strategy configuration.
Attribute Value
service.name value

Value format: templated-text.

Header Value
Header-Name value

Value format: templated-text.

Value Aliases Name Description
fixed fixed
document document
Value Aliases Name Description
exponential exponential
linear linear
fixed fixed
Value Aliases Name Description
logs logs
traces traces
metrics metrics