Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt

Use this file to discover all available pages before exploring further.

When you first add Honeycomb to your application, you will need to specify an Environment. Honeycomb uses Environments to partition your data and organize your Honeycomb resources. You can manage your Honeycomb Environments using the Honeycomb UI.
Environments exist only in Honeycomb’s current release. If you use Honeycomb Classic, we recommend migrating to Honeycomb Environments, so you can take advantage of its expanded data model and future product updates.

​
Create Environment

To create your Environment:
  1. Log in to the Honeycomb UI.
  2. Select the Environments label on the top-left, then select Manage Environments.
  3. Select Create Environment.
  4. In the Create Environment modal, enter a name for the environment. Optionally, enter a description and choose a color for its label.
    Once you create your environment, you cannot rename it. You can delete it.
  5. Select Create Environment.
You should now see the new Environment in the list of environments. We have also automatically generated an API Key for your Environment; to see it, select View API Keys. Make sure you copy your API Key for later use in your instrumentation. To learn more about API Keys, visit Manage API Keys.

​
Add Description

To add your Environment’s description:
  1. Log in to the Honeycomb UI.
  2. Select the Environments label on the top-left, then select Manage Environments.
  3. In the list, locate the environment for which you want to add a description, and select its name to view the available settings.
  4. Locate the Description section, and select Add a description for this environment.
  5. Enter a description, and select Save Changes.

​
Change Description

To change your Environment’s description:
  1. Log in to the Honeycomb UI.
  2. Select the Environments label on the top-left, then select Manage Environments.
  3. In the list, locate the environment for which you want to change the description, and select its name to view the available settings.
  4. Locate the Description section, and select Edit.
  5. Enter a new description, and select Save Changes.

​
Change Label Color

To change your Environment’s label color:
  1. Log in to the Honeycomb UI.
  2. Select the Environments label on the top-left, then select Manage Environments.
  3. In the list, locate the environment for which you want to change the label color, and select its name to view the available settings.
  4. Locate the Color section, and select the desired color from the dropdown.
  5. Select Save Changes.

​
Delete Environment

Environment deletion is permanent, so make sure you really want to delete your Environment before doing so.Deletion Protection prevents an Environment from being accidentally deleted.To delete an Environment, you must be a Team Owner, Deletion Protection must be disabled, and the Environment must not be the last Environment in your Team.
To delete your Environment:
  1. Log in to the Honeycomb UI.
  2. Select the Environments label on the top-left, then select Manage Environments.
  3. In the list, locate the Environment that you want to delete, and select its name to view the available settings.
  4. Select the Delete view.
  5. If Deletion Protection is enabled for the Environment, toggle it ‘off’ to enable the Delete Environment button.
  6. Select Delete Environment.
  7. In the Delete Environment? modal, enter the unique identifier of the Environment (listed in parentheses).
  8. Select I understand the consequences. Delete this environment.
Your Environment will be deleted, but it may take several minutes for the process to complete.

​
Troubleshoot

To see common issues when managing Environments and their solutions, visit Common Issues with Configuring Honeycomb: Environments.