Skip to main content

Use Conductor's Grafana dashboard (Enterprise)

Along with the dashboards provided out-of-the box in the Conductor UI, you can optionally configure Conductor's Grafana dashboard to run alongside your existing observability suite and link back to Conductor. This guide details how to download and configure the Grafana dashboard.

Prerequisites​

Create the Conductor Prometheus data source​

  1. Log into the Diagrid CLI and create an API key with the diagrid:viewer role for Grafana to authenticate to Conductor. Alternatively this can be done in the Conductor UI on the API Keys page. Be sure to save the token value of the api key before navigating away.
diagrid login
diagrid apikeys create --name grafana --role diagrid:viewer

  1. In your Grafana instance, navigate to Connections and then Data sources. Choose Add new data source and select Prometheus as the data source type.

    Fill in the following options:

  • Choose an appropriate data source name such as Conductor.

  • Set the Prometheus server URL field to https://api.diagrid.io/apis/diagrid.io/v1beta1/prometheus.

  • Under the HTTP Headers section, configure the following:

    • Add a HTTP Header with the Header field set to X-Diagrid-Api-Key and the Value field set to the Conductor API key token created in Step 1.

  • Click Save & test.

  1. Before navigating away from the Conductor data source, copy the data source UID from the end of the Grafana URL. For instance, if your URL is https://mygrafana.grafana.net/connections/datasources/edit/d53eb7d2-0ag3-4057-842e-436bfba35a03, then the data source UID is d53eb7d2-0ag3-4057-842e-436bfba35a03.

Import the Conductor Grafana dashboard​

  1. Navigate to the Conductor UI.

  2. Select the Help (?) icon from the upper right corner of the screen, choose Grafana Dashboard and download the template locally.

  3. In your Grafana instance, navigate to the Dashboards page.

  4. Select the New button and choose the Import option.

  5. Use the Upload dashboard JSON file section to upload the Grafana template that you just downloaded locally and hit the Load button.

  6. Once the dashboard is loaded, click the gear icon in the upper right corner to open the dashboard settings. Select Variables and configure the following:

  • Update the value of the datasourceUID variable to be the data source UID copied from the previous section.
  • Apply the changes and return to the dashboard.
  1. You have successfully configured the dashboard! Notice there are 2 input fields available, one for your clusterID and the other for your applications' Dapr app-ID. You can use these fields to control the data that is loaded into the dashboard. Each dashboard panel also has an external link back to the corresponding graph in Conductor for digging deeper into the data.