Skip to main content

A script and python module to check your AWS service limits and usage, and warn when usage approaches limits.

Project description

PyPi package version PyPi downloads GitHub Forks GitHub Open Issues Project Status: Active - The project has reached a stable, usable state and is being actively developed. gitter.im chat

Master:

travis-ci for master branch coverage report for master branch sphinx documentation for latest release

Develop:

travis-ci for develop branch coverage report for develop branch sphinx documentation for develop branch

A script and python module to check your AWS service limits and usage, and warn when usage approaches limits.

Users building out scalable services in Amazon AWS often run into AWS’ service limits - often at the least convenient time (i.e. mid-deploy or when autoscaling fails). Amazon’s Trusted Advisor can help this, but even the version that comes with Business and Enterprise support only monitors a small subset of AWS limits and only alerts weekly. The new Service Quotas service can also help with this, but relies on CloudWatch alarms per-limit to notify you when you approach your limits; this cannot easily scale to the hundreds of current service limits. awslimitchecker provides a command line script and reusable Python package that queries your current usage of AWS resources and compares it to limits (hard-coded AWS defaults that you can override, API-based limits where available, Service Quotas data where available, or data from Trusted Advisor where available), notifying you when you are approaching or at your limits.

Full project documentation for the latest release is available at http://awslimitchecker.readthedocs.io/en/latest/.

Status

awslimitchecker is mature software, with approximately 13,000 downloads per month and in daily use at numerous organizations.

Development status is being tracked on a board at waffle.io: https://waffle.io/jantman/awslimitchecker

What It Does

  • Check current AWS resource usage against AWS Service Limits

  • Show and inspect current usage

  • Override default Service Limits (for accounts with increased limits)

  • Compare current usage to limits; return information about limits that exceed thresholds, and (CLI wrapper) exit non-0 if thresholds are exceeded

  • Define custom thresholds per-limit

  • where possible, pull current limits from Trusted Advisor API

  • where possible, pull current limits from each service’s API (for services that provide this information)

  • where possible, pull current limits from the Service Quotas service

  • Supports explicitly setting the AWS region

  • Supports using STS to assume roles in other accounts, including using external_id.

  • Optionally refresh Trusted Advisor “Service Limits” check before polling Trusted Advisor data, and optionally wait for the refresh to complete (up to an optional maximum time limit). See Getting Started - Trusted Advisor for more information.

  • Optionally send current usage and limit metrics to a metrics store, such as Datadog.

  • Optionally send warning/critical alerts to notification providers, such as PagerDuty.

Requirements

Either Docker in order to run via the docker image, or:

  • Python 3.5 or newer. Python 2.7 will not be supported as of January 1, 2010.

  • Python VirtualEnv and pip (recommended installation method; your OS/distribution should have packages for these)

  • boto3 >= 1.4.6 and its dependency botocore >= 1.6.0.

Installation and Usage

See Getting Started.

Credentials

See Credentials.

Getting Help and Asking Questions

See Getting Help.

For paid support and development options, please see the Enterprise Support Agreements and Contract Development section of the documentation.

There is also a gitter.im chat channel for support and discussion.

Changelog

See Changelog.

Contributions

Pull requests are most definitely welcome. Please cut them against the develop branch. For more information, see the development documentation. I’m also happy to accept contributions in the form of bug reports, feature requests, testing, etc.

License

awslimitchecker is licensed under the GNU Affero General Public License, version 3 or later. This shouldn’t be much of a concern to most people; see Development / AGPL for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

awslimitchecker-8.0.1.tar.gz (178.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

awslimitchecker-8.0.1-py2.py3-none-any.whl (265.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file awslimitchecker-8.0.1.tar.gz.

File metadata

  • Download URL: awslimitchecker-8.0.1.tar.gz
  • Upload date:
  • Size: 178.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.8.1

File hashes

Hashes for awslimitchecker-8.0.1.tar.gz
Algorithm Hash digest
SHA256 1a6b7301db243d81859850b50ef6e55b657c4dfe4fa2454ade78ef4cef310472
MD5 d475bfde8d32267b568bed5848931ac8
BLAKE2b-256 46e57a74036f6ef56e68e2d66e334de88a63549e9e6d9d39e097383a195c9cb1

See more details on using hashes here.

File details

Details for the file awslimitchecker-8.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: awslimitchecker-8.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 265.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.8.1

File hashes

Hashes for awslimitchecker-8.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7251e000fa7dab2264e05b4ceb43d5ec21101bb739d30ce4a1abeb35d31718c0
MD5 bc15d87494da2e341f7f16777322db3e
BLAKE2b-256 ffe19647293effc24ecd4707026763fa4cbc0b8c6c8d4a93760b91fef2ca0d73

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page