artillery-plugin-aws-sigv4/README.md

A plugin for artillery.io that add an authentication header to every request that conforms to V4 of the AWS Signature Specification. See https://github.com/shoreditch-ops/artillery. Also see http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.htm

# artillery-plugin-aws-sigv4
A plugin for artillery.io that signs HTTP requests using the AWS Signature V4 specification.

To use:

1. `npm install -g artillery`
2. `npm install artillery-plugin-aws-sigv4`
3. Add `aws-sigv4` plugin config to your "`hello.json`" Artillery script

    ```json
    {
      "config": {
        "plugins": {
          "aws-sigv4": {
             "serviceName": "execute-api"
           }
        }
      },
      "scenarios": [
        {
          "beforeRequest": "addAmazonSignatureV4"
        }
      ]
    }
    ```

4. `artillery run hello.json`

This will add an authentication header to every request that conforms to V4 of the AWS Signature Specification.

For more information, see:

* https://github.com/shoreditch-ops/artillery
* http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html

Enjoy!