Modules generated by the plugin
Agents
The plugin creates one agent for each entry in --bootstrap_servers.
The agent name and alias use the following format:
<agent_prefix><host:port>
For example, with --agent_prefix KAFKA_ and the kafka1:9092 broker, the generated agent is:
KAFKA_kafka1:9092
Agents are created with a 300-second interval and the Created by plugin description.
Modules
The plugin iterates over all metrics returned by producer.metrics() and consumer.metrics(). Therefore, the exact list may vary depending on the kafka-python version, Kafka version, available nodes, and client activity.
All modules use the generic_data type and have no unit or description. Module names use the following format:
<module_prefix><metric_group>.<metric_name>
Floating-point values that are NaN or infinite are converted to 0.0.
The main generated metric groups are listed below:
| Source | Metric group | Module examples without a prefix | Type |
|---|---|---|---|
| Producer and consumer | kafka-metrics |
kafka-metrics.count |
generic_data |
| Producer | producer-metrics |
producer-metrics.connection-count, producer-metrics.request-rate, producer-metrics.request-latency-avg, producer-metrics.record-send-rate, producer-metrics.record-error-rate |
generic_data |
| Producer | producer-node-metrics.node-<node> |
producer-node-metrics.node-<node>.outgoing-byte-rate, producer-node-metrics.node-<node>.request-rate, producer-node-metrics.node-<node>.response-rate |
generic_data |
| Consumer | consumer-metrics |
consumer-metrics.connection-count, consumer-metrics.request-rate, consumer-metrics.request-latency-avg, consumer-metrics.incoming-byte-rate |
generic_data |
| Consumer | consumer-node-metrics.node-<node> |
consumer-node-metrics.node-<node>.incoming-byte-rate, consumer-node-metrics.node-<node>.request-rate, consumer-node-metrics.node-<node>.response-rate |
generic_data |
| Consumer | consumer-fetch-manager-metrics |
consumer-fetch-manager-metrics.fetch-size-avg, consumer-fetch-manager-metrics.bytes-consumed-rate, consumer-fetch-manager-metrics.records-consumed-rate, consumer-fetch-manager-metrics.records-lag-max |
generic_data |
| Consumer | consumer-coordinator-metrics |
consumer-coordinator-metrics.heartbeat-rate, consumer-coordinator-metrics.join-rate, consumer-coordinator-metrics.commit-rate, consumer-coordinator-metrics.assigned-partitions |
generic_data |
For example, when --module_prefix METRIC_ is used, the producer-metrics.request-rate module is created as:
METRIC_producer-metrics.request-rate