API Loki Alerts Observability

Voraussetzungen

1. Sie haben eine STACKIT Observability-Instanz mit Loki erstellt.
2. Sie sind mit der Erstellung von Alerts via API vertraut.
3. Ihr Alertmanager ist freigegeben.
4. Sie verfügen über API-Zugangsdaten.
5. Observability-API-Zugriff.

So erstellen Sie Loki-Alerts mit einer neuen Alert-Gruppe

Um eine neue Loki-Alert-Gruppe zu erstellen, können Sie eine HTTP-POST-Anfrage an die folgende URL senden: https://argus.api.eu01.stackit.cloud/v1/projects/[projectId]/instances/[instanceId]/logs-alertgroups.

Sie müssen Ihre Projekt-ID und die ID der Observability-Instanz angeben.

Es folgt ein Beispiel für einen Anfrage-Body zur Erstellung einer neuen Loki-Alert-Gruppe:

Beispiel für einen Anfrage-Body

{
 "name": "YourAlertGroupName",
 "interval": "30m",
 "rules": [
 {
 "alert": "error",
 "expr": "count_over_time({app=\"yourAppName\", severity=\"critical\"} |~ \".*error*\"[5m]) > 25",
 "for": "0m",
 "labels": {
 "app": "yourAppName",
 "project_name": "yourProjectName",
 "id": "yourAppId",
 "severity": "critical"
 },
 "annotations": {
 "summary": "To many errors are coming frequently!"
 }
 }
 ]
}

Um die Loki-Alert-Gruppe aus dem obigen Beispiel zu erstellen, würden Sie die folgende HTTP-Anfrage absetzen:

curl -X POST "https://argus.api.eu01.stackit.cloud/v1/projects/$PROJECT_ID/instances/$INSTANCE_ID/logs-alertgroups"
-H "accept: application/json" \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"YourAlertGroupName","interval":"30m","rules":[{"alert":"error","expr":"count_over_time({app=\"yourAppName\", severity=\"critical\"} |~ \".*error*\"[5m]) > 25","for":"0m","labels":{"app":"yourAppName","project_name":"yourProjectName","id":"yourAppId","severity":"critical"},"annotations":{"summary":"To many errors are coming frequently!"}}]}'

Überprüfung der Erstellung von Loki-Alert-Gruppen und Loki-Alert-Rules

Sie können die Erstellung Ihrer Loki-Alert-Gruppe und der Alert-Rules überprüfen, indem Sie eine HTTP-GET-Anfrage an die folgende API stellen: https://argus.api.eu01.stackit.cloud/v1/projects/[projectId]/instances/[instanceId]/logs-alertgroups.

Sie müssen Ihre Projekt-ID und die ID der Observability-Instanz angeben.

So erstellen Sie Loki-Alerts mit einer bestehenden Alert-Gruppe

1. Sie müssen die bereits vorhandenen Informationen abrufen, indem Sie https://docs.api.eu01.stackit.cloud/documentation/argus#tag/logs/operation/v1%5Fprojects%5Finstances%5Flogs-alertgroups%5Fread aufrufen.
   1. Kopieren Sie die Informationen, die Sie durch die Anfrage erhalten haben (falls diese erfolgreich war).
2. Um einen neuen Alert hinzuzufügen, rufen Sie einfach https://docs.api.eu01.stackit.cloud/documentation/argus#tag/logs/operation/v1%5Fprojects%5Finstances%5Flogs-alertgroups%5Fupdate auf.
   1. Fügen Sie den Body ein, den Sie in Schritt eins kopiert haben.
   2. Fügen Sie die neue Regel zu dieser Gruppe hinzu.
   3. Senden Sie die Anfrage ab.