Metadata-Version: 2.1
Name: alarm-craft
Version: 0.2.2
Summary: A tool to create AWS CloudWatch Alarms for your resources with specified name and tags
Author-email: Ryo Murai <murai.ry@gmail.com>
Project-URL: Homepage, https://github.com/ryo-murai/alarm-craft
Project-URL: Issues, https://github.com/ryo-murai/alarm-craft/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boto3==1.34.3
Requires-Dist: botocore==1.34.3
Requires-Dist: jsonschema==4.20.0

# AWS CloudWatch Alarm Craft

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

## Quick Start
1. Install python (>= 3.9), and install `alarm-craft`.
    ```bash
    pip install alarm-craft
    ```
1. Execute the tool.
    ```bash
    python -m alarm-craft -c config-min-sample.json
    ```
By this execution, the `alarm-craft` creates Cloudwatch Alarms for your Lambda functions tagged `division: alpha`. The following alarms would be created if your lambda function exists.
* myproj-cw-metric-alarm-autogen-_<name_of_funcion>_-Errors
* myproj-cw-metric-alarm-autogen-_<name_of_funcion>_-Throttled

The prefix of alarm name, target resource, its tags/names and others can be configured by json file. See [config-min-sample.json](config-min-sample.json) for above simple case or [config-sample.json](config-sample.json) for more complex case. For complete configuration file specification, refer [Wiki/Configuration](https://github.com/ryo-murai/alarm-craft/wiki/Configuration).


## Usage

See [Wiki](https://github.com/ryo-murai/alarm-craft/wiki).
