Skip to content
Dev Tools for the Serverless World
JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
website
.eslintrc.js
.gitignore
.npmignore
LICENSE
README.md
constants.js
demo.png
index.js
package.json
yarn.lock

README.md

sls-dev-tools

The Dev Tools for the Serverless World

Docs Site

demo

Documentation

To Run

  • npm install -g sls-dev-tools
  • Run sls-dev-tools -n {YOUR_STACK_NAME} -r {YOUR_REGION} [-t {START_TIME}] [-p {PERIOD}]
    • The start time defines when you want your graphs to start from, and the date format for the start time is YYYY-MM-DD/HH:mm
    • The period defines the size of the buckets in seconds. This means if you give a period of 3600, the line graph will group the invocations and errors into 1h chunks, and the bar chart will show the average response time over the hour for the last 6 hours during which invocations were made.
    • To get the stack name, log on to AWS cloudformation and it is shown in the overview section of stack info. It may not be what you expected e.g. it might have -dev on the end, so worth checking if the dev tools are not working.
    • The region is the AWS region, for example, us-east-1.
  • Choose a function with the arrow keys, and press enter to see the metrics for that function.
    • If you get an AccessDenied error in which case you must add the GetMetricData permission from CloudWatch in the IAM console on AWS.
    • If you're not seeing any data in the graphs, try changing your start date to make sure you have had invocations since then.
  • The line graph shows the number of invocations and errors that occurred within the time period.
  • The bar chart shows the average response time of the invocations within the last 6 time periods that had some invocations.
Options:
  -V, --version                 output the version number
  -n, --stack-name <stackName>  AWS stack name
  -r, --region <region>         AWS region
  -t, --start-time <startTime>  when to start from
  -p, --period <period>         precision of graphs, in seconds
  -h, --help                    output usage information

A note on AWS API calls and pricing

This tool does make use of the AWS API to get metrics. Authentication is handled implicitly via the AWS NodeJS SDK. Pricing around Cloudwatch is designed for scale, but be warned that this tool is making calls to AWS.

Full details on AWS API pricing can be found here:

For instance, the cost of GetMetricData as of 25/08/19 was $0.01 per 1,000 metrics requested.

  • This tool take no liability in pricing data provided and please use AWS's docs to ensure pricing is appropriate for you.

The current list of calls made by the tool:

  • CloudFormation: listStackResources
  • CloudWatch: getMetricData
  • More may be added, check code for full list

Libs

Heavily based off the amazing blessed and blessed-contrib projects.

Core Team

Ben Ellerby Abbie Howell Rob Cronin
Ben Ellerby Abbie Howell Rob Cronin
You can’t perform that action at this time.