Alarme per E-Mail und Webhook senden

Ein Benachrichtigungskanal ist eine E-Mail-Adresse oder eine Webhook-URL, an die Alarmregeln ihre Benachrichtigungen senden. Kanäle gehören zu einem Projekt, und jede Regel des Projekts kann sie verwenden.

VoraussetzungenLink kopieren

• Um Kanäle hinzuzufügen, zu testen, ihr Geheimnis zu erneuern oder sie zu löschen, benötigen Sie im Projekt oder in dessen Abonnement die Rolle Besitzer oder Mitwirkender oder eine benutzerdefinierte Rolle mit der Zugriffsebene Verwalten für Observability. Mit der Zugriffsebene Lesen, wie bei der Rolle Leser, können Sie die Kanäle anzeigen, und Webhook-URLs werden auf Schema und Host gekürzt.
• Wählen Sie in der Konsole das Projekt aus, dessen Alarme Sie senden möchten. Die Kanalseite zeigt die Kanäle dieses Projekts.

Kanalseite öffnenLink kopieren

Die Seite Benachrichtigungskanäle listet jeden Kanal mit seinem Ziel und seinem Status auf.

E-Mail-Kanal hinzufügenLink kopieren

E-Mail-Adresse bestätigenLink kopieren

Eine Adresse, die einem aktiven Benutzer Ihrer Organisation gehört, gilt beim Hinzufügen als bestätigt. Jede andere Adresse erhält eine Bestätigungs-E-Mail, und der Kanal erhält keine Alarme, bis der Empfänger die Adresse bestätigt.

Der Status des Kanals zeigt den aktuellen Stand:

Um einen neuen Link zu senden, öffnen Sie das Menü Zeilenaktionen (⋯) des Kanals, und wählen Sie Bestätigung erneut senden aus. Ein neuer Link ersetzt den vorherigen.

Benachrichtigungen für eine unbestätigte Adresse werden übersprungen, nicht zurückgehalten: Die Adresse erhält sie auch nach der Bestätigung nicht.

Webhook-Kanal hinzufügenLink kopieren

Ein Webhook-Kanal gilt beim Hinzufügen als bestätigt. Seine URL muss diese Regeln erfüllen:

• Sie verwendet https:// und hat höchstens 2.048 Zeichen.
• Sie enthält keinen Benutzernamen und kein Passwort.
• Ihr Host wird nur in öffentliche IP-Adressen aufgelöst. Private, Loopback-, Link-Local- und andere nicht öffentliche Adressbereiche werden abgelehnt. Die Plattform prüft den Host bei jedem Senden und lehnt beim Hinzufügen des Kanals eine nicht öffentliche IP-Adresse ab, die in der URL steht.

Die Plattform folgt keinen Weiterleitungen.

Webhook-Anfragen prüfenLink kopieren

Die Plattform sendet jede Benachrichtigung als HTTPS-Anfrage mit der Methode POST, einem JSON-Body und diesen Headern:

Im Signatur-Header ist <timestamp> die Sendezeit in Unix-Sekunden, und <signature> ist der hexadezimal codierte HMAC-SHA256 von <timestamp>.<body>, berechnet mit dem Signaturgeheimnis des Kanals als Schlüssel. Um eine Anfrage zu prüfen, berechnen Sie denselben HMAC über den unveränderten Anfrage-Body, so wie er empfangen wurde, und vergleichen Sie ihn mit v1. Um wiederholt eingespielte Anfragen abzuwehren, lehnen Sie außerdem Anfragen ab, deren Zeitstempel älter als eine von Ihnen gewählte Toleranz ist.

import hashlib
import hmac
import time

def verify(secret: str, header: str, body: bytes, tolerance: int = 300) -> bool:
    fields = dict(item.split("=", 1) for item in header.split(","))
    timestamp = int(fields["t"])
    expected = hmac.new(
        secret.encode(), f"{timestamp}.".encode() + body, hashlib.sha256
    ).hexdigest()
    fresh = abs(time.time() - timestamp) <= tolerance
    return fresh and hmac.compare_digest(expected, fields["v1"])

