Apache Druid integration

Install the infrastructure agent

To use the Apache Druid integration, you need to first install the infrastructure agent on the same host. The infrastructure agent monitors the host itself, while the Apache Druid integration extends your monitoring with data specific to your Druid clusters.

Expose Druid metrics using Prometheus Emitter

1. Add prometheus.emitter to the end of the extensions load list in your apache-druid-$version/conf/druid/single-server/micro-quickstart/_common/common.runtime.properties file:

   druid.extensions.loadList=["druid-hdfs-storage", "druid-kafka-indexing-service", "druid-datasketches", "druid-multi-stage-query", "prometheus-emitter"]

   Copy

2. In the file paths listed in the left column, add the code snippets listed in the right columns.

   Filepath	Code snippet
   PATH/TO/broker/runtime.properties	# Monitoring druid.monitoring.monitors=["org.apache.druid.java.util.metrics.JvmMonitor"] druid.emitter=prometheus druid.emitter.logging.logLevel=info druid.emitter.prometheus.strategy=exporter druid.emitter.prometheus.port=19091 Copy
   PATH/TO/coordinator-overlord/runtime.properties	# Monitoring druid.monitoring.monitors=["org.apache.druid.java.util.metrics.JvmMonitor"] druid.emitter=prometheus druid.emitter.logging.logLevel=info druid.emitter.prometheus.strategy=exporter druid.emitter.prometheus.port=19092 Copy
   PATH/TO/historical/runtime.properties	# Monitoring druid.monitoring.monitors=["org.apache.druid.java.util.metrics.JvmMonitor"] druid.emitter=prometheus druid.emitter.logging.logLevel=info druid.emitter.prometheus.strategy=exporter druid.emitter.prometheus.port=19093 Copy
   PATH/TO/middleManager/runtime.properties	# Monitoring druid.monitoring.monitors=["org.apache.druid.java.util.metrics.JvmMonitor"] druid.emitter=prometheus druid.emitter.logging.logLevel=info druid.emitter.prometheus.strategy=exporter druid.emitter.prometheus.port=19094 Copy
   PATH/TO/router/runtime.properties	# Monitoring druid.monitoring.monitors=["org.apache.druid.java.util.metrics.JvmMonitor"] druid.emitter=prometheus druid.emitter.logging.logLevel=info druid.emitter.prometheus.strategy=exporter druid.emitter.prometheus.port=19095 Copy

Install the Prometheus Emitter Extension

1. Run the following commands to create a folder named prometheus-emitter within the extensions folder directory of your Apache Druid setup:
   bash

   Copy

   $
   cd apache-druid-$version/extensions/

   bash

   Copy

   $
   sudo mkdir prometheus-emitter

2. Navigate to the druid download directory and run the following command to create jar files that the server calls on start up:
   bash

   Copy

   $
   sudo java \
   >
     -cp "lib/*" \
   >
     -Ddruid.extensions.directory="extensions" \
   >
     -Ddruid.extensions.hadoopDependenciesDir="hadoop-dependencies" \
   >
     org.apache.druid.cli.Main tools pull-deps \
   >
     --no-default-hadoop \
   >
     -c "org.apache.druid.extensions.contrib:prometheus-emitter:24.0.0"

Configure nri-prometheus for Apache Druid

1. Create a file named nri-prometheus-config.yml:

   bash

   Copy

   $
   touch /etc/newrelic-infra/integrations.d/nri-prometheus-config.yml

2. Add the following snippet to your nri-prometheus-config.yml file to enable the capture of Apache Druid data:

   integrations:
     - name: nri-prometheus
       config:
         # When standalone is set to false nri-prometheus requires an infrastructure agent to work and send data. Defaults to true
         standalone: false
   
         # When running with infrastructure agent emitters will have to include infra-sdk
         emitters: infra-sdk
   
         # The name of your cluster. It's important to match other New Relic products to relate the data.
         cluster_name: "Apache-druid"
   
         targets:
           - description: Secure etcd example
             urls: ["http://<YOUR_HOST_IP>:19091/metrics","http://<YOUR_HOST_IP>:19092/metrics", "http://<YOUR_HOST_IP>:19093/metrics","http://<YOUR_HOST_IP>:19094/metrics","http://<YOUR_HOST_IP>:19095/metrics"]
         #    tls_config:
         #      ca_file_path: "/etc/etcd/etcd-client-ca.crt"
         #      cert_file_path: "/etc/etcd/etcd-client.crt"
         #      key_file_path: "/etc/etcd/etcd-client.key"
   
         # Whether the integration should run in verbose mode or not. Defaults to false.
         verbose: false
   
         # Whether the integration should run in audit mode or not. Defaults to false.
         # Audit mode logs the uncompressed data sent to New Relic. Use this to log all data sent.
         # It does not include verbose mode. This can lead to a high log volume, use with care.
         audit: false
   
         # The HTTP client timeout when fetching data from endpoints. Defaults to "5s" if it is not set.
         # This timeout in seconds is passed as well as a X-Prometheus-Scrape-Timeout-Seconds header to the exporters
         # scrape_timeout: "5s"
   
         # Length in time to distribute the scraping from the endpoints. Default to "30s" if it is not set.
         scrape_duration: "5s"
   
         # Number of worker threads used for scraping targets.
         # For large clusters with many (>400) endpoints, slowly increase until scrape
         # time falls between the desired `scrape_duration`.
         # Increasing this value too much will result in huge memory consumption if too
         # many metrics are being scraped.
         # Default: 4
         # worker_threads: 4
   
         # Whether the integration should skip TLS verification or not. Defaults to false.
         insecure_skip_verify: false
   
       timeout: 10s

   Copy

Forward Druid logs to New Relic

1. Edit the log file named logging.yml located at the following path:

   bash

   Copy

   $
   cd /etc/newrelic-infra/logging.d

2. Add the following snippet to the logging.yml file:

   - name: druid-logs
     file: /home/<Druid-Download Directory>/log/*.log
     attributes:
         logtype: apache-druid

   Copy

Restart the infrastructure agent

Use the instructions in our infrastructure agent docs to restart your infrastructure agent. This is a basic command that should work for most people:

$
sudo systemctl restart newrelic-infra.service

View your Druid metrics in New Relic

Once you've completed the setup above, you can view your metrics using our pre-built dashboard template. To access this dashboard:

1. Go to one.newrelic.com > + Integrations & Agents.

2. Click on the Dashboards tab.

3. In the search box, type Apache druid.

4. Select it and click Install.

   To instrument the Apache Druid quickstart and to see metrics and alerts, you can also follow our Apache Druid quickstart page by clicking on the Install now button.

   Here's an example query to check the average Druid segment size:

   SELECT average(druid_segment_size) AS  'MiB' FROM Metric SINCE 30 MINUTES AGO

   Copy