Using the Honeycomb events integration

Read time: 3 minutes

Last edited: Nov 04, 2024

The Honeycomb events integration is a Foundation and Enterprise feature

The Honeycomb events integration is available to customers on a Foundation or Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

Overview

This topic explains how to use the LaunchDarkly Honeycomb events integration.

The LaunchDarkly Honeycomb integration helps you diagnose problems by sending flag events to Honeycomb. Honeycomb displays those events alongside performance graphs so you can correlate feature rollouts with changes in operational health.

A Honeycomb events graph showing LaunchDarkly flag change events, with a flag event called out.

The integration only sends flag actions to Honeycomb

Only flag action events appear in Honeycomb after you configure the integration. Other event kinds do not appear. To learn more, read Feature flag actions.

To send flag change events to Honeycomb:

Create a Honeycomb API key.
Add the Honeycomb integration in LaunchDarkly.
(Optional) Configure the integration's policy to allow or restrict specific projects and environments.

Prerequisites

To use the LaunchDarkly Honeycomb integration successfully, you must meet the following prerequisites:

You must have an API key from your Honeycomb account. To learn more, read Create a Honeycomb API key.

Create a Honeycomb API key

The Honeycomb API key authenticates the LaunchDarkly integration so it can submit events to your Honeycomb account. The LaunchDarkly integration uses Honeycomb's Marker API.

To learn more about Honeycomb's Marker API, read Honeycomb's documentation.

When you create the API key, confirm that the key has access to create "markers." This is the only access scope the LaunchDarkly integration needs.

Add the Honeycomb integration

Here's how to add the Honeycomb integration:

Navigate to the Integrations page and find "Honeycomb."
Click Add integration. The "Create Honeycomb configuration" panel appears.
(Optional) Type a human-readable Name.
Enter the Honeycomb dataset name you would like flag markers to be associated with.
Paste in your Honeycomb API key.
(Optional) Configure a custom policy to control which flag information LaunchDarkly sends to Honeycomb. To learn more, read Configure integration policies.
After reading the Integration Terms and Conditions, check the I have read and agree to the Integration Terms and Conditions checkbox.
Click Save configuration.

Configure integration policies

The "Policy" field in the integration configuration panel lets you control which events LaunchDarkly sends to Honeycomb.

The resource specifier in the default policy value allows production environments across all projects to send events:

proj/*:env/production:flag/*

To learn more, read Resources in custom roles.

You can use the policy editor to restrict the integration to:

a specific set of LaunchDarkly projects/environments
a specific set of flags
a specific set of actions

For example, to restrict the policy to a single project called cool-app, set the policy configuration's resource field to the following resource specifier:

proj/cool-app:env/production:flag/*

The policy above makes the integration only send flag events from the cool-app project's Production environment to Honeycomb.

If you need to restrict or allow a more complex set of resources than you can specify in a single policy, you can add multiple Honeycomb integrations and configure each one to a specific task. Each integration can have its own separate policy configuration.

To learn more about using the policy editor, read Policies in custom roles.