Alertalot

Python library for creating AWS CloudWatch alerts automatically based on predefined configurations.

Running the Code

Linux

1. Clone the repository and run

   ./bin/install.sh
   

2. Optionally, run tests

   ./bin/test.sh
   

   You should see:

   ...
   ─────────────────────────────────────────────
   ✓ SUCCESS: Alertalot Pylint check passed
   ✓ SUCCESS: Unittests Pylint check passed
   ✓ SUCCESS: Unittests passed
   ─────────────────────────────────────────────
   ✓ OK!
   

Code Quality and Testing

Before running any of the following commands, ensure that your virtual environment is activated:

source ./venv/bin/activate

Test and Lint Commands

Usage

Alertalot can be run with various options to create CloudWatch alerts for AWS resources.

Basic Usage

python -m alertalot.main --instance-id i-xxxxxxxxx --vars-file examples/variables.yaml --template-file examples/ec2-application.yaml --region us-east-1

Available Options

Special Actions

Configuration Files

Parameters File

The parameters file (YAML or JSON) contains values that will be substituted in the template file:

params:
  global:
    # Global parameters used across all regions
  us-east-1:
    # Region-specific parameters
    ALARM_ACTION_ARN: "arn:aws:sns:us-east-1:aaaa:bbbb"

Template File

The template file defines the CloudWatch alarms to be created:

alarms:
  - type: ec2
    alarm-name: AWS / CPU Usage 5 minute / $INSTANCE_NAME / $INSTANCE_ID
    metric-name: CPUUtilization
    alarm-actions: $ALARM_ACTION_ARN
    statistic: Average
    period: 5 minutes
    comparison-operator: GreaterThanOrEqualToThreshold
    threshold: 70%
    evaluation-periods: 1 minute
    tags:
      level: info
    treat-missing-data: breaching