npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tmclnk/newman-reporter-cloudwatch-metrics

v1.1.1

Published

Exports AWS Cloudwatch Metrics events

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

tmclnktmclnk

Keywords

newmanpostmancloudwatch

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.

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-<dimension-name>. Any dashes in the name will be removed an the exported metric name will be CamelCased.

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