For the complete documentation index, see llms.txt. This page is also available as Markdown.

Logz.io

The Logz.io destination sends logs, metrics, and traces to Logz.io, an observability platform built on the ELK Stack, Prometheus, and Jaeger. Each signal type uses a separate Logz.io account token. Logs and traces are sent with the Logz.io exporter, and metrics are written using Prometheus remote write to the Logz.io metrics listener.

Supported Telemetry Types

Platform
Metrics
Logs
Traces

Linux

✓

✓

✓

Windows

✓

✓

✓

macOS

✓

✓

✓

Kubernetes Node

✓

✓

✓

Kubernetes Cluster

✓

✓

✓

Kubernetes Gateway

✓

✓

✓

OpenShift Node

✓

✓

✓

OpenShift Cluster

✓

✓

✓

OpenShift Gateway

✓

✓

✓

Prerequisites

  • A Logz.io account.

  • A shipping (account) token for each telemetry type you intend to send. Logs, metrics, and traces each use a separate token, found under your Logz.io account settings. See Logz.io: Find your account token.

  • Your Logz.io account region code (for example us, eu, uk). This must match the region your Logz.io account was created in.

  • For metrics, the listener URL for your region. The default is the US listener; other regions use a region-specific host. See Logz.io: Account region.

Configuration

Bindplane docs - Logz.io - image 1

General

Parameter
Type
Default
Description

Choose Telemetry Type

Telemetry Selector

["Logs", "Metrics", "Traces"]

The telemetry types sent to Logz.io. Any combination of Logs, Metrics, and Traces. The relevant token fields below appear based on this selection.

Region

Enum

us

Required. Your Logz.io account region code. One of us, eu, uk, nl, wa, ca, au.

Timeout

Integer

30

Required. Time, in seconds, to wait per individual attempt to send data to the backend.

Logs

Shown when telemetry_types includes Logs.

Parameter
Type
Default
Description

Logs Token

String

Required. Your Logz.io account (shipping) token for your logs account. Sensitive value.

Metrics

Shown when telemetry_types includes Metrics.

Parameter
Type
Default
Description

Metrics Token

String

Required. Your Logz.io account (shipping) token for your metrics account. Sensitive value.

Listener URL

String

https://listener.logz.io:8053

Required. The URL of the Logz.io metrics listener for your region.

Traces

Shown when telemetry_types includes Traces.

Parameter
Type
Default
Description

Tracing Token

String

Required. Your Logz.io account (shipping) token for your tracing account. Sensitive value.

Advanced

Parameter
Type
Default
Description

Compression

Enum

gzip

Compression algorithm used when sending data to Logz.io. One of none, gzip.

Drop Raw Copy

Boolean

true

When enabled, the raw copy of the log stored in log.record.original is dropped. Applies to logs.

Write Ahead Log (Metrics)

The Write Ahead Log buffers metrics to disk. It is the metrics equivalent of the persistent queue, which does not apply to metrics.

Parameter
Type
Default
Description

Write Ahead Log

Boolean

false

Whether to enable a Write Ahead Log for exporting metrics.

Storage Directory

String

${OIQ_OTEL_COLLECTOR_HOME}/storage/logzio_metrics_wal

Required when the WAL is enabled. Path of the directory the WAL is stored in. Must be unique to this destination.

Buffer Size

Integer

300

Number of objects to store in the Write Ahead Log before truncating.

Truncate Frequency

Integer

60

How often, in seconds, the Write Ahead Log should be truncated.

Retry and Queuing (Advanced)

This destination supports retry on failure, the sending queue, and the persistent queue. The sending queue and persistent queue apply to logs and traces only. To buffer metrics to disk, enable the Write Ahead Log above.

Parameter
Type
Default
Description

Enable Retry on Failure

Boolean

true

Attempt to resend telemetry data that failed to transmit to the destination.

Initial interval

Integer

5

Time, in seconds, to wait after the first failure before retrying.

Max interval

Integer

30

The upper bound, in seconds, on backoff.

Max elapsed time

Integer

300

The maximum amount of time, in seconds, spent trying to send a batch before giving up.

Enable Sending Queue

Boolean

true

Buffer telemetry data temporarily before sending to avoid data loss during a temporary network outage.

Number of Consumers

Integer

10

Number of consumers that dequeue batches.

Queue Size

Integer

5000

Maximum number of batches kept in memory before dropping.

Enable Persistent Queuing

Boolean

true

Buffer telemetry data to disk before sending to avoid data loss during network outages or collector restarts. Does not apply to metrics; use the Write Ahead Log instead.

Persistent Queue Storage

Extension

file_storage_persistent_queue

The storage to use for the persistent queue.

Example Configuration

Standalone Destination

Configuration Tips

Region and listener URL

  • Set region to the code matching the region your Logz.io account was created in. A region mismatch causes the platform to reject data even when the token is valid.

  • When sending metrics, set listener_url to your region's metrics listener. The default targets the US region; EU, UK, and other regions use a region-specific host. See Logz.io: Account region.

Per-signal tokens

  • Logs, metrics, and traces each require a separate shipping token. Selecting a telemetry type without supplying its token causes that signal to fail.

Write Ahead Log for metrics

  • The sending queue and persistent queue protect logs and traces only. To avoid losing metrics during a network outage or collector restart, enable enable_write_ahead_log.

  • Set wal_storage_path to a directory unique to this destination. Sharing a WAL directory across destinations corrupts the buffer.

Troubleshooting

Symptom: Telemetry is rejected even though the token looks correct. Solution: Confirm region matches the region your Logz.io account was created in. A token issued for one region is not valid in another. Verify the metrics listener_url also points at the correct region.

Symptom: One signal type fails while the others succeed. Solution: Each telemetry type uses its own token. Verify that logs_token, metrics_token, and tracing_token are each set for the signals selected in telemetry_types, and that each token belongs to the matching Logz.io account.

Symptom: Metrics are lost during a network outage or collector restart. Solution: The persistent queue does not buffer metrics. Enable the Write Ahead Log (enable_write_ahead_log) and set a unique wal_storage_path so metrics are buffered to disk.

Last updated

Was this helpful?