Skip to main content

Extract alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, etc.)

Project description

Alert Exporter

PyPI PyPI - Python Version GitHub repo size PyPI - Status

Installation

Use the package manager pip to install alert-exporter.

pip install alert-exporter

Usage

 alert-exporter --help
Extract alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, etc.)

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  --log-level {DEBUG,INFO,WARNING,ERROR}
  -o OUTPUT_FILE, --output-file OUTPUT_FILE
  --jinja-template [JINJA_TEMPLATE]
  -f {markdown,csv,html,yaml}, --format {markdown,csv,html,yaml}
  --prometheus
  --prometheus-filters PROMETHEUS_FILTERS
  --context [CONTEXT]
  --cloudwatch
  --aws-profile AWS_PROFILE
  --aws-region AWS_REGION
                        Specific region to target. Default: Iterate over all regions available.

Multiple sources are available, one or many can be selected

Kubernetes / Prometheus

The current context is used unless you provide the --context flag.

alert-exporter -o minikube.html --prometheus --context minikube

You can filter prometheus rule to match specific labels using the '--prometheus-filters' flag.

alert-exporter -o minikube.html --prometheus --context minikube --prometheus-filters '{"severity": "critical"}'

AWS Cloudwatch

All available regions are parsed unless you provide the --aws-region flag.

You need to be authenticated before using this tool.

alert-exporter -o aws.html --cloudwatch --aws-region eu-west-1 --aws-profile profile

Multiple sources at once

alert-exporter -o combined.html --prometheus --cloudwatch --aws-region eu-west-1

Formats

Predefined formats are provided with this tool:

  • HTML
  • Markdown
  • CSV
  • YAML

You can use a custom format by providing a Jinja2 file with the --jinja-template flag.

HTML output example

HTML output

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

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

alert_exporter-0.3.1.tar.gz (145.0 kB view details)

Uploaded Source

Built Distribution

alert_exporter-0.3.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file alert_exporter-0.3.1.tar.gz.

File metadata

  • Download URL: alert_exporter-0.3.1.tar.gz
  • Upload date:
  • Size: 145.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for alert_exporter-0.3.1.tar.gz
Algorithm Hash digest
SHA256 780731ce96c589b7be8fa49a91d01fbe6976dbb7c17dd00ab483577de3d7f074
MD5 bcc1f2b9b8174d96de129bc49bad86cf
BLAKE2b-256 5e8910d1c01a9a2e222deba15f38b40bd933f5449b762d3e84fabe6ff5a5a24b

See more details on using hashes here.

File details

Details for the file alert_exporter-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for alert_exporter-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7cbdb633da9724c4d964b00763abe72c2264338e3d9b93bf22e26d6cf0c3700f
MD5 116ee636c523751ef55f4ef3e3bd92be
BLAKE2b-256 3df7516a09eab1eed5ded7f33c59a9fa45f8dc181a0f10ed3f1b1771d2abf510

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