# How to monitor kafka using metricbeat?

**URL:** https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146
**Category:** Beats
**Tags:** metricbeat
**Created:** [January 31, 2024, 5:20am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146 "2024-01-31T05:20:25Z")
**Posts on this page:** 9
**Page:** 1

<div class="post-metadata">

### Author: ![kriti\_dabas](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/kriti_dabas/32/118506_2.png) [@kriti\_dabas](https://discuss.elastic.co/u/kriti_dabas)
#### Post date: [January 31, 2024, 5:20am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/1 "2024-01-31T05:20:25Z")

</div>

I have a cluster of kafka consisting three nodes.  
I want to monitor kafka topic/broker /partitions/data using metricbeat.  
I want the dashboard on kibana.  
I have a setup consisting kafka-logstash-elasticsearch-kibana.  
Is there any feature for this on kafka or metricbeat?

---

<div class="post-metadata">

### Author: ![kriti\_dabas](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/kriti_dabas/32/118506_2.png) [@kriti\_dabas](https://discuss.elastic.co/u/kriti_dabas)
#### Post date: [January 31, 2024, 7:35am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/2 "2024-01-31T07:35:21Z")

</div>

```
                                   metricbeat.yml

```

```auto
###################### Metricbeat Configuration Example #######################

# This file is an example configuration file highlighting only the most common
# options. The metricbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
# https://www.elastic.co/guide/en/beats/metricbeat/index.html

# =========================== Modules configuration ============================

metricbeat.config.modules:
  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: true

  # Period on which files under path should be checked for changes
  #reload.period: 1

# ======================= Elasticsearch template setting =======================

setup.template.settings:
  index.number_of_shards: 1
  index.codec: best_compression
  #_source.enabled: false

# ================================== General ===================================

# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
#name:

# The tags of the shipper are included in their field with each
# transaction published.
#tags: ["service-X", "web-tier"]

# Optional fields that you can specify to add additional information to the
# output.
#fields:
# env: staging

# ================================= Dashboards =================================
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards is disabled by default and can be enabled either by setting the
# options here or by using the `setup` command.
#setup.dashboards.enabled: false

# The URL from where to download the dashboard archive. By default, this URL
# has a value that is computed based on the Beat name and version. For released
# versions, this URL points to the dashboard archive on the artifacts.elastic.co
# website.
#setup.dashboards.url:

# =================================== Kibana ===================================

# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
#setup.kibana:

  # Kibana Host
  # Scheme and port can be left out and will be set to the default (http and 5601)
  # In case you specify and additional path, the scheme is required: http://localhost:5601/path
  # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
  #host: "localhost:5601"

  # Kibana Space ID
  # ID of the Kibana Space into which the dashboards should be loaded. By default,
  # the Default Space will be used.
  #space.id:

# =============================== Elastic Cloud ================================

# These settings simplify using Metricbeat with the Elastic Cloud (https://cloud.elastic.co/).

# The cloud.id setting overwrites the `output.elasticsearch.hosts` and
# `setup.kibana.host` options.
# You can find the `cloud.id` in the Elastic Cloud web UI.
#cloud.id:

# The cloud.auth setting overwrites the `output.elasticsearch.username` and
# `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
#cloud.auth:

# ================================== Outputs ===================================

# Configure what output to use when sending the data collected by the beat.

# ---------------------------- Elasticsearch Output ----------------------------
#output.elasticsearch:
  # Array of hosts to connect to.
  # hosts: ["localhost:9200"]

  # Performance preset - one of "balanced", "throughput", "scale",
  # "latency", or "custom".
  #preset: balanced

  # Protocol - either `http` (default) or `https`.
  #protocol: "https"

  # Authentication credentials - either API key or username/password.
  #api_key: "id:api_key"
  #username: "elastic"
  #password: "changeme"

