Verkehrsmeldungen einrichten

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Verwenden Sie eine Verkehrswarnung, um Eine Benachrichtigung, wenn sich der Traffic für eine Umgebung, einen Proxy oder eine Region um einen bestimmten Prozentsatz ändert für einen bestimmten Zeitraum.

Sie legen den Zeitraum auf Folgendes fest:

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

Dabei wird der Traffic für den aktuellen Zeitraum mit dem Traffic im vorherigen Zeitraum verglichen. Sie geben beispielsweise einen Zeitraum von einer Stunde an. In der Benachrichtigung wird dann der Verkehr in der letzten Stunde verglichen mit dem Traffic in der vorherigen Stunde vergleichen, um die prozentuale Änderung des Traffics zu berechnen:

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

Ein positiver Wert bedeutet, dass der Traffic gestiegen ist, ein negativer Wert ist gesunken.

Dann legen Sie den Grenzwert, der eine Verkehrswarnung auslöst, als prozentualen Anstieg oder Rückgang des API-Traffics fest. für den angegebenen Zeitraum.

Bevor Sie diesen Prozentsatz festlegen, vergewissern Sie sich, dass er mit Ihrem normalen Traffic-Muster zu erhalten. Wenn Ihr API-Traffic beispielsweise im Laufe des Tages mit stündlichen Zugriffsspitzen von bis zu 100 % schwankt zu bestimmten Spitzenzeiten sind solche Spitzen normal und sollten keine Benachrichtigung auslösen. Wenn jedoch konfigurieren Sie dann eine Benachrichtigung, die bei jedem Anstieg des stündlichen Traffics um 50% ausgelöst wird. erhalten Sie unnötige Warnungen für normale Zugriffe.

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

Verkehrsmeldungen und Benachrichtigungen hinzufügen

So fügen Sie Verkehrsmeldungen und Benachrichtigungen hinzu: <ph type="x-smartling-placeholder">
    </ph>
  1. Klicken Sie auf Analysieren > Benachrichtigungsregeln in der Edge-Benutzeroberfläche.
  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 Traffic insgesamt aus. Weitere Informationen finden Sie unter Weitere Informationen zu Benachrichtigungstypen
    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, durch die die Benachrichtigung ausgelöst wird.
    Bedingungsfeld Beschreibung
    Grenzwert

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

    Legen Sie für Erhöht um einen Wert fest, der größer oder gleich 0 % ist. Geben Sie für Verringert um einen Wert größer oder gleich 0 % an. und kleiner oder gleich 100 % ist.

    Sie können folgendes Zeitintervall auswählen:

    • 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 den API-Proxy und die Region.

    Legen Sie eine bestimmte Dimension für Folgendes fest:

    • Proxy - Legen Sie einen bestimmten Proxy oder Alle Proxys fest. Proxy unterstützt nicht den Wert "Any". 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. Die Region unterstützt nicht den Wert "Any". Stattdessen können Sie für jede Region, an der Sie interessiert sind, eine eigene 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: <ph type="x-smartling-placeholder">
      </ph>
    • E-Mail - 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 mit einer kurzen Beschreibung der empfohlenen Maßnahmen für wenn sie ausgelöst werden. Sie können auch einen Link zu Ihrem internen Wiki oder Community-Seite, auf der Sie auf Best Practices verweisen. Die Informationen in diesem Feld die in der Benachrichtigung enthalten sind. Der Inhalt in diesem Feld darf 1500 Zeichen nicht überschreiten.
    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 einen Alarmzustand erkennt, protokolliert er diese Bedingung automatisch im Ereignisse-Dashboard in der Edge-Benutzeroberfläche. Liste der im Ereignis-Dashboard angezeigten Ereignisse enthält alle Benachrichtigungen, sowohl feste als auch Zertifikate.

So rufen Sie eine Benachrichtigung auf:

  1. Klicken Sie auf Analysieren > Ereignisse in der Edge-Benutzeroberfläche. 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 Schlüsselspeicher mit dem ablaufenden Zertifikat anzuzeigen die Benachrichtigung weiter untersuchen. Auf der Schlüsselspeicher-Seite können Sie ein neues Zertifikat hochladen und ablaufendes Zertifikat.

Verwenden Sie die Alert APIs mit Verkehrswarnungen

Die meisten der APIs, die Sie zum Erstellen und Verwalten von Verkehrsmeldungen verwenden, sind dieselben wie die, die Sie verwenden. mit anderen Benachrichtigungstypen:

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

Verkehrsmeldung erstellen oder aktualisieren

Verwenden Sie dieselben APIs zum Erstellen oder aktualisieren wie bei anderen Arten von Verkehrsmeldungen. Der Text des API-Aufrufs zum Erstellen oder Aktualisieren einer Verkehrsmeldung entspricht dem für andere Benachrichtigungen mit den folgenden Änderungen:

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

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

    Die Standardwerte dieser Attribute sind:

    "alertType": "runtime"
"alertSubType": "fixed"
  • Im dimensions-Element des conditions-Arrays: <ph type="x-smartling-placeholder">
      </ph>
    • Sie müssen die Werte für org, env, proxy, und region-Properties. Es werden nur diese Attribute 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.
    • Das Attribut threshold enthält einen positiven Wert, der einen prozentualen Anstieg oder Rückgang der Zugriffe angibt wobei der Wert 1.0 100 % entspricht. Für increasedBy der Wert muss größer oder gleich 0,0 (0%) sein. Für decreasedBy muss der Wert ist größer oder gleich 0,0 (0%) und kleiner oder gleich 1,0 (100%).
    • Das Attribut 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 ein Unternehmen und eine Umgebung um 50% über einen einstündigen Zeitraum zu erhöhen. 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 Warnungen 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., es werden alle Benachrichtigungsuntertypen zurückgegeben.

Mit dem folgenden API-Aufruf können Sie beispielsweise nur Aktivierungsbenachrichtigungen für die Organisation myorg zurückgeben:

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

Der folgende Aufruf gibt nur Verkehrsmeldungen zurück, sowohl aktivierte als auch deaktivierte:

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.