Caution
Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
otelcol.exporter.debug
otelcol.exporter.debug
accepts telemetry data from other otelcol
components and writes them to the console (stderr).
You can control the verbosity of the logs.
Note
otelcol.exporter.debug
is a wrapper over the upstream OpenTelemetry Collectordebug
exporter. If necessary, bug reports or feature requests are redirected to the upstream repository.
Multiple otelcol.exporter.debug
components can be specified by giving them different labels.
Usage
otelcol.exporter.debug "LABEL" { }
Arguments
otelcol.exporter.debug
supports the following arguments:
Name | Type | Description | Default | Required |
---|---|---|---|---|
verbosity | string | Verbosity of the generated logs. | "normal" | no |
sampling_initial | int | Number of messages initially logged each second. | 2 | no |
sampling_thereafter | int | Sampling rate after the initial messages are logged. | 500 | no |
The verbosity
argument must be one of "basic"
, "normal"
, or "detailed"
.
Exported fields
The following fields are exported and can be referenced by other components:
Name | Type | Description |
---|---|---|
input | otelcol.Consumer | A value that other components can use to send telemetry data to. |
input
accepts otelcol.Consumer
data for any telemetry signal (metrics,
logs, or traces).
Component health
otelcol.exporter.debug
is only reported as unhealthy if given an invalid
configuration.
Debug information
otelcol.exporter.debug
does not expose any component-specific debug
information.
Example
This example scrapes Prometheus UNIX metrics and writes them to the console:
prometheus.exporter.unix "default" { }
prometheus.scrape "default" {
targets = prometheus.exporter.unix.default.targets
forward_to = [otelcol.receiver.prometheus.default.receiver]
}
otelcol.receiver.prometheus "default" {
output {
metrics = [otelcol.exporter.debug.default.input]
}
}
otelcol.exporter.debug "default" {
verbosity = "detailed"
sampling_initial = 1
sampling_thereafter = 1
}
Compatible components
otelcol.exporter.debug
has exports that can be consumed by the following components:
- Components that consume OpenTelemetry
otelcol.Consumer
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.