ob-col/exporter/honeycombmarkerexporter/README.md

Honeycomb Marker Exporter

Status
Stability	alpha: logs
Distributions	contrib
Issues
Code Owners	@TylerHelmuth, @fchikwekwe

This exporter allows creating markers, via the Honeycomb Markers API, based on the look of incoming telemetry.

The following configuration options are supported:

• api_key (Required): This is the API key for your Honeycomb account.
• api_url (Optional): This sets the hostname to send marker data to. If not set, will default to https://api.honeycomb.io/
• markers (Required): This is a list of configurations to create an event marker.
  • type (Required): Specifies the marker type.
  • rules (Required): This is a list of OTTL rules that determine when to create an event marker.
  • log_conditions (Required): A list of OTTL log conditions that determine a match. The marker will be created if ANY condition matches.
  • dataset_slug (Optional): The dataset in which to create the marker. If not set, will default to __all__.
  • message_key (Optional): The key of the attribute whose value will be used as the marker's message. If necessary the value will be converted to a string.
  • url_key (Optional): The key of the attribute whose value will be used as the marker's url. If necessary the value will be converted to a string.

Example:

exporters:
  honeycombmarker:
    api_key: {{env:HONEYCOMB_API_KEY}}
    markers:
      # Creates a new marker anytime the exporter sees a k8s event with a reason of Backoff
      - type: k8s-backoff-events
        rules:
          - log_conditions:
              - IsMap(body) and IsMap(body["object"]) and body["object"]["reason"] == "Backoff"