Skip to main content

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

Project description

alarm-craft for AWS CloudWatch Alarms

Python - Version PyPI - Version PyPI - License CI for alarm-craft aws cloudwatch


alarm-craft logos

With modern architectures such as serverless and microservices, the number of resources managed in the cloud tends to increase, making monitoring a challenging task. alarm-craft is a tool designed to address this problem.

Features

  • Bulk Generation: Generates the necessary monitoring alarms in bulk with a single command.
  • Flexible Alarm Definition: Allows flexible definition of alarm conditions, including metrics and thresholds.
  • Declarative Config: Provides declarative configurations for monitoring targets using resource name or tag.
  • Integration with Your Deployment Pipeline: A CLI tool written in Python that can be seamlessly integrated into the deployment pipeline.
  • DevOps: By leveraging declarative configurations based on the tag strategy and integrating alarm-craft with the deployment pipeline, DevOps teams can automatically monitor newly deployed resources.

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 alarm-config.yaml
    resources:
      lambda:
        target_resource_type: "lambda:function"
        alarm:
          metrics:
            - Errors
    
  3. Execute the tool.
    alarm-craft
    
    By this execution, the alarm-craft creates Cloudwatch Alarms to detect Errors in all Lambda functions.

Documentation

For detailed instructions and information on configuring the tool, refer to the 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-1.0.1.tar.gz (69.0 kB view details)

Uploaded Source

Built Distribution

alarm_craft-1.0.1-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file alarm_craft-1.0.1.tar.gz.

File metadata

  • Download URL: alarm_craft-1.0.1.tar.gz
  • Upload date:
  • Size: 69.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.17

File hashes

Hashes for alarm_craft-1.0.1.tar.gz
Algorithm Hash digest
SHA256 a26bcab866e52c7f592b2fe6c47cf8aee3d584b34ae5fdcc8c92cec8cc97701d
MD5 75096b95ecd58bb6b831b0a5d48aa3c7
BLAKE2b-256 e44f4ba2d62e31f630e15bfee51565094917d33fa54fe05be35f3710980377e7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for alarm_craft-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f084cca491f5af8206034952461a1169b4d4717a97c147392bed8b1df2a170a3
MD5 5e3bb7fd7daa51e9c903850f115a4c92
BLAKE2b-256 98e3e18a62db1a8ad1c87ec2e78e3e273f44ab4f274a416a9fab50ae61830a39

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