Kafka 🔗

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Kafka monitor type to monitor Kafka instances using collectd’s GenericJMX plugin.

Note

To monitor Kafka with the OpenTelemetry Collector using native OpenTelemetry components refer to the Kafka metrics receiver.

This integration has a set of built-in MBeans to pull metrics from the Kafka’s JMX endpoint. For more information, see Kafka producer MBeans in GitHub.

This integration is only available on Kubernetes and Linux, and supports Kafka v0.8.2.x and higher.

For Kafka v1.x.x and higher monitor the following:

kafka.server:type=ZooKeeperClientMetrics,name=ZooKeeperRequestLatencyMs to track how long brokers wait for requests to Zookeeper to be completed.
Disk utilization and network metrics of the underlying host.
Since Zookeeper is an integral part of a Kafka cluster, you can monitor it using the Zookeeper integration.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata catalog.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this integration of a Smart Agent monitor with the Collector:

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.

Example 🔗

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/kafka:
    type: collectd/kafka
    ...  # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [smartagent/kafka]

See configuration examples for specific use cases that show how the Splunk Distribution of the OpenTelemetry Collector can integrate and complement existing environments.

Configuration settings 🔗

See Settings in GenericJMX.

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

This page was last updated on Sep 18, 2024.

Related Topics