Verkehrsmeldungen einrichten

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X info

Mit einer Traffic-Benachrichtigung können Sie eine Benachrichtigung auslösen, wenn sich der Traffic für eine Umgebung, einen Proxy oder eine Region innerhalb eines Zeitraums um einen bestimmten Prozentsatz ändert.

Sie legen den Zeitraum auf Folgendes fest:

  • 1 Stunde
  • 1 Tag
  • 7 Tage
  • 15 Tage (nur API)
  • 30 Tage (nur API)

Bei dieser Benachrichtigung wird der Traffic für den aktuellen Zeitraum mit dem Traffic für den vorherigen Zeitraum verglichen. Sie geben beispielsweise einen Zeitraum von einer Stunde an. Im Rahmen der Benachrichtigung wird der Traffic der letzten Stunde mit dem Traffic der vorherigen Stunde verglichen, um die prozentuale Änderung des Traffics zu berechnen:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

Ein positiver Wert bedeutet, dass die Zugriffe zugenommen haben, ein negativer Wert, dass sie abgenommen haben.

Anschließend legen Sie den Grenzwert fest, der eine Traffic-Benachrichtigung auslöst. Das erfolgt als prozentuale Steigerung oder Senkung des API-Traffics für den angegebenen Zeitraum.

Bevor Sie diesen Prozentsatz festlegen, sollten Sie prüfen, ob er mit Ihren normalen Traffic-Mustern übereinstimmt. Wenn Ihr API-Traffic beispielsweise normalerweise im Laufe des Tages schwankt und zu bestimmten Spitzenzeiten stündliche Traffic-Spitzen von bis zu 100 % auftreten, sind diese Spitzen normal und sollten keine Benachrichtigung auslösen. Wenn Sie jedoch eine Benachrichtigung konfigurieren, die bei einer Steigerung des stündlichen Traffics um 50% ausgelöst wird, erhalten Sie unnötige Benachrichtigungen für Ihren normalen Traffic.

Weitere Informationen zu Benachrichtigungen finden Sie unter Benachrichtigungen einrichten.

Verkehrsmeldungen und ‑benachrichtigungen hinzufügen

