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
  --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
  --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

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.2.2.tar.gz (144.4 kB view details)

Uploaded Source

Built Distribution

alert_exporter-0.2.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: alert_exporter-0.2.2.tar.gz
  • Upload date:
  • Size: 144.4 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.2.2.tar.gz
Algorithm Hash digest
SHA256 e69c63b5808ad1e0513b3d78d8d1186594a1a7d8adff5929a0b6377521d5025b
MD5 11081c4a7e9d7d5274fba77f7472e42c
BLAKE2b-256 74115407e2d1cb885a5fbf7e0979a54c79c39dc99f8cf0c87d3078073bf7bf0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for alert_exporter-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 48666a869be24d1354cad097949590bede9d56ddcc6b57cac5ca5192cb775c9a
MD5 6977510f348225bf30dcf4a478032f59
BLAKE2b-256 ebc931dc6ad1b43bd9145ad017a8396c17ceca45ee084584539af85703ca6539

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