CloudWatch

This reporter supports sending metrics and traces to CloudWatch (opens in a new tab).

In order to enable the Cloudwatch reporter set type to cloudwatch, and region to the AWS region that you want metrics to be sent to:

config:
  plugins:
    publish-metrics:
      - type: cloudwatch
        region: eu-west-1

Metrics

By default, all Artillery metrics will be sent to CloudWatch. Each Artillery metric will create a custom CloudWatch metric (opens in a new tab), which incur extra AWS fee for each metric. You can configure a specific list of metrics to send with the includeOnly setting (see Configuration section below).

You can learn more about AWS CloudWatch custom metric pricing in this blog post from Vantage.sh: https://www.vantage.sh/blog/cloudwatch-metrics-pricing-explained-in-plain-english (opens in a new tab)

Configuration options

config:
  plugins:
    publish-metrics:
      - type: cloudwatch
        region: us-east-1
        namespace: continous-testing
        dimensions:
          - name: Team
            value: SQA
          - name: Service
            value: checkout-svc

Traces

Powered by: OpenTelemetry reporter

With the CloudWatch reporter you can also send traces to AWS X-Ray (opens in a new tab). Tracing is available for both HTTP and Playwright engines, 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 AWS X-Ray.

Configuration options

CloudWatch requires a running instance of the CloudWatch Agent (opens in a new tab) (or the AWS Distro for OpenTelemetry (opens in a new tab)) in order to ingest traces. When you run a test on AWS Fargate, Artillery will take care of this for you automatically, but for testing on your local machine you will need to run the agent yourself.
Note: AWS Lambda is not currently supported.

plugins:
  publish-metrics:
    - type: 'cloudwatch'
      traces:
        sampleRate: 0.5
        replaceSpanNameRegex:
          - pattern: get_user_[a-zA-Z0-9]+
            as: get_user_id
        annotations:
          testType: LoadTest
          tool: Artillery

AWS Fargate - additional setup

Artillery sets up the AWS Distro for OpenTelemetry (opens in a new tab) configured with the AWS X-Ray exporter as a sidecar container.

To run the test run:

artillery run-fargate scenario.yaml

Local runs - additional setup

You'll need to install and configure a CloudWatch Agent (opens in a new tab) or AWS Distro for OpenTelemetry (opens in a new tab) to ingest OTLP traces:

CloudWatch Agent

• You can find the installation instructions for the CloudWatch Agent here (opens in a new tab), and for the configuration here (opens in a new tab).
• The agent's IAM role or IAM user must have the AWSXrayWriteOnlyAccess policy to send trace data to AWS X-Ray. For more information, see Create IAM roles and users for use with CloudWatch agent (opens in a new tab)].
• To configure the agent to receive traces from Artillery set up the otlp receiver in the CloudWatch Agent configuration file as follows:

"traces": {
  "traces_collected": {
    "otlp": {}
  }
}

AWS Distro for OpenTelemetry

• You can find the installation and configuration instructions here (opens in a new tab).

Debugging

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

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

Examples

config:
  plugins:
    publish-metrics:
      - type: cloudwatch
        region: us-east-1
        namespace: continous-testing
        dimensions:
          - name: Team
            value: SQA
        traces:
          serviceName: my-service
          useRequestNames: true
          annotations:
            testType: LoadTest
            tool: Artillery