Skip to main content
Version: current

Monitoring System Telemetry

This topic describes using the Dremio Community Prometheus Exporter to collect Dremio system telemetry. The Dremio Community also provides an AWS CloudWatch Exporter and a Stackdriver Configurator:

See the README.md in the CloudWatch exporter for instructions on generating a .jar file for AWS CloudWatch.

note:

Important: Dremio does not provide customer support for the Community Exporters and Configurator.

To capture Dremio system telemetry, Dremio administrators perform the following tasks:

  1. Generate a dremio telemetry .jar file using Dremio OSS and a Dremio Exporter or Configurator.
  2. Deploy the .jar file and a telemetry configuration file to the Dremio deployment for which you want system telemetry.
  3. Restart Dremio.

Generating a Dremio Telemetry .jar​

  1. Open pom.xml in the Prometheus Exporter and update the <version> element to match the version in the pom.xml in Dremio OSS:

    Update <version> element in pom.xml
    <parent>
      <groupId>com.dremio</groupId>
      <artifactId>dremio-parent</artifactId>
      <version>4.8.0-202009180238090394-b0a98b73</version>
    </parent>

  2. Run the following command in the directory where you downloaded the exporter:

    mvn command
    mvn clean install

The exporter creates a dremio-telemetry-prometheus-<dremio-oss-version>-shaded.jar file in the target directory.

Deploy the .jar and Telemetry Configuration File​

  1. Copy the .jar file from the target directory of the exporter to the /jars/3rdparty directory in the Dremio deployment for which you want to collect system telemetry.

  2. Create a dremio-telemetry.yaml configuration file in the /conf directory of your local Dremio deployment with the following scrape_configs section:

    Note:
    A new version of the Dremio JDBC driver is made available periodically for use with Dremio Cloud. Release notes will be published when changes are made and a new driver version is released.

    See Configuration in the Prometheus documentation for more information about the Prometheus configuration file.

    Content for dremio.telemetry.yaml
    ...
    scrape_configs:
     - job_name: dremio
       scrape_interval: 5s
       static_configs:
         - targets:
             - localhost:12543
    ...

  3. Restart Dremio.

To access the exported Dremio system telemetry, start a Prometheus server and point a web browser to localhost:9090\metrics. See Getting Started in the Prometheus documentation for details.