Configure the Honeycomb data source

This page explains how to configure the Honeycomb data source for Grafana.

Before you begin

To configure this data source, you need:

Get an API key from Honeycomb

Before configuring the data source, you need an API key from Honeycomb:

  1. Go to https://ui.honeycomb.io/account.
  2. Create a new API key or use an existing one.
  3. Copy your API key.

Required API key permissions

Your Honeycomb API key must have the following permissions enabled:

PermissionDescription
Manage Queries and ColumnsRequired to access dataset columns and metadata.
Run QueriesRequired to execute queries against your data.

Without these permissions, the data source connection test will fail with a permissions error.

Add the Honeycomb data source

For general information on adding a data source, refer to Add a data source.

Complete the following steps to add a new Honeycomb data source:

  1. Click Connections in the left-side menu.
  2. Click Add new connection.
  3. Type Honeycomb in the search bar.
  4. Select the Honeycomb data source.
  5. Click Add new data source in the upper right.

Grafana takes you to the Settings tab, where you will set up your Honeycomb configuration.

Honeycomb settings

Configure the following settings for your Honeycomb data source:

FieldDescription
NameA name for this particular Honeycomb data source.
Honeycomb API KeyAPI key from Honeycomb.
URLURL to the Honeycomb API. For example, https://api.honeycomb.io.
Team NameThe Honeycomb team associated with the API key.
Environment NameHoneycomb environment name associated with the API key.

Advanced settings

FieldDescription
Time Window (days)The number of days of historical data the data source can query. Default is 7 due to Honeycomb API limitations.

Configuration

Configure with provisioning

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

Example:

YAML
apiVersion: 1
datasources:
  - name: Honeycomb
    type: grafana-honeycomb-datasource
    jsonData:
      hostname: https://api.honeycomb.io
      team: Team
      environment: test
    secureJsonData:
      apiKey: API Key

Configure with Terraform

You can configure the Honeycomb data source using the Grafana Terraform provider.

Example:

hcl
resource "grafana_data_source" "honeycomb" {
  type = "grafana-honeycomb-datasource"
  name = "Honeycomb"

  json_data_encoded = jsonencode({
    hostname    = "https://api.honeycomb.io"
    team        = "my-team"
    environment = "production"
  })

  secure_json_data_encoded = jsonencode({
    apiKey = var.honeycomb_api_key
  })
}

For more information about the Grafana Terraform provider, refer to the Grafana Terraform provider documentation.