Skip to content

Echoes Prometheus alerts back into Prometheus for historical analysis

License

Notifications You must be signed in to change notification settings

observabilitystack/prometheus-alertecho

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📣 Prometheus Alertecho

A echo service for your Prometheus alert history for retrospective analysis.

flowchart LR
    prometheus(Prometheus)
    alertmanager(Alertmanager)
    alertecho[(Alertecho)]

    prometheus --> alertmanager-- Webhook -->alertecho
    prometheus -- Scrape Config -->  alertecho
Loading

Prometheus alerts are delivered to Prometheus Alertecho via the Prometheus Alertmanager. Prometheus scrapes them via a scrape config and stores them in the Prometheus data storage for in-detail analysis.

Alertecho alerts in Prometheus

🏃‍♀️ Setup

A Docker image is available at both Docker Hub and GitHub Container Registry for both arm64 and x86 architectures.

docker run -p 9095:9095 \
    ghcr.io/observabilitystack/prometheus-alertecho

The /alerts endpoint accepts Prometheus Alertmanager Webhook messages while the /metrics endpoint allows Prometheus to scrape stored alerts.

💃 Configure the Prometheus - Alertmanager - Alertecho ensemble

🗂️ The examples folder contains a working minimal setup

  1. In your Alertmanager configure Alertecho as a unfiltered receiver. This will forward all firing alerts to Alertecho.
route:
  receiver: alertecho
receivers:
  - name: alertecho
    webhook_configs:
      - send_resolved: true
        url: http://alertecho:9095/alerts
  1. In your Prometheus scrape configuration add a job to scrape firing and resolved alerts from Alertecho.
- job_name: alertecho
  static_configs:
    - targets:
        - alertecho:9095
  1. In your Prometheus you will now find alertecho_alerts metrics with all labels from the original firing alert. Use these for historical analysis of outages and alert escalation.

📦 Building locally

We use a Docker builder pattern and graalvm-maven-builder to build a native image.

docker build \
    -t observabilitystack/prometheus-alertecho .

📖 License

This image is licensed under MIT License