...

Client metrics and metric labels

Clients that support this KIP should provide at least a subset of the following metrics, as long as metrics for the client implementation in question, striving to support as many of the standard metrics listed here. Care has been taken to make these standard metrics as generic as possible, and should fit most Kafka client implementations.

Defining a standard metrics set makes monitoring and troubleshooting easier, as the operator can combine the same metric from multiple client types in the same graph, e.g., request latencies, and it also makes setting up metrics subscriptions easier.  Care has been taken to make these standard metrics as generic as possible, and should fit most Kafka client implementations. We try to avoid metrics that are available or derivable from existing broker metrics.

All standard metrics are prefixed with the “org.apache.kafka.” namespace , this prefix is omitted from the following tables for brevity.

Clients that support this KIP should provide at least a subset of the following standard metrics, given that the metrics are relevant to that client implementation.

Client implementations may also provide additional metrics that are specific to that implementation, these custom metrics must reside in their own namespace by prefixing the metric name with their own namespace. The official Apache Kafka java Java clients resides in the official org.apache.kafka namespace of course.

We try to avoid metrics that are available or derivable from existing broker metrics, such as request rates, etc.

All standard metrics are prefixed with the “org.apache.kafka.” namespace , this prefix is omitted from the following tables for brevity.

Private metrics

The default metrics collection on the client must take extra care not to expose any information about the application and system it runs on as they may identify internal projects, infrastructure, etc, that the user may not want to expose to the Kafka infrastructure owner. This includes information such as hostname, operating system, credentials, runtime environment, etc. None of the metrics defined in this proposal expose any such information.

...