shoreditch-ops/artillery-plugin-datadog

Name: artillery-plugin-datadog

Owner: Shoreditch Ops

Description: Artillery plugin for sending metrics to Datadog

Forked from: bigbank-as/artillery-plugin-datadog

Created: 2016-11-07 10:07:43.0

Updated: 2018-05-02 08:52:08.0

Pushed: 2016-10-06 10:43:41.0

Homepage: null

Size: 9

Language: CoffeeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

artillery-plugin-datadog

Artillery plugin that reports load test results to Datadog.

The plugin uses datadog-metrics to submit Artillery metrics to Datadog over HTTPS and does not require a StatsD server (Datadog Agent). An alternative to this is artillery-plugin-statsd which uses StatsD.

Usage

• Install this plugin and Artillery (npm install artillery artillery-plugin-datadog)
• Create a configuration file for Artillery. Specify Datadog as the plugin to use.

ynet.yaml
ig:
rget: https://skynet.org
ases:
- duration: 3
  arrivalRate: 15
  name: "First stage"
ugins:
datadog:
  # Custom hostname (leave blank if not desired)
  host: ''
  # Custom metric prefix (defaults to 'artillery.')
  prefix: 'artillery.'
  # Additional tags for all metrics
  tags:
    - 'mode:test'
arios:
flow:
  - get:
      url: /status

Run artillery and specify Datadog API key as an environment variable.

TADOG_API_KEY=xxxxxxxxxxxx artillery run skynet.yaml

Metrics

The following metrics are collected from Artillery and sent to Datadog.

• artillery.scenarios.created: Number of scenarios created
• artillery.scenarios.completed: Number of scenarios completed
• artillery.requests.completed: Number of HTTP requests completed
• artillery.response.2xx: Aggregate count of all responses whose HTTP code was in the 2xx range
• artillery.response.3xx: Aggregate count of all responses whose HTTP code was in the 3xx range
• artillery.response.4xx: Aggregate count of all responses whose HTTP code was in the 4xx range
• artillery.response.5xx: Aggregate count of all responses whose HTTP code was in the 5xx range
• artillery.response.200: Count of responses whose HTTP code was 200 (exactly). Similarly named metric is repeated for each response status code
• artillery.response.ok_pct: Percentage (in the range 0 - 100) of responses that returned with a 2xx or 3xx status code

Development

Artillery plugin system documentation is at github.com/shoreditch-ops/artillery.

To display debug info, run Artillery with the DEBUG environment variable:

ATADOG_API_KEY=xxxxx DEBUG=metrics,plugin:datadog artillery run skynet.yml

License

Apache-2.0 license