Verkehrsmeldungen einrichten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

Mit einer Traffic-Benachrichtigung können Sie benachrichtigt werden, wenn sich der Traffic für eine Umgebung, einen Proxy oder eine Region in einem bestimmten Zeitraum um einen bestimmten Prozentsatz ändert.

Sie legen den Zeitraum fest auf:

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

Bei der Benachrichtigung wird der Traffic im aktuellen Zeitraum mit dem des vorherigen Zeitraums verglichen. Sie geben beispielsweise einen Zeitraum von einer Stunde an. In der Benachrichtigung wird dann 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 Zugriffszahlen gestiegen sind, und ein negativer Wert, dass der Traffic gesunken ist.

Anschließend legen Sie den Grenzwert, der eine Traffic-Benachrichtigung auslöst, als prozentualer Anstieg oder Rückgang des API-Traffics für den angegebenen Zeitraum fest.

Prüfen Sie vor dem Festlegen dieses Prozentsatzes, ob er mit Ihren normalen Traffic-Mustern übereinstimmt. Wenn Ihr API-Traffic beispielsweise im Laufe des Tages normalerweise 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 dann jedoch eine Benachrichtigung so konfigurieren, dass sie bei einem Anstieg des stündlichen Traffics um 50% ausgelöst wird, erhalten Sie unnötige Benachrichtigungen für den normalen Traffic.

Weitere Informationen zu Benachrichtigungen finden Sie unter Einrichten von Benachrichtigungen und Benachrichtigungen.

Verkehrsmeldungen und Benachrichtigungen hinzufügen

So fügen Sie Verkehrsmeldungen 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 von Bedeutung ist. Der Name darf nicht länger als 128 Zeichen sein.
    Beschreibung Beschreibung der Benachrichtigung
    Benachrichtigungstyp Wählen Sie Traffic insgesamt aus. Weitere Informationen finden Sie unter Benachrichtigungstypen.
    Umgebung Wählen Sie die Umgebung aus der Drop-down-Liste aus.
    Status Aktivieren oder deaktivieren Sie die Benachrichtigung.
  4. Definieren Sie den Schwellenwert und die Dimension für die Bedingung, die die Benachrichtigung auslösen soll.
    Bedingungsfeld Beschreibung
    Grenzwert

    Geben Sie an, dass die Benachrichtigung ausgelöst werden soll, wenn der Traffic im Vergleich zu einem vorherigen Zeitintervall um einen bestimmten Prozentsatz zugenommen oder verringert wurde.

    Setzen Sie den Prozentsatz für erhöht um auf einen Wert größer oder gleich 0%. Legen Sie für Verringert um einen Prozentsatz fest, der größer oder gleich 0 % und kleiner oder gleich 100 % ist.

    Sie können folgendes Zeitintervall auswählen:

    • 1 Stunde
    • 1 Tag
    • In einer Woche
    Dimension

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

    Legen Sie für eine bestimmte Dimension Folgendes fest:

    • Proxy: auf einen bestimmten Proxy oder auf Alle Proxys festlegen Proxy unterstützt den Wert "Any" nicht. Stattdessen können Sie für jeden gewünschten Proxy eine separate Benachrichtigung hinzufügen.
    • Region: Legen Sie eine bestimmte Region oder Alle Regionen fest. Region unterstützt den Wert "Any" nicht. Stattdessen können Sie für jede Region, die Sie interessieren, eine separate Benachrichtigung hinzufügen.
  5. Klicken Sie auf + Benachrichtigung, um eine Benachrichtigung hinzuzufügen.
    Benachrichtigungsdetails Beschreibung
    Kanal Wählen Sie den Benachrichtigungskanal aus, den Sie verwenden möchten, 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-Adresse – E-Mail-Adresse wie joe@company.com
    • Slack – Slack-Kanal-URL, z. B. https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – PagerDuty-Code, z. B. abcd1234efgh56789
    • Webhook - Webhook-URL wie 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. Wenn Sie weitere Benachrichtigungen hinzufügen möchten, wiederholen Sie den vorherigen Schritt.
  7. Wenn Sie eine Benachrichtigung hinzugefügt haben, legen Sie die folgenden Felder fest:
    Feld Beschreibung
    Playbook (Optional) Kostenloses Textfeld zur Angabe einer kurzen Beschreibung der empfohlenen Maßnahmen zum Beheben der Benachrichtigungen, wenn diese 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 nicht länger als 1500 Zeichen sein.
    Drosseln 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 Warnungsbedingung erkennt, protokolliert es diese automatisch im Dashboard Ereignisse in der Edge-Benutzeroberfläche. Die Liste der im Dashboard „Ereignisse“ angezeigten Ereignisse enthält alle Benachrichtigungen, sowohl feste als auch zertifizierte.

So rufen Sie eine Benachrichtigung auf:

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

  2. Filtern Sie das Ereignis-Dashboard nach:

    • Umgebung
    • Region
    • Zeitraum
  3. Wählen Sie eine Zeile im Ereignisdashboard aus, um den Schlüsselspeicher 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.

Alert APIs mit Verkehrswarnungen verwenden

Die meisten APIs, die Sie zum Erstellen und Verwalten von Verkehrsbenachrichtigungen verwenden, sind dieselben wie die, die Sie für andere Benachrichtigungstypen verwenden:

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

Verkehrswarnung erstellen oder aktualisieren

Verwenden Sie zum Erstellen oder Aktualisieren einer Traffic-Benachrichtigung dieselben APIs wie für andere Benachrichtigungstypen. Der Text des API-Aufrufs zum Erstellen oder Aktualisieren einer Traffic-Benachrichtigung ist identisch mit dem für andere Benachrichtigungen, mit den folgenden Änderungen:

  • Fügen Sie die folgenden neuen Attribute hinzu, um anzugeben, dass es sich um eine Verkehrsbenachrichtigung 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. Es werden nur diese Eigenschaften unterstützt. Sie können proxy und region auf ALL festlegen.
    • Sie müssen den Wert des Attributs traffic auf total setzen.
  • Im Array conditions:

    • Das Attribut metrics muss den Wert trafficChange haben.
    • Das Attribut comparator muss auf increasedBy oder decreasedBy festgelegt sein.
    • Die Eigenschaft threshold enthält einen positiven Wert, der eine prozentuale Zunahme oder Abnahme des Traffics angibt, wobei der Wert 1.0 100 % entspricht. 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 Property durationSeconds muss auf einen der folgenden Werte festgelegt werden: 3600 (1 Stunde), 86400 (1 Tag), 604800 (7 Tage), 1296000 (15 Tage), 2592000 (30 Tage) .
  • Das Attribut reportEnabled wird für Verkehrswarnungen 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% zunimmt. 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 Get Alerts API 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, der Standardwert und cert.
  • alertSubType-Gibt den Warnungs-Untertyp an, der zurückgegeben werden soll. Der Standardwert ist nicht festgelegt, d. h., alle Untertypen von Warnungen werden zurückgegeben.

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

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

Beim folgenden Aufruf werden nur aktivierte und deaktivierte Verkehrsmeldungen zurückgegeben:

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.