Metrics Exposer

Configuring Kafka Exporter

If you are looking for the API documentation, it can be found here

For further information about monitoring within the Axual Platform, check our monitoring section out

In order to use some metrics offered by Metrics Exposer, named io.axual.application/consumer_lag_records and io.axual.application/consumer_time_to_catch_up, kafka_exposer must be enabled.

By default, it is disabled when deploying the cluster, and it can be turned on by setting the core.kafka.kafka.kafkaExporter.enabled property to true. The super users list also need to be updated so kafka_exporter can access the resources in the Kafka cluster regardless of any access restrictions, and is supported by all authorization mechanisms.

To do that, add the user to the core.kafka.kafka.superUsers property. If the user uses TLS client authentication, their username is the common name from their certificate subject prefixed with CN=.

Please note that you MUST keep the current super users you have configured!

An example would look like the below example:

core:
  kafka:
    kafka:
      kafkaExporter:
        enabled: true
      superUsers:
        # keep the current super users you have configured!
        - [existing entries]
        - "[0] Intermediate Certificate used by Cluster, [1] CN=[CLUSTER_NAME]-kafka-exporter,O=io.strimzi"

After updating the configuration, upgrade the Axual platform release using the above modified values.yaml:

helm upgrade --install platform axual-stable/platform -f values.yaml --version=<helm-chart-version> -n kafka

That will start a new pod exporting, among other metrics, the kafka consumer lag (kafka_consumergroup_lag) for your kafka brokers.