Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tmclnk/newman-reporter-cloudwatch-metrics
Reports postman collection run statistics as Amazon CloudWatch Metrics
https://github.com/tmclnk/newman-reporter-cloudwatch-metrics
Last synced: about 1 month ago
JSON representation
Reports postman collection run statistics as Amazon CloudWatch Metrics
- Host: GitHub
- URL: https://github.com/tmclnk/newman-reporter-cloudwatch-metrics
- Owner: tmclnk
- Created: 2021-06-10T16:05:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-06-11T17:14:38.000Z (over 3 years ago)
- Last Synced: 2024-11-06T16:57:06.291Z (3 months ago)
- Language: JavaScript
- Size: 195 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Amazon CloudWatch Metrics Reporter
This package will export Amazon CloudWatch metrics. There will
be 3 metrics:
| Metric Name | Description |
|-|-|
| PassedAssertions | Number of passed ChaiJS assertions in the Collection |
| FaildAssertions | Number of failed ChaiJS assertions in the Collection |
| ResponseTime | Overall response time for the Collection |
These will be reported on a per-collection-run basis.
You can specify arbitrary dimensions for your metrics using any number of
`--reporter-cloudwatch-metrics-dimension=MyDimension` params.
## Requirements
* AWS Credentials
* newman
## Rationale - Continuous Testing
Postman is great for quickly writing tests against API's. It lets us centralize
authentication logic, seamlessly handles cookies, has built-in testing, and
good support for externalizing Environment variables.
So good, in fact, that we sometimes want to just put our assertions on blast so that
we quickly know if they are failing, or if we have something misconfigured. We already
use CloudWatch Alarms to detect performance issues, so why not go one level higher
and start continuously testing?
We can use the Postman tests we are writing anyway to act as a rudimentary integration
test. Something between the unit tests and the functional tests written by QA.
## Usage
If newman is installed globally, you'll need to install the module globally. You will
also need AWS Credentials with `cloudwatch:PutMetricData` permission.
```sh
npm i -g newman
npm i -g @tmclnk/newman-reporter-cloudwatch-metrics
newman run https://raw.githubusercontent.com/tmclnk/newman-reporter-cloudwatch-metrics/master/examples/cloudwatch-example.postman_collection.json \
--reporters cli,@tmclnk/cloudwatch-metrics
```
### Specifying Metric Dimensions
You can add arbitrary dimensions to the output using `--reporter-cloudwatch-metrics-dimension-`.
Any dashes in the name will be removed an the exported metric name will be CamelCased.
```sh
newman run https://raw.githubusercontent.com/tmclnk/newman-reporter-cloudwatch-metrics/master/examples/cloudwatch-example.postman_collection.json \
--reporters @tmclnk/cloudwatch-metrics \
--reporter-cloudwatch-metrics-dimension-environment=dev \
--reporter-cloudwatch-metrics-dimension-pod=a
```
Think carefully when specifying dimensions! They will very quickly pollute your
CloudWatch Metrics namespace, and they can't be removed. Additionally, you will be billed
by AWS on a per-metric basis, so being very fine grained could increase your AWS costs.
### AWS Credentials
We are using the AWS Javascript SDK, so any form of credential recognized there will
be recognized from newman as well. I have successfully tested using `~/.aws/credentials`,
`AWS_ACCESS_KEY_ID`/`AWS_SECRET_ACCESS_KEY`, and ECS Task Roles.
## Related Links
* [newman-reporter-cloudwatch-metrics node module](https://www.npmjs.com/package/@tmclnk/newman-reporter-cloudwatch-metrics)
* [Postman](https://www.postman.com/)
* [newman](https://github.com/postmanlabs/newman)
* [newman-reporter-html](https://github.com/postmanlabs/newman-reporter-html)
* [Amazon CloudWatch Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/working_with_metrics.html)
* [semantic-release](https://github.com/semantic-release/semantic-release)