So fügen Sie Verkehrsstörungen und Benachrichtigungen hinzu:
  1. Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln.
  2. Klicken Sie auf +Benachrichtigung.
  3. Geben Sie die folgenden allgemeinen Informationen zur Benachrichtigung ein:
    Feld Beschreibung
    Name der Benachrichtigung Name der Benachrichtigung. Verwenden Sie einen Namen, der den Trigger beschreibt und für Sie aussagekräftig ist. Der Name darf nicht länger als 128 Zeichen sein.
    Beschreibung Beschreibung der Benachrichtigung.
    Benachrichtigungstyp Wählen Sie Gesamter Traffic aus. Weitere Informationen finden Sie unter Warntypen.
    Umgebung Wählen Sie die Umgebung aus der Drop-down-Liste aus.
    Status Benachrichtigung aktivieren bzw. deaktivieren.
  4. Definieren Sie den Schwellenwert und die Dimension für die Bedingung, die die Benachrichtigung auslöst.
    Bedingungsfeld Beschreibung
    Grenzwert

    Geben Sie an, dass die Benachrichtigung ausgelöst werden soll, wenn der Traffic im Vergleich zu einem vorherigen Zeitraum um einen bestimmten Prozentsatz gestiegen oder gesunken ist.

    Legen Sie den Prozentsatz für erhöht um auf einen Wert größer oder gleich 0 % fest. Legen Sie für decreased by (reduziert um) einen Wert zwischen 0 % und 100 % fest.

    Sie können ein Zeitintervall von:

    • 1 Stunde
    • 1 Tag
    • 1 Woche
    Dimension

    Klicken Sie auf + Dimension hinzufügen und geben Sie die Dimensionsdetails an, für die Ergebnisse zurückgegeben werden sollen, einschließlich des API-Proxys und der Region.

    Eine bestimmte Dimension festlegen:

    • Proxy: Legen Sie einen bestimmten Proxy oder Alle Proxys fest. Für Proxy wird der Wert Beliebig nicht unterstützt. Stattdessen können Sie für jeden Proxy, der Sie interessiert, eine separate Benachrichtigung hinzufügen.
    • Region: Legen Sie eine bestimmte Region oder Alle Regionen fest. Für Region wird kein Wert von „Beliebig“ unterstützt. Stattdessen können Sie für jede Region, die Sie interessiert, eine separate Benachrichtigung hinzufügen.
  5. Klicken Sie auf + Benachrichtigung, um eine Benachrichtigung hinzuzufügen.
    Benachrichtigungsdetails Beschreibung
    Kanal Wählen Sie den zu verwendenden Benachrichtigungskanal aus und geben Sie das Ziel an: E-Mail, Slack, PagerDuty oder Webhook.
    Ziel Geben Sie das Ziel basierend auf dem ausgewählten Kanaltyp an:
    • E-Mail – E-Mail-Adresse wie [email protected]
    • Slack – Slack-Kanal-URL, z. B. https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – PagerDuty-Code, z. B. abcd1234efgh56789
    • Webhook – Webhook-URL, z. B. https://apigee.com/test-webhook

      Hinweis: Sie können nur ein Ziel pro Benachrichtigung angeben. Wenn Sie mehrere Ziele für denselben Kanaltyp angeben möchten, fügen Sie zusätzliche Benachrichtigungen hinzu.
  6. Wiederholen Sie den vorherigen Schritt, um weitere Benachrichtigungen hinzuzufügen.
  7. Wenn Sie eine Benachrichtigung hinzugefügt haben, legen Sie die folgenden Felder fest:
    Feld Beschreibung
    Playbook (Optional) Freitextfeld für eine kurze Beschreibung der empfohlenen Maßnahmen zur Behebung der Benachrichtigungen, wenn sie ausgelöst werden. Sie können auch einen Link zu Ihrem internen Wiki oder Ihrer Community-Seite angeben, auf der Sie auf Best Practices verweisen. Die Informationen in diesem Feld werden in die Benachrichtigung aufgenommen. Der Inhalt dieses Felds darf maximal 1.500 Zeichen umfassen.
    Throttle Häufigkeit, mit der Benachrichtigungen gesendet werden. Wählen Sie einen Wert aus der Drop-down-Liste aus.
  8. Klicken Sie auf Speichern.

Benachrichtigungen im Ereignis-Dashboard ansehen

Wenn Edge eine Benachrichtigungsbedingung erkennt, wird diese Bedingung automatisch im Ereignis-Dashboard der Edge-Benutzeroberfläche protokolliert. Die Liste der im Ereignis-Dashboard angezeigten Ereignisse enthält alle Benachrichtigungen, sowohl behobene als auch Zertifikatsbenachrichtigungen.

So rufen Sie eine Benachrichtigung auf:

  1. Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Ereignisse. Das neue Ereignis-Dashboard wird angezeigt:

  2. Filtern Sie das Ereignis-Dashboard nach:

    • Umgebung
    • Region
    • Zeitraum
  3. Wählen Sie im Ereignis-Dashboard eine Zeile aus, um den Keystore mit dem ablaufenden Zertifikat aufzurufen und die Benachrichtigung weiter zu untersuchen. Auf der Seite „Schlüsselspeicher“ können Sie ein neues Zertifikat hochladen und das ablaufende Zertifikat löschen.

Warnmeldungs-APIs mit Verkehrsmeldungen verwenden

Die meisten APIs, die Sie zum Erstellen und Verwalten von Traffic-Benachrichtigungen verwenden, sind mit den APIs identisch, die Sie mit anderen Benachrichtigungstypen verwenden:

Einige APIs verfügen jedoch über zusätzliche Eigenschaften, die zur Unterstützung von Anomaliebenachrichtigungen verwendet werden, darunter:

