artillery-plugin-teamcitydeprecated

TeamCity output plugin for Artillery

Usage no npm install needed!

<script type="module">
  import artilleryPluginTeamcity from 'https://cdn.skypack.dev/artillery-plugin-teamcity';
</script>

README

Teamcity Build output for Artillery stats

This Artillery plugin allows you to publish the stats produced by Artillery CLI as TeamCity build statistics values which then can be used to build custom charts in TeamCity. Performance trending at your fingertips!

Usage

Install

npm install -g artillery-plugin-teamcity - if you've installed Artillery globally

npm install artillery-plugin-teamcity otherwise.

Use

Enable the plugin by adding it in your test script's config.plugins section:

{
  "config": {
    // ...
    "plugins": {
      "teamcity": {}
    }
  }
  // ...
}

Published metrics

By default, all stats from artillery are reported. This includes any custom stats you may have in place. As of artillery@1.5.0-17, the metrics you can expect to see are as follows.

  • scenariosCreated
  • scenariosCompleted
  • requestsCompleted
  • latency.min
  • latency.max
  • latency.median
  • latency.p95
  • latency.p99
  • rps.count
  • rps.mean
  • scenarioDuration.min
  • scenarioDuration.max
  • scenarioDuration.median
  • scenarioDuration.p95
  • scenarioDuration.p99
  • scenarioCounts.0, scenarioCounts.0 etc
  • codes.200, codes.301 etc
  • errors.ECONNREFUSED, errors.ETIMEDOUT etc
  • matches
  • concurrency
  • pendingRequests

Metrics will be added or removed based on what artillery decides to send.

If a metric is null or cannot be resolved to a number, the default value of 0 is sent. You can change the default value in the configuration by passing in the property default. Example:

"default": 100000

Metrics can be skipped by passing in an additional configuration property skipList. Skip list values can look like the following:

  • "skipList": "scenarioDuration" - would skip all scenarioDuration metrics
  • "skipList": "latency.max" - would skip only the latency.max metric
  • "skipList": "scenarioDuration, latency.max" - a comma separated list can be used to pass in multiple values.

License

Shamelessly copied most of the code from artillery-plugin-statsd

artillery-plugin-teamcity is distributed under the terms of the ISC license.