Documentation Grafana Cloud Instrument and send data Grafana Alloy Reference Components prometheus prometheus.exporter.kafka

prometheus.exporter.kafka

The prometheus.exporter.kafka component embeds the kafka_exporter to collect metrics from a Kafka server.

You can specify multiple prometheus.exporter.kafka components by giving them different labels.

Usage

Alloy Copy

prometheus.exporter.kafka "<LABEL>" {
  kafka_uris = ["<KAFKA_URI>"]
}

Arguments

You can use the following arguments with prometheus.exporter.kafka:

When allow_concurrency is true, every scrape triggers its own Kafka operations. When it’s false, concurrent scrapes share a single set of results.

When insecure_skip_verify is true, the component doesn’t check the server’s certificate for validity. This makes your TLS connections insecure.

The component verifies the hostname on returned certificates unless you enable insecure_skip_verify. If you don’t set tls_server_name, the component uses the host from the corresponding kafka_uris entry.

When you enable use_sasl, you must also set sasl_username and sasl_password. When you enable use_zookeeper_lag, you must also set zookeeper_uris.

When kafka_uris contains one address, the component sets the instance label on its exported targets to that address. When kafka_uris contains more than one address, you must set instance, and the component uses that value as the label.

Blocks

The prometheus.exporter.kafka component doesn’t support any blocks. You can configure this component with arguments.

Exported fields

Component health

prometheus.exporter.kafka is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.kafka doesn’t expose any component-specific debug information.

Debug metrics

prometheus.exporter.kafka doesn’t expose any component-specific debug metrics.

Example

This example uses a prometheus.scrape component to collect metrics from prometheus.exporter.kafka:

Alloy Copy

prometheus.exporter.kafka "example" {
  kafka_uris = ["localhost:9092"]
}

// Configure a prometheus.scrape component to collect Kafka metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.kafka.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}

Replace the following:

• <PROMETHEUS_REMOTE_WRITE_URL>: The URL of the Prometheus remote_write compatible server to send metrics to.
• <USERNAME>: The username to use for authentication to the remote_write API.
• <PASSWORD>: The password to use for authentication to the remote_write API.

Compatible components

prometheus.exporter.kafka has exports that can be consumed by the following components:

• Components that consume Targets