Honeycomb data source for Grafana

The Honeycomb data source for Grafana allows you to query and visualize Honeycomb metrics and link to Honeycomb traces from within Grafana.

Requirements

The Honeycomb data source has the following requirements:

  • Grafana Enterprise with a valid license. Refer to Activate an Enterprise license.
  • Grafana user with a server or organization administrator role. Refer to Permissions.
  • An active Honeycomb Enterprise team.

Known limitations

  • The Honeycomb API this data source is developed against is not yet generally available. It may cause unexpected behavior in the data source.
  • This data source does not yet support or ad-hoc queries.
  • Due to API limitations, the variable editor can only return the first 1000 unique values for a selected column.
  • Due to API limitations, the data source can only query the last 7 days' worth of data.

Install the data source plugin

To install the data source, refer to Installation.

Conform to compatibility requirements

For this plugin, there are no compatibility requirements.

Verify that the plugin is installed

  1. In Grafana Enterprise from the left-hand menu, navigate to Configuration > Data sources.
  2. From the top-right corner, click the Add data source button.
  3. Search for Honeycomb in the search field, and hover over the Honeycomb search result.
  4. Click the Select button for Honeycomb.
    • If you can click the Select button, then it is installed.
    • If the button is missing or disabled, then the plugin is not installed. Check to see if your Grafana Enterprise license is valid, and reinstall the plugin. If you still need help, contact Grafana Labs.

Note: On Grafana Cloud, it can take up to 15 minutes to see the data source plugin within Grafana.

Get an API key from Honeycomb

  1. Go to https://ui.honeycomb.io/account.
  2. Set up an API key and copy your application key.

Configure the data source

To add a new Honeycomb data source, refer to Add a data source, and fill in the following fields:

Honeycomb settings

Field Description
Name A name for this particular Honeycomb data source.
Honeycomb API Key API key from Honeycomb.
URL URL to the Honeycomb API. For example, https://api.honeycomb.io.
Team The Honeycomb team associated with the API key

Screenshot from 2021-06-11 11-31-44

Configure the data source with provisioning

Configure the Honeycomb data source using configuration files with Grafana’s provisioning system. To know more about how the provisioning system works, including all of the data source settings, refer to Provisioning Grafana.

Here is a provisioning example for this data source:

apiVersion: 1

datasources:
  - name: Honeycomb
    type: grafana-honeycomb-datasource
    access: proxy
    basicAuth: false
    editable: true
    enabled: true
    jsonData:
      hostname: https://api.honeycomb.io
      team: Team
    secureJsonData:
      apiKey: API Key

Query the data source

The query editor allows you to query and link to Honeycomb.

query-editor

Query

Query metrics by entering values into the editor fields.

  • Select a dataset
  • The default query is a COUNT over the selected dataset.
  • To refine the query, select values for any of the remaining fields: Visualization, Where, Constriant, Group by, Order by, or Limit.

Templates and variables

To add a new Honeycomb query variable, refer to Add a query variable. Use your Honeycomb data source as your data source.

Screenshot from 2021-06-17 14-41-10

You can create variables containing Datasets, Columns, or Column Values:

  • If no dataset is selected, the variable will contain datasets
  • If only a dataset is selected, the variable will contain column names
  • If both a dataset and a column are selected, the variable will contain column values.
    • Column values can be further constrained using the Where fields in the editor.

After you create a variable, you can it in your Honeycomb queries. For more information, refer to Variable syntax.

For more information about variables, refer Templates and variables.

View query in Honeycomb UI

From the Dashboard Panel

To see the query you have created in the Honeycomb UI from the dashboard panel, click on any point in the graph and click Open in Honeycomb

Screenshot from 2021-07-22 15-38-33

From the Query Editor

To see the query you have created in the Honeycomb UI, click the Open in Honeycomb button.

Screenshot from 2021-06-17 14-36-42

Import a dashboard for Honeycomb

To import a dashboard, refer to Import a dashboard.

To find your imported dashboards, go to Configuration > Data sources.

To see the available pre-made dashboards, select the Honeycomb data source, and select the Dashboards tab.

Learn more