Prometheus

In this example you are going to create a webhook integration between Prometheus Alertmanager and Port, which will ingest alert entities.

Port configuration

Create the following blueprint definition:

Alert blueprint

{
  "identifier": "prometheusAlerts",
  "description": "Prometheus alerts in your software catalog",
  "title": "Prometheus Alerts",
  "icon": "Prometheus",
  "schema": {
    "properties": {
      "status": {
        "title": "Status",
        "description": "Current status of the alert, firing or resolved",
        "type": "string",
        "enum": ["firing", "resolved"],
        "enumColors": {
          "firing": "red",
          "resolved": "green"
        }
      },
      "labels": {
        "title": "Labels",
        "type": "object",
        "description": "Labels that are part of this alert, map of string keys to string values"
      },
      "createdAt": {
        "title": "Created at",
        "description": "Start time of the alert",
        "type": "string",
        "format": "date-time"
      },
      "resolvedAt": {
        "title": "Resolved At",
        "type": "string",
        "description": "End time of the alert",
        "format": "date-time"
      },
      "generatorURL": {
        "title": "Generator URL",
        "type": "string",
        "description": "URL of the alert rule in the Prometheus UI",
        "format": "url"
      },
      "fingerprint": {
        "title": "Fingerprint",
        "description": "The labels fingerprint, alarms with the same labels will have the same fingerprint",
        "type": "string"
      },
      "summary": {
        "title": "Summary",
        "type": "string"
      },
      "severity": {
        "title": "Severity",
        "type": "string",
        "enum": [
          "indeterminate",
          "information",
          "warning",
          "minor",
          "major",
          "critical",
          "fatal"
        ],
        "enumColors": {
          "indeterminate": "purple",
          "information": "blue",
          "warning": "yellow",
          "minor": "lightGray",
          "major": "pink",
          "critical": "red",
          "fatal": "red"
        }
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {}
}

Create the following webhook configuration using Port's UI

Alert webhook configuration

1. Basic details tab - fill the following details:

   1. Title : Prometheus Alert Mapper;
   2. Identifier : prometheus_alert_mapper;
   3. Description : A webhook configuration to map Prometheus alerts to Port;
   4. Icon : Prometheus;

2. Integration configuration tab - fill the following JQ mapping:

   [
     {
       "blueprint": "prometheusAlerts",
       "filter": "true",
       "itemsToParse": ".body.alerts",
       "entity": {
         "identifier": ".item.labels.alertname + \"-\" + .item.fingerprint | gsub(\"[^a-zA-Z0-9@_.:/=-]\"; \"-\") | tostring",
         "title": ".item.labels.alertname",
         "properties": {
           "status": ".item.status",
           "severity": ".item.labels.severity",
           "labels": ".item.labels",
           "summary": ".item.annotations.summary",
           "createdAt": ".item.startsAt",
           "resolvedAt": ".item.endsAt",
           "generatorURL": "if .item.generatorURL != \"\" then .item.generatorURL else null end",
           "fingerprint": ".item.fingerprint"
         }
       }
     }
   ]

3. Click Save at the bottom of the page.

Configure Alertmanager to send webhook

1. Ensure you have the Prometheus Alertmanager installed as described in prometheus/alertmanager;

2. Configure the Alertmanager to send alert information from your server to Port. Edit your Alertmanager configuration file (alertmanager.yaml) to add the generated webhook from Port as a receivers;

   1. Create a new receivers object called port_webhook. Paste the webhook URL into the url field and set the send_resolved value to true.
   2. Add the port_webhook receivers to the route object;
   Example configuration file.

   global:
     resolve_timeout: 20s
   
   route:
     group_wait: 30s
     group_interval: 5m
     repeat_interval: 3h
     receiver: port_webhook
   
   receivers:
    - name: port_webhook
    webhook_configs:
    - url: https://port-webhook-url
       send_resolved: true

3. Save the alertmanager.yaml file and restart the alertmanager to apply the changes.

Done! Any change that happens to your alerts in your server will trigger a webhook event to the webhook URL provided by Port. Port will parse the events according to the mapping and update the catalog entities accordingly.