artillery-plugin-metrics-by-endpoint

Purpose

Use this plugin to get a per-endpoint breakdown of latency and response codes in your Artillery HTTP tests.

Usage

Install the plugin globally or locally, depending on your setup

# Install the plugin globally if Artillery is installed globally:
npm install artillery-plugin-metrics-by-endpoint -g

# Or install into a project's dependencies:
npm install --save-dev artillery-plugin-metrics-by-endpoint

Enable the plugin in the config

config:
  plugins:
    metrics-by-endpoint: {}

Run your tests as normal. There will additional output in the reports, providing latency metrics for each HTTP endpoint hit by the test.

By default the plugin will treat each unique URL as a separate endpoint, e.g. if you tests makes requests to the following URLs:

1. /foos/1
2. /foos/2

The report will contain latency metrics for both of those URLs. To treat those requests as the same endpoint, add a name atribute to the request in your test, and set useOnlyRequestNames option in plugin config:

config:
  target: "https://my-app.acme-corp.internal"
  plugins:
    metrics-by-endpoint:
      useOnlyRequestNames: true
scenarios:
  - flow:
      - loop:
        - get:
            url: "/foos/{{ $loopElement }}"
            name: "orders"
        count: 100

In order to ensure the latency metrics by artillery-plugin-ensure you have to specify a custom namespace for the latency metrics like this:

config:
  target: "https://my-app.acme-corp.internal"
  plugins:
    metrics-by-endpoint:
      useOnlyRequestNames: true
      metricsNamespace: "latency_metrics"
    ensure: {}
  ensure:
    thresholds:
      - "latency_metrics.response_time.orders.p95": 150
scenarios:
  - flow:
      - loop:
          - get:
              url: "/foos/{{ $loopElement }}"
              name: "orders"
        count: 100

This is due to different naming patterns for metrics in both plugins.

Configuration

Name	Default	Description
useOnlyRequestNames	false	If true, will use only the name field of a request as the metric name. If false, the name will be prepended to the standard metric name if it exists.
stripQueryString	false	If true, query-strings will be stripped from the metric name.
ignoreUnnamedRequests	false	If true, any requests without a name field will not have metrics published.
metricsPrefix	plugins.metrics-by-endpoint	Custom prefix to use for metrics published by this plugin.

License

MPL 2.0