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.

To add markers via a command line tool, use either curl or honeymarker, a lightweight marker management tool that provides a CRUD command line interface.
Managing markers with a CLI requires a Configuration API Key, which must have the Manage Markers permission. Refer to our API keys documentation for more details. Also, the dataset must already exist for a marker to be added successfully.

​
Add Markers (add)

For example: 
honeymarker \
    -k YOUR_API_KEY \
    -d myservice \
    -t deploy \
    -m "build 192837" \
    add

​
honeymarker add

honeymarker has the following command line flags:
NameFlagDescriptionRequired
Start Time-s <arg> / --start_time=<arg>start time for the marker in unix time (seconds since the epoch)No
End Time-e <arg> / --end_time=<arg>end time for the marker in unix time (seconds since the epoch)No
Message-m <arg> / --msg=<arg>message describing this specific markerNo
URL-u <arg> / --url=<arg>URL associated with this markerNo
Type-t <arg> / --type=<arg>identifies marker typeNo
All parameters to add are optional. If start_time is missing, the marker will be assigned the current time. It is highly recommended that you fill in either message or type. All markers of the same type will be shown with the same color in the UI. The message will be visible above an individual marker. If a URL is specified along with a message, the message will be shown as a link in the UI, and clicking it will take you to the URL.

​
List Markers (list)

For example: 
honeymarker \
    -k YOUR_API_KEY \
    -d myservice \
    list

​
honeymarker list

honeymarker has the following command line flags:
NameFlagDescriptionRequired
JSON--jsonOutput the list as json instead of in tabular formNo
Unix Timestamps--unix_timeIn table mode, format times as unit timestamps (seconds since the epoch)No

​
Update Markers (update)

For example: 
honeymarker \
    -k YOUR_API_KEY \
    -d myservice \
    -i marker-id \
    -u "http://my.service.co/builds/192837" \
    update

​
honeymarker update

honeymarker has the following command line flags:
NameFlagDescriptionRequired
Marker ID-i <arg> / --id=<arg>ID of the marker to updateYes
Start Time-s <arg> / --start_time=<arg>start time for the marker in unix time (seconds since the epoch)No
End Time-e <arg> / --end_time=<arg>end time for the marker in unix time (seconds since the epoch)No
Message-m <arg> / --msg=<arg>message describing this specific markerNo
URL-u <arg> / --url=<arg>URL associated with this markerNo
Type-t <arg> / --type=<arg>identifies marker typeNo
The marker ID is available from the list command, and is also output to the console by the add command.

​
Delete Markers (rm)

For example: 
honeymarker \
    -k YOUR_API_KEY \
    -d myservice \
    -i marker-id \
    rm

​
honeymarker delete

honeymarker has the following command line flags:
NameFlagDescriptionRequired
Marker ID-i <arg> / --id=<arg>ID of the marker to deleteYes
The marker ID is available from the list command, and is also output to the console by the add command.

​
Honeymarker

honeymarker is a lightweight tool that provides a CRUD command line interface to manage your markers.

​
Installation

Download and install the latest version of honeymarker by visiting the releases page for of honeymarker, which contains binary packages for a variety of platforms. The packages install honeymarker to /usr/bin. The binary is called honeymarker, available if you need it in an unpackaged form or for ad-hoc use. View honeymarker’s source.

​
Usage

Use the following command format for honeymarker: 
honeymarker -k <YOUR_API_KEY> -d <dataset> COMMAND [command-specific flags]
where:
  • <YOUR_API_KEY> is found on <https://ui.honeycomb.io/account>.
  • <dataset> is the name of the dataset for which you want to create the marker.
  • COMMAND is one of available commands listed below.
For Environment markers, use __all__ for dataset name.

​
Available Commands

honeymarker has the following commands:
CommandDescription
addadd a new marker
listlist all markers
rmdelete a marker
updateupdate a marker

​
OpenTelemetry Marker Exporter

The OpenTelemetry Collector’s Marker Exporter allows you to send a Honeycomb Marker based on the shape of incoming telemetry. In your OpenTelemetry Collector exporter configuration, you can specify a set of rules that will be evaluated against incoming telemetry. When a condition is met, a marker is sent and appears in Honeycomb. For example, whenever a Kubernetes Event contains a reason of Backoff, the configuration below sends a marker: 
exporters:
  honeycombmarker:
    api_key: YOUR-API-KEY-HERE
    markers:
      # Creates a new marker each time the exporter sees a Kubernetes event with a reason of Backoff
      - type: k8s-backoff-events
        rules:
          - log_conditions:
              - IsMap(body) and IsMap(body["object"]) and body["object"]["reason"] == "Backoff"