secret ist das vollständige Signaturgeheimnis einschließlich seines Präfixes whsec_. header ist der Wert von X-Publiccloud-Signature, und body ist der unveränderte Anfrage-Body.

Der Body hat diese Felder:

Zustellung von BenachrichtigungenLink kopieren

Antworten Sie innerhalb von 10 Sekunden mit einem Statuscode 2xx. Die Plattform gibt eine Anfrage nach insgesamt 15 Sekunden auf.

Während eine Benachrichtigung auf einen erneuten Versuch wartet, warten spätere Benachrichtigungen derselben Regel an denselben Kanal dahinter, sodass sie in der richtigen Reihenfolge ankommen. E-Mails folgen denselben Wiederholungen, wenn das Mail-Relay fehlschlägt.

E-Mail-Benachrichtigungen. Standardmäßig besteht der Betreff aus dem neuen Status in eckigen Klammern, [FIRING] oder [RESOLVED], gefolgt vom Regelnamen und der Instanz. Ein Test hat [TEST]. Diese Kennzeichnungen werden nicht übersetzt, sodass Sie Ihren Posteingang danach filtern können. Der Text nennt die Änderung, den Wert, die Instanz, das Projekt und die Uhrzeit. Die Sprache der E-Mail wird beim Hinzufügen des Kanals festgelegt, und zwar anhand der Spracheinstellung des Browsers, mit dem er hinzugefügt wurde, ersatzweise auf Englisch.

Testbenachrichtigung sendenLink kopieren

Die Plattform sendet den Test sofort, ohne Wiederholungen:

• Testbenachrichtigung zugestellt. Das Ziel hat sie angenommen.
• Nicht gesendet: Die Adresse ist noch nicht bestätigt. Bestätigen Sie zuerst die Adresse.
• Bei einem Fehler nennt die Meldung den Grund. Siehe Problembehandlung.

Sie können pro Kanal alle 60 Sekunden einen Test senden.

Signaturgeheimnis erneuernLink kopieren

Das alte Geheimnis signiert sofort nicht mehr, sodass Anfragen die Prüfung Ihres Empfängers nicht bestehen, bis er das neue Geheimnis hat. Um den Signaturschlüssel eines Webhook-Kanals zu erhalten, den ein Budget erstellt hat, erneuern Sie ihn im Dialog Bearbeiten des Budgets. Siehe Budget bearbeiten oder löschen.

Kanal löschenLink kopieren

Jede Regel, die den Kanal aufgeführt hat, benachrichtigt ihn nicht mehr, und die Adresse oder URL des Kanals wird gelöscht. Einen gelöschten Kanal können Sie nicht wiederherstellen.

Ein Kanal mit der Kennzeichnung Von einem Budget verwaltet folgt dem Alarmempfänger eines Budgets, und Sie können ihn hier nicht löschen. Ändern Sie stattdessen das Budget. Siehe Budgets und Schwellenwertalarme erstellen.

ErgebnisLink kopieren

Der Kanal erscheint in der Liste. Sobald sein Status Bestätigt ist, erhält er die Benachrichtigungen jeder Regel, die ihn aufführt. Wie Sie einer Regel einen Kanal hinzufügen, erfahren Sie unter Alarmregeln erstellen.

LimitsLink kopieren

ProblembehandlungLink kopieren

Wenn ein Test fehlschlägt, nennt die Meldung einen dieser Gründe:

Zugehöriger InhaltLink kopieren

• Alarmregeln erstellen
• Was ist Monitoring & Alerts?
• Budgets und Schwellenwertalarme erstellen
• Informationen zum Verwalten von Kanälen über die REST-API finden Sie unter POST/scopes/{scopeId}/observability/notification-channels.