Traffic-Benachrichtigung erstellen oder aktualisieren

Verwenden Sie die gleichen APIs, um eine Traffic-Benachrichtigung zu erstellen oder zu aktualisieren wie für andere Benachrichtigungstypen. Der Text des API-Aufrufs zum Erstellen oder Aktualisieren einer Verkehrswarnung ist mit den folgenden Änderungen identisch:

  • Fügen Sie die folgenden neuen Eigenschaften hinzu, um anzugeben, dass es sich bei der Benachrichtigung um eine Traffic-Benachrichtigung handelt:

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    Die Standardwerte dieser Attribute sind:

    "alertType": "runtime"
"alertSubType": "fixed"
  • Im dimensions-Element des conditions-Arrays:
    • Sie müssen die Werte der Attribute org, env, proxy und region festlegen. Nur diese Eigenschaften werden unterstützt. Sie können proxy und region auf ALL setzen.
    • Sie müssen den Wert des Attributs traffic auf total setzen.

  • Im Array conditions:

    • Das Attribut metrics muss den Wert trafficChange haben.
    • Die Property comparator muss auf increasedBy oder decreasedBy festgelegt sein.
    • Die Eigenschaft threshold enthält einen positiven Wert, der eine prozentuale Steigerung oder Senkung des Traffics angibt. Ein Wert von 1.0 entspricht 100%. Für increasedBy muss der Wert größer oder gleich 0,0 (0%) sein. Für decreasedBy muss der Wert größer oder gleich 0,0 (0%) und kleiner oder gleich 1,0 (100%) sein.
    • Die Eigenschaft durationSeconds muss auf einen der folgenden Werte festgelegt werden: 3600 (1 Stunde), 86400 (1 Tag), 604800 (7 Tage), 1296000 (15 Tage), 2592000 (30 Tage) .
  • Die Property reportEnabled wird für Verkehrsmeldungen nicht unterstützt.
Das folgende Beispiel zeigt, wie Sie eine Benachrichtigung einrichten, die ausgelöst wird, wenn der Traffic für eine Organisation und Umgebung innerhalb einer Stunde um 50% steigt. Eine Benachrichtigung wird an den angegebenen PagerDuty-Code gesendet, wenn die Benachrichtigung ausgelöst wird. 
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

Stellen Sie $ACCESS_TOKEN auf Ihr OAuth 2.0-Zugriffstoken ein, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben. Informationen zu den in diesem Beispiel verwendeten cURL-Optionen finden Sie unter cURL verwenden.

Weitere Informationen zur Verwendung dieser API finden Sie unter Ereignisse ansehen.

Verkehrsmeldungen erhalten

Standardmäßig gibt die API Get Alerts Informationen zu allen definierten Benachrichtigungen zurück. Diese API unterstützt nun Abfrageparameter zum Filtern von Ergebnissen:

  • enabled-Wenn true angibt, dass nur aktivierte Benachrichtigungen zurückgegeben werden sollen. Der Standardwert ist false.
  • alertType-Gibt den Benachrichtigungstyp an, der zurückgegeben werden soll. Die zulässigen Werte sind runtime (Standardwert) und cert.
  • alertSubType-Gibt den Warnungs-Untertyp an, der zurückgegeben werden soll. Der Standardwert ist nicht festgelegt, d. h., es werden alle Benachrichtigungstypen zurückgegeben.

Verwenden Sie beispielsweise den folgenden API-Aufruf, um nur Benachrichtigungen für die Organisation mit dem Namen myorg zurückzugeben:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

Der folgende Aufruf gibt nur Verkehrsmeldungen zurück, die aktiviert und deaktiviert sind:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

Stellen Sie $ACCESS_TOKEN auf Ihr OAuth 2.0-Zugriffstoken ein, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben. Informationen zu den in diesem Beispiel verwendeten cURL-Optionen finden Sie unter cURL verwenden.