alertalot 0.1.0

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

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

Task	Command
Run Unit Tests with Coverage	pytest --cov=alertalot --cov-report=html --cov-branch
Lint Alertalot Code	pylint alertalot --rcfile=.pylintrc --fail-under=10
Lint Test Code	pylint tests --rcfile=tests/.pylintrc --fail-under=10

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

Option	Description
--instance-id	ID of an EC2 instance to generate the alerts for
--params-file	Relative path to the parameters file to use (see examples/params.yaml)
--template-file	Relative path to the template file to use (see examples/ec2-application.yaml)
--region	The AWS region to use
--dry-run	Simulate the requests without executing them
-v, --verbose	Enable verbose output to show details about executed actions

Special Actions

Action	Description
--show-parameters, --show-params	Only loads the parameters file and outputs the result. Parameters for the specified region will be merged with global parameters.
--test-aws	Only checks if AWS is accessible by calling sts:GetCallerIdentity. Use with --verbose to see detailed output.
--show-instance	Loads and describes the target instance. Requires a valid instance ID.

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