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 or discussion for any feedback.

This reporter enables you to send traces to Honeycomb . 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.

An additional plugins.publish-metrics.spans.exported metric will be recorded and will appear in your reports when tracing is enabled. It represents the number of spans exported to Honeycomb.

Added inv2.0.9

Configuration options

Name	Description
`apiKey` (required)	Your Honeycomb API key
`dataset` (required)	Name of a dataset you want to send traces to
`useRequestNames` Added inv2.0.5	If set to `true` the request `name`s provided in test script will be used as span names
`sampleRate`	Sample rate. Percentage of traces to send represented by a value between 0 and 1. (defaults to 1 - all traces are sent)
`attributes` Added inv2.0.5	Custom attributes in `key: value` pair format to be added to each span
`enabled`	Set to `false` to disable the reporter
`replaceSpanNameRegex` Added inv2.0.9	A list of replacement maps that consist of: `pattern` - regex pattern to match against the span names `as` - string to replace the matched pattern in the span names

Example


config:
  plugins:
    publish-metrics:
      - type: honeycomb
        apiKey: '{ $env.HONEYCOMB_API_KEY }'
        dataset: 'My-Load-Test'
        sampleRate: 0.5
        replaceSpanNameRegex:
          - pattern: get_user_[a-zA-Z0-9]+
            as: get_user_id
        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