OpenTelemetry (open-telemetry)
Export events using the OpenTelemetry OTLP protocol.
Observability json
Minimal example
JSON
Contents
Attributes
Attributes
| Field | Type | Required | Description |
|---|
resource-attributes ✓ | map (string) | | Static resource attributes to attach to exported signals. |
Batching
Batching
| Field | Type | Required | Description |
|---|
batch | Batch | | Logical batching hints shared with other outputs. |
Connection
Connection
| Field | Type | Required | Description |
|---|
connection | Connection | ✅ | gRPC client connection settings. |
Diagnostics
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
Reliability
| Field | Type | Required | Description |
|---|
retry | Retry | | Retry policy applied to exporter failures. |
Signals
Signals
| Field | Type | Required | Description |
|---|
signals | Signals[] | | Signals to render from events (default: logs, traces). Allowed values: logs, traces, metrics |
Schema
Connection - Auth Options
Batch Fields
| Field | Type | Required | Description |
|---|
fixed-size ✓ | number (integer) | | maximum number of events in an output batch. 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 |
Connection - Auth - Basic Fields
| Field | Type | Required | Description |
|---|
username ✓ | string | ✅ | |
password ✓ | string | ✅ | |
Connection - Auth - Bearer Fields
| Field | Type | Required | Description |
|---|
token ✓ | string | ✅ | |
header-name | string | | Optional custom header name, defaults to authorization. |
scheme | string | | Optional scheme override, defaults to Bearer. |
Connection - OTel Client TLS Fields
| 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 |
Connection Fields
| 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 | OTel Client TLS | | |
Retry Fields
| Field | Type | Required | Description |
|---|
timeout | time-interval (string) | ✅ | timeout (e.g. 500ms, 2s etc. - default is 30). Examples: 500ms, 2h |
retries | number (integer) | | number of retries. Examples: 42, 1.2e-10 |
Resource Attributes Table
| Attribute | Value |
|---|
service.name | value |
Value format: templated-text.
| Header | Value |
|---|
Header-Name | value |
Value format: templated-text.
Batch - Mode Options
| Value | Name | Description |
|---|
fixed | fixed | Fixed |
document | document | Document |
Signals Options
| Value | Name | Description |
|---|
logs | logs | Logs |
traces | traces | Traces |
metrics | metrics | Metrics |