Settings | Honeycomb

Settings

Access Environment and Dataset Settings through several ways:

  • Dataset Settings button in Home page
  • Select a Dataset by name in the Data Settings page
  • Manage Environments button at the top of the colorful Environment list

Use the dropdown window within the Settings Page to navigate between specific Environment(s) and Dataset(s) settings. The tabs in the display change depending on whether an Environment or Dataset is selected.

Environment Settings 

For Environments, the Settings page consists of the Overview, API Keys, and Markers tabs.

Note
Environment Settings are not available if you are a Honeycomb Classic user.

Overview 

In the Environment Overview tab, view and edit the Environment’s description and its associated color.

Though an Environment’s color is selected at creation, the color can be changed at a later time. Select a new choice from a set range of colors in the Color section.

API Keys 

The API Keys tab lists the API keys associated with its Environment. In this tab, you can see each API key’s name, its key value, and what access it controls. Copy the key value in this screen by selecting the copy icon adjacent to the key value.

You must be a team owner to create and edit API keys.

Schema 

The Schema tab lists the Environment’s existing Derived Columns with the ability to search and add new Derived Columns.

Markers 

The Markers tab lists any Environment-wide Marker and its associated color. Markers display as vertical lines on graphs to mark points in time where interesting things happen, such as deploys or outages.

You must be a team owner to change the Marker color in the Honeycomb UI. Modify a Dataset-wide Marker’s color setting by selecting the field under the Color column in the Markers tab. Alternatively, use the Marker Settings API.

Learn more about Marker configuration.

Delete 

In the Delete tab, a team owner can delete an environment. You cannot delete the last environment in your team.

Dataset Settings 

For Datasets, the Settings page consists of Overview, Schema, Definitions, Markers, and Delete tabs.

Overview 

In the Dataset Overview tab:

  • locate and modify the Dataset’s Description
  • set Default Granularity
  • select and modify Suggested Queries
  • locate information about your Events Retention and Usage, Daily Event Traffic, Event Latency History, and Event Rate

Default Granularity 

Default Granularity affects the display of your Query Results visualizations. Granularity refers to the regular, known interval that data is captured. Queries in this dataset do not drop below the default granularity unless you choose to override it manually when making an individual query.

Default Granularity controls the default granularity seen:

  • after running a query
  • for charts on the Home page
  • for Suggested Queries on a blank Query page

Choose your Default Granularity from the options in the dropdown list.

Best practice is to set the default granularity with the interval at which data enters Honeycomb, which prevents the appearance of spiky graphs. For example, if your data enters the dataset at regular 30 second intervals, we recommend setting a default granularity of 30 seconds.

Suggested Queries 

Suggested Queries allow you to select a board to provide suggested queries for this dataset. The selected Board must be public, and the queries must be named.

The queries will be shown anytime you land on a blank Query page. Multiple datasets can use the same board.

Schema 

The Schema tab allows you to select whether nested JSON automatically unpacks, and lists the Dataset’s Unique Fields and Derived Columns.

Unique Fields lists all the unique fields seen in events from this dataset. You can modify a field’s data type here if needed.

Tip
If you change the type of a field in the Schema page and then later send an event where the data type does not match, then Honeycomb will try to coerce the value. If Honeycomb cannot coerce the value, it will get set to zero (0) rather than dropping the value.

Definitions 

The Definitions tab allows you to indicate which fields in your Dataset have special meaning in Honeycomb. Learn more about Dataset Definitions.

Correlations 

The Correlations tab controls settings related to Correlations in Query Builder.

Default Correlations Board 

Default Correlations Board sets a default Board, which contains your queries of interest, to appear when using the Correlations tab in Query Builder. All charts from the default Correlations Board appear when you select the Correlations tab. Their order reflects their order on the Board.

The selected Board must be public. Multiple datasets can use the same board.

Markers 

The Markers tab lists any Dataset-wide Marker and its associated color. Markers display as vertical lines on graphs to mark points in time where interesting things happen, such as deploys or outages.

You must be a team owner to change the Marker color in the Honeycomb UI. Modify a Dataset-wide Marker’s color setting by selecting the field under the Color column in the Markers tab. Alternatively, use the Marker Settings API.

Learn more about marker configuration.

Delete 

In the Delete tab, a team owner can delete a dataset.