Prometheus Integration

Overview

Prometheus is an open-source systems monitoring and alerting toolkit that collects metrics from configured targets, evaluates alert rules, and routes firing alerts to an external Alertmanager. When a rule condition is breached, Alertmanager groups and delivers a structured webhook payload to the platform.

This integration supports automatic alert creation on firing events and automatic resolution when Alertmanager sends a resolved notification.

Integration Flow

  1. Prometheus scrapes metrics from configured targets at a defined interval.

  2. Prometheus evaluates alert rules continuously. When a condition is met, it sends the alert to Alertmanager.

  3. Alertmanager groups the alerts and delivers a webhook POST request to the platform endpoint.

  4. When the alert condition clears, Alertmanager sends a resolved notification and the platform automatically closes the alert.

Webhook Payload Schema

The payload delivered to the platform follows the standard Prometheus Alertmanager webhook format (version 4).

{
  "receiver": "string",
  "status": "firing | resolved",
  "alerts": [
    {
      "status": "firing | resolved",
      "labels": {
        "alertname": "string",
        "severity": "string",
        "env": "string"
      },
      "annotations": {
        "summary": "string",
        "description": "string"
      },
      "startsAt": "ISO8601 timestamp",
      "endsAt": "ISO8601 timestamp",
      "generatorURL": "string",
      "fingerprint": "string"
    }
  ],
  "groupLabels": {},
  "commonLabels": {
    "alertname": "string",
    "severity": "string"
  },
  "commonAnnotations": {
    "summary": "string",
    "description": "string"
  },
  "externalURL": "string",
  "version": "4",
  "groupKey": "string",
  "truncatedAlerts": 0
}

Setup

Step 1 — Create an Alert Source on the Platform

  1. Navigate to SourcesAdd Source.

  2. Search for Prometheus and select it.

  3. Give the source a name and click Save.

  4. Copy the generated Webhook URL and Token.

Step 2 — Install and Configure Alertmanager

Prometheus does not deliver alerts directly to external systems. You must run a Prometheus Alertmanager instance and point Prometheus at it.

Install Alertmanager using your preferred method (binary, Docker, Helm). Then configure it to forward alerts to the platform:

alertmanager.yml

send_resolved: true is required for automatic alert resolution on the platform.

Step 3 — Configure Prometheus

Point Prometheus to your Alertmanager and define your rule files in prometheus.yml:

Step 4 — Create Alert Rules

Create rule files in the configured rule_files directory. Each file defines one or more alert groups.

Example: rules/production.yaml

The severity label in labels is used by the platform for priority mapping (see table below).

Step 5 — Verify the Integration

After starting Prometheus and Alertmanager:

  1. Open Prometheus UI at http://<prometheus-host>:9090/alerts — active alerts should appear there first.

  2. Open Alertmanager UI at http://<alertmanager-host>:9093 — confirm the alert is routed to the webhook receiver.

  3. Confirm the alert appears on the platform under the source you created.

Sample Payload

The following is a real payload captured during integration testing.

ALERT (firing):

RESOLVE (resolved):

Field Mapping Reference

Payload Field
Description

status

Top-level event type: firing → ALERT, resolved → RESOLVE

alerts[0].fingerprint

Unique identifier per alert label set — used for fingerprint matching

alerts[0].labels.alertname

Name of the alert rule that fired

alerts[0].labels.severity

Severity label from the rule definition — used for priority mapping

alerts[0].annotations.summary

Short human-readable alert title

alerts[0].annotations.description

Detailed description of the alert condition

alerts[0].startsAt

ISO 8601 timestamp when the alert started firing

alerts[0].endsAt

ISO 8601 timestamp when resolved (0001-... means still active)

commonLabels

Labels shared across all alerts in this group

commonAnnotations

Annotations shared across all alerts in this group

groupKey

Alertmanager group key used for deduplication

Priority Mapping

The platform maps the severity label from the alert rule to an internal priority level.

Prometheus severity Label

Platform Priority

critical

CRITICAL

error

HIGH

warning

MEDIUM

info

LOW

(not set)

MEDIUM (default)

You control the severity label in your alert rule definitions. Use consistent values across your rule files for predictable priority routing.

RESOLVE Detection

The platform automatically resolves an alert when Alertmanager sends a payload with "status": "resolved". This requires send_resolved: true in your Alertmanager webhook configuration (set in Step 2).

The resolved event is matched to the original alert using the fingerprint field, which Alertmanager generates deterministically from the alert's label set. As long as the labels do not change between firing and resolution, the fingerprint will match and the alert will be closed.

Last updated

Was this helpful?