Honeycomb

Powered by: OpenTelemetry reporter

⚠️

Experimental This feature is under active development. We aim to keep it stable, but it may need to introduce breaking changes. Please open an issue (opens in a new tab) or discussion (opens in a new tab) for any feedback.

This reporter enables you to send traces to Honeycomb (opens in a new tab). In order to enable it set type to honeycomb as shown below:

plugins:
  publish-metrics:
    - type: honeycomb

Traces

Sending traces to Honeycomb is supported for both HTTP and Playwright engine, and the tracing data available is different depending on the engine used.

Configuration options

NameDescription
apiKey (required)Your Honeycomb API key
dataset (required)Name of a dataset you want to send traces to
useRequestNames

Added in: v2.0.5

If set to true the request names provided in test script will be used as span names
sampleRateSample rate. Percentage of traces to send represented by a value between 0 and 1. (defaults to 1 - all traces are sent)
attributes

Added in: v2.0.5

Custom attributes in key: value pair format to be added to each span
enabledSet to false to disable the reporter

Example

config:
  plugins:
    publish-metrics:
      - type: honeycomb
        apiKey: "{ $env.HONEYCOMB_API_KEY }"
        dataset: "My-Load-Test"
        sampleRate: 0.5
        useRequestNames: true
        attributes:
          testType: LoadTest
          tool: Artillery

Debugging

Set DEBUG=plugin:publish-metrics:honeycomb when running your tests to print out helpful debugging messages when sending metrics to Honeycomb.

DEBUG=plugin:publish-metrics:honeycomb artillery run my-script.yaml