<br />

This document describes how to configure your Google Kubernetes Engine deployment
so that you can use Google Cloud Managed Service for Prometheus to collect metrics from

Apache Kafka. This document shows you how to do the following:

- Set up the exporter for Kafka to report metrics.
- Access a predefined dashboard in Cloud Monitoring to view the metrics.
- Configure alerting rules to monitor the metrics.

<br />

These instructions apply only if you are using [managed collection](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt)
with Managed Service for Prometheus.
If you are using self-deployed collection, then see the

[source repository](https://github.com/danielqsj/kafka_exporter)
for the Kafka exporter

for installation information.

These instructions are provided as an example and are expected to work in
most Kubernetes environments.

If you are having trouble installing an
application or exporter due to restrictive security or organizational policies,
then we recommend you consult open-source documentation for support.

For information about Apache Kafka, see [Kafka](https://kafka.apache.org/).

## Prerequisites

To collect metrics from

Kafka

by using
Managed Service for Prometheus and managed collection, your deployment must
meet the following requirements:

- Your cluster must be running Google Kubernetes Engine version 1.28.15-gke.2475000 or later.
- You must be running Managed Service for Prometheus with managed collection enabled. For more information, see [Get started with managed collection](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt).

  <br />

- To use dashboards available in Cloud Monitoring for the Kafka integration, you must use `kafka_exporter` version v1.6.0 or later.

  For more information about available dashboards, see

  [View dashboards](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/exporters/kafka.md.txt#monitoring-dashboard).

<br />

## Install the Kafka exporter

We recommend that you install the Kafka exporter,
[`kafka_exporter`](https://github.com/danielqsj/kafka_exporter), by using the following config:

```yaml
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: kafka-exporter
  labels:
    app.kubernetes.io/name: kafka-exporter
spec:
  replicas: 1
  selector:
    matchLabels:
      app.kubernetes.io/name: kafka-exporter
  template:
    metadata:
      labels:
        app.kubernetes.io/name: kafka-exporter
    spec:
      containers:
      - name: exporter
        image: danielqsj/kafka-exporter:v1.6.0
        args:
        - --kafka.server=kafka:9092
        ports:
        - containerPort: 9308
          name: prometheus
```
The Kafka exporter is configurable with [flags](https://github.com/danielqsj/kafka_exporter#flags), which can be set as container args. This example assumes Kafka is available as a ClusterIP service named `kafka` on port `9092`.

To apply configuration changes from a local file, run the following command:

```
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
```

<br />

You can also
[use Terraform](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt#terraform-scrape)
to manage your configurations.

## Define a PodMonitoring resource

For target discovery, the Managed Service for Prometheus Operator
requires a PodMonitoring resource that corresponds to
the Kafka exporter in the same namespace.

You can use the following PodMonitoring configuration:

```yaml
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: kafka-exporter
  labels:
    app.kubernetes.io/name: kafka-exporter
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: kafka-exporter
```

To apply configuration changes from a local file, run the following command:

```
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
```

<br />

You can also
[use Terraform](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt#terraform-scrape)
to manage your configurations.

## Define rules and alerts

You can use the following `Rules` configuration to define
alerts on your Kafka metrics:

```yaml
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: kafka-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: kafka-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: kafka
    interval: 30s
    rules:
    - alert: KafkaChangeInNumberOfISRs
      annotations:
        description: |-
          Kafka change in number of isrs
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Kafka change in number of isrs (instance {{ $labels.instance }})
      expr: kafka_topic_partition_in_sync_replica != 10
      for: 5m
      labels:
        severity: critical
    - alert: KafkaUnderReplicatedPartitions
      annotations:
        description: |-
          Kafka under replicated partitions
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Kafka under replicated partitions (instance {{ $labels.instance }})
      expr: kafka_topic_partition_under_replicated_partition > 0
      for: 1m
      labels:
        severity: warning
```

To apply configuration changes from a local file, run the following command:

```
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
```

<br />

You can also
[use Terraform](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt#terraform-scrape)
to manage your configurations.

For more information about applying rules to your cluster, see
[Managed rule evaluation and alerting](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/rules-managed.md.txt).
You can adjust the alert thresholds to suit your application.

## Verify the configuration

You can use Metrics Explorer to verify that you correctly configured
the Kafka exporter. It might take one or two minutes for
Cloud Monitoring to ingest your metrics.

To verify the metrics are ingested, do the following:

1. In the Google Cloud console, go to the
   **Metrics explorer** page:

   [Go to **Metrics explorer**](https://console.cloud.google.com/monitoring/metrics-explorer)

   <br />

   If you use the search bar to find this page, then select the result whose subheading is
   **Monitoring**.
2. In the toolbar of the query-builder pane, select the button whose name is **PromQL**.
3. Enter and run the following query:  

   ```
   up{job="kafka-exporter", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}
   ```

<br />

## View dashboards

The Cloud Monitoring integration includes

the **Kafka Prometheus Overview** dashboard.

Dashboards are automatically installed when you configure the integration.
You can also view static previews of dashboards without installing the
integration.


To view an installed dashboard, do the following:

1. In the Google Cloud console, go to the **Dashboards** page:

   [Go to **Dashboards**](https://console.cloud.google.com/monitoring/dashboards)

   <br />

   If you use the search bar to find this page, then select the result whose subheading is
   **Monitoring**.
2. Select the **Dashboard List** tab.
3. Choose the **Integrations** category.
4. Click the name of the dashboard, for example, **Kafka Prometheus Overview**.

<br />

To view a static preview of the dashboard, do the following:

1. In the Google Cloud console, go to the
   ![](https://docs.cloud.google.com/static/monitoring/images/integrations-icon.png) **Integrations**
   page:

   [Go to **Integrations**](https://console.cloud.google.com/monitoring/integrations)

   <br />

   If you use the search bar to find this page, then select the result whose subheading is
   **Monitoring**.
2. Click the **Kubernetes Engine** deployment-platform filter.
3. Locate the Apache Kafka integration and click **View Details**.
4. Select the **Dashboards** tab.

<br />

## Troubleshooting

For information about troubleshooting metric ingestion problems, see
[Problems with collection from exporters](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting.md.txt#exporter-problems) in [Troubleshooting ingestion-side problems](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting.md.txt#ingest-problems).