Manage Dataset Markers

Each Dataset allows you to define markers for use within it.

Tip

You can create markers at both the Dataset and the Environment level. When you create a marker at the Dataset level, you can use it only within its associated Dataset. When you create a marker at the Environment level, you can use it across all Datasets in your Environment.

You can manage markers using both the Honeycomb UI and Honeycomb API.

What are Markers?

Markers are custom labels that you can add to your data to emphasize specific data points in time, such as when you change a condition, deploy code, or have an outage.

Markers display as vertical lines on graphs in Honeycomb to signal interesting occurrences within the context of your queries.

Uses

Use markers to identify points in time, such as:

deployments
incidents
activated or resolved Triggers
enabled or disabled feature flags

Tip

You should create a Dataset-level marker when the range of time is relevant only to the specific Dataset or Service.

Change Marker Color

Important

You must be a Team Owner to change a marker’s color.

To change your marker color:

Log in to the Honeycomb UI.
Select the Environments label on the top-left, then select the appropriate environment.
Navigate to Data Settings.
In the list, locate the dataset that contains the marker you want to edit, and select its name to view the available settings.
Select the Markers view.
In the list, locate the Marker Type you want to change, and select the desired color from the dropdown in the Color column. We will save your changes automatically.

Add Markers From the UI

To create a marker from the Honeycomb UI:

In your query results, move your cursor over the graph to your desired time point.
Select your desired time point, which causes the graph menu options to appear.
Select Add marker. The Add a Marker modal appears.
Enter the following information:
1. A Message for your marker, such as “Deploy #299” or “Abnormal Spike in Products Page Traffic”.
2. A Type for the marker, such as “deploy” or “trigger”. After creation, the type appears as a preface to the marker’s message when viewing the marker details.
3. The URL field is optional, but provides a great way for more context about the marker.
4. Select the “Environment-wide” checkbox to apply this marker to all datasets in your environment.
When finished, select Create to add your marker to the graph.

Tip

To add markers via a command line tool or further manage existing markers, use either curl or honeymarker, a lightweight marker management tool that provides a CRUD command line interface. Refer to our Markers documentation for more information.

View Markers in the UI

Once created, markers appear on any queries that run within the same time period as the marker(s).

Each marker type can appear in its own color.

Tip

To change dataset marker color, configure dataset markers in Dataset Settings.

Hover over the downward caret icon to view a marker’s details. A solid vertical line appears and a window displays the marker’s name, description, and if applicable, a selectable URL.

To persist the marker’s vertical line and information window, select the downward caret icon. To close the persisted display, use the x icon that appears in the window after selection.

Screenshot illustrating a selected marker and marker details

Filter Markers in the UI

By default, Honeycomb shows environment markers in environment-wide queries and dataset markers in dataset queries.

Use Filter Markers to modify what markers appear in the query results.

To access Filter Markers, either:

Press l on your keyboard
Select the Speech Box icon below the time picker in your query results, and select Filter Markers.

The Filter Markers modal appears. Use to modify what markers appear based on:

on their value
whether or not markers of the opposite type (environment/dataset) are allowed
their marker type

Screenshot illustrating the 'Filter Markers' dialog box for a dataset query