Agent Check: Confluent Platform

Overview

This check monitors Confluent Platform and Kafka components through the Datadog Agent.

This integration collects JMX metrics for the following components:

• Broker
• Connect
• Replicator
• Schema Registry
• SQL Server
• Streams
• REST Proxy

Setup

Installation

The Confluent Platform check is included in the Datadog Agent package. No additional installation is needed on your Confluent Platform component server.

Note: This check collects metrics with JMX. A JVM is required on each node so the Agent can run jmxfetch. It is recommended to use an Oracle-provided JVM.

Configuration

1. Edit the confluent_platform.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to collect your Confluent Platform performance data. See the sample confluent_platform.d/conf.yaml for all available configuration options.

   For each component, you need to create a separate instance to collect its JMX metrics. The list of default metrics collected are listed in metrics.yaml file, for example:

   instances:
    - host: localhost
      port: 8686
      name: broker_instance
      user: username
      password: password
    - host: localhost
      port: 8687
      name: schema_registry_instance
    - host: localhost
      port: 8688
      name: rest_proxy_instance

2. Restart the Agent.

Containerized

Metric collection

For containerized environments, see the Autodiscovery with JMX guide.

Validation

Run the Agent's status subcommand and look for confluent_platform under the JMXFetch section.

    ========
    JMXFetch
    ========

      Initialized checks
      ==================
        confluent_platform
          instance_name : confluent_platform-localhost-31006
          message :
          metric_count : 26
          service_check_count : 0
          status : OK

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this check.

Service Checks

confluentplatform.can_connect:
Returns CRITICAL if the Agent is unable to connect to and collect metrics from the monitored Confluent Platform / Kafka component, otherwise returns OK.

Events

The Confluent Platform check does not include any events.

Troubleshooting

Need help? Contact Datadog support.