Skip to main content

A tool to create AWS CloudWatch Alarms for your resources with specified name and tags

Project description

AWS CloudWatch Alarm Craft

Need to monitor a lot of AWS resouces ?
This tool creates AWS CloudWatch Alarms for your resources with specified name and tags.

Quick Start

  1. Install python (>= 3.9), and install alarm-craft.
    pip install alarm-craft
    
  2. Create a json file like below and save it as config.json
    {
      "resources": {
        "lambda": {
          "target_resource_type": "lambda:function",
          "alarm": {
            "namespace": "AWS/Lambda",
            "metrics": ["Errors"]
          }
        }
      }
    }
    
  3. Execute the tool.
    python alarm-craft -c config.json
    
    By this execution, the alarm-craft creates Cloudwatch Alarms to detect Error for your Lambda functions.

Supported resources

The following resources are currently supported by the alarm-craft.

  • Lambda Function
  • StepFunctions State Machine
  • APIGateway REST API
  • SNS Topic
  • SQS Queue
  • EventBridge Rule

Filtering resources

  • The alarming target can be filtered by name and/or tags.
       "lambda": {
            "target_resource_name_pattern": "^myproj-(dev|prod)-",
            "target_resource_tags": {
                "Owner": "mydivision"
            },
            ... (omit)
       }
    

Configure more

See config-min-sample.json for above simple case or config-sample.json for more complex case. For complete configuration specification, refer Wiki/Configuration.

Usage

See Wiki.

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

alarm-craft-0.2.3.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

alarm_craft-0.2.3-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file alarm-craft-0.2.3.tar.gz.

File metadata

  • Download URL: alarm-craft-0.2.3.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for alarm-craft-0.2.3.tar.gz
Algorithm Hash digest
SHA256 64ba87a57be194dd139d313f3b35de63cfc6a4495bbc530fb106f89b339ffbc8
MD5 2a03cf62b491cb35669537774dd194b3
BLAKE2b-256 045f7ec7ab88d6ef309f2bc675afb6baf5606f15eef42de9a3987bc2c44194eb

See more details on using hashes here.

File details

Details for the file alarm_craft-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: alarm_craft-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for alarm_craft-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 339c0d2d0e81da1df68f29499745d1ac07a20f85536f716b621b2fdff98cd650
MD5 c8c861a48332f3251857960fc2767049
BLAKE2b-256 b99dd6177f3edffb02bb1ae9b12f8a267bda2534fbd8edc63739df5005570817

See more details on using hashes here.

Supported by

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