output.elasticsearch:
  hosts: ["https://3.3.3.3:9200","https://2.2.2.2:9200"]
  ssl.certificate_authorities: ["/etc/elasticsearch/certs/ca/ca.crt"]
  username: "hope"
  password: "change"

# ------------------------------ Logstash Output -------------------------------
#output.logstash:
  # The Logstash hosts
  #hosts: ["localhost:5044"]

  # Optional SSL. By default is off.
  # List of root certificates for HTTPS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"

# ================================= Processors =================================

# Configure processors to enhance or manipulate events generated by the beat.

processors:
  - add_host_metadata: ~
  - add_cloud_metadata: ~
  - add_docker_metadata: ~
  - add_kubernetes_metadata: ~

# ================================== Logging ===================================

# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#logging.level: debug

# At debug level, you can selectively enable logging only for some components.
# To enable all selectors, use ["*"]. Examples of other selectors are "beat",
# "publisher", "service".
#logging.selectors: ["*"]
logging.level: info
logging.selectors: ["*"]
logging.to_files: true
logging.files:
  path: /var/log/metricbeat
  name: metricbeat
  keepfiles: 1
  permissions: 0644

# ============================= X-Pack Monitoring ==============================
# Metricbeat can export internal metrics to a central Elasticsearch monitoring
# cluster. This requires xpack monitoring to be enabled in Elasticsearch. The
# reporting is disabled by default.

# Set to true to enable the monitoring reporter.
#monitoring.enabled: false

# Sets the UUID of the Elasticsearch cluster under which monitoring data for this
# Metricbeat instance will appear in the Stack Monitoring UI. If output.elasticsearch
# is enabled, the UUID is derived from the Elasticsearch cluster referenced by output.elasticsearch.
#monitoring.cluster_uuid:

# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch outputs are accepted here as well.
# Note that the settings should point to your Elasticsearch *monitoring* cluster.
# Any setting that is not set is automatically inherited from the Elasticsearch
# output configuration, so if you have the Elasticsearch output configured such
# that it is pointing to your Elasticsearch monitoring cluster, you can simply
# uncomment the following line.
#monitoring.elasticsearch:

# ============================== Instrumentation ===============================

# Instrumentation support for the metricbeat.
#instrumentation:
    # Set to true to enable instrumentation of metricbeat.
    #enabled: false

    # Environment in which metricbeat is running on (eg: staging, production, etc.)
    #environment: ""

    # APM Server hosts to report instrumentation results to.
    #hosts:
    # - http://localhost:8200

    # API Key for the APM Server(s).
    # If api_key is set then secret_token will be ignored.
    #api_key:

    # Secret token for the APM Server(s).
    #secret_token:

# ================================= Migration ==================================

# This allows to enable 6.7 migration aliases
#migration.6_to_7.enabled: true

```

---

<div class="post-metadata">

### Author: ![kriti\_dabas](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/kriti_dabas/32/118506_2.png) [@kriti\_dabas](https://discuss.elastic.co/u/kriti_dabas)
#### Post date: [January 31, 2024, 7:37am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/3 "2024-01-31T07:37:53Z")

</div>

```
                     enabled the module kafka                          
                /etc/metricbeat/modules.d/kafka.yml

```

```auto
# Module: kafka
# Docs: https://www.elastic.co/guide/en/beats/metricbeat/main/metricbeat-module-kafka.html

# Kafka metrics collected using the Kafka protocol
- module: kafka
  metricsets:
    - partition
    - consumergroup
  period: 10s
  hosts: ["4.4.4.4:9092"]

  #client_id: metricbeat
  #retries: 3
  #backoff: 250ms

  # List of Topics to query metadata for. If empty, all topics will be queried.
  #topics: []

  # Optional SSL. By default is off.
  # List of root certificates for HTTPS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"

  # Client Certificate Passphrase (in case your Client Certificate Key is encrypted)
  #ssl.key_passphrase: "yourKeyPassphrase"

  # SASL authentication
  #username: ""
  #password: ""

  # SASL authentication mechanism used. Can be one of PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512.
  # Defaults to PLAIN when `username` and `password` are configured.
  #sasl.mechanism: ''

# Metrics collected from a Kafka broker using Jolokia
#- module: kafka
# metricsets:
# - broker
# period: 10s
# hosts: ["localhost:8779"]

# Metrics collected from a Java Kafka consumer using Jolokia
#- module: kafka
# metricsets:
# - consumer
# period: 10s
# hosts: ["localhost:8774"]

# Metrics collected from a Java Kafka producer using Jolokia
#- module: kafka
# metricsets:
# - producer
# period: 10s
# hosts: ["localhost:8775"]

```

---

<div class="post-metadata">

### Author: ![yago82](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/yago82/32/97755_2.png) [@yago82](https://discuss.elastic.co/u/yago82)
#### Post date: [January 31, 2024, 9:03am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/4 "2024-01-31T09:03:36Z")

</div>

Hi,

This module periodically fetches metrics from Kafka's brokers, producers, and consumers.

to set it up:

Enable the Kafka module in Metricbeat:

```auto
metricbeat modules enable kafka

```

Configure the module by editing the `modules.d/kafka.yml` file. You need to specify the hosts (your Kafka brokers) and the metricsets you want to collect. For example:

```auto
- module: kafka
  metricsets:
    - partition
    - consumergroup
  period: 10s
  hosts: ["localhost:9092"]

```

Regards

---

<div class="post-metadata">

### Author: ![kriti\_dabas](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/kriti_dabas/32/118506_2.png) [@kriti\_dabas](https://discuss.elastic.co/u/kriti_dabas)
#### Post date: [January 31, 2024, 9:08am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/5 "2024-01-31T09:08:17Z")

</div>

I have done that already.  
have a look at the above configuration of kafka.yml.  
there is nothing shown on kibana ui.

---

<div class="post-metadata">

### Author: ![yago82](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/yago82/32/97755_2.png) [@yago82](https://discuss.elastic.co/u/yago82)
#### Post date: [January 31, 2024, 9:14am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/6 "2024-01-31T09:14:33Z")

</div>

Ok,

so for example you can check the Metricbeat status, and then check the Metricbeat logs.

Regards

---

<div class="post-metadata">

### Author: ![kriti\_dabas](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/kriti_dabas/32/118506_2.png) [@kriti\_dabas](https://discuss.elastic.co/u/kriti_dabas)
#### Post date: [January 31, 2024, 9:36am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/7 "2024-01-31T09:36:19Z")

</div>

```auto
below is the log

```

"metricbeat":{"kafka":{"consumergroup":{"events":60,"success":60},"partition":{"events":252,"success":252}},"system":{"cpu":{"events":3,"success":3},"filesystem":{"events":3,"success":3},"fsstat":{"events":1,"success":1},"load":{"events":3,"success":3},"memory":{"events":3,"success":3},"network":{"events":9,"success":9},"process":{"events":20,"success":20},"process\_summary":{"events":3,"success":3},"socket\_summary":{"events":3,"success":3}}}

---

<div class="post-metadata">

### Author: ![kriti\_dabas](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/kriti_dabas/32/118506_2.png) [@kriti\_dabas](https://discuss.elastic.co/u/kriti_dabas)
#### Post date: [January 31, 2024, 9:37am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/8 "2024-01-31T09:37:40Z")

</div>

I want to see the dashboard on kibana.

---

<div class="post-metadata">

### Author: ![system](https://us1.discourse-cdn.com/elastic/original/3X/1/a/1ac57faf039f6b580b3f104ef42a2a89e41014de.png) [@system](https://discuss.elastic.co/u/system)
#### Post date: [February 28, 2024, 9:38am UTC](https://discuss.elastic.co/t/how-to-monitor-kafka-using-metricbeat/352146/9 "2024-02-28T09:38:25Z")

</div>

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.