Warnungen und Benachrichtigungen einrichten

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

Alarmbedingungen definieren einen bestimmten Statuscode (z. B. 404/502/2xx/4xx/5xx), Latenz und Fehlercode-Schwellenwerte, die bei Überschreitung visuelle Warnungen in der Benutzeroberfläche auslösen und Benachrichtigungen über verschiedene Kanäle wie E-Mail, Slack, PagerDuty oder Webhooks senden. Sie können Warnungen auf Umgebungs-, API-Proxy-, Zieldienst- oder Regionsebene einrichten. Wenn eine Warnung ausgelöst wird, erhalten Sie eine Benachrichtigung mit der Methode, die Sie beim Hinzufügen von Benachrichtigungen und Benachrichtigungen definiert haben.

Sie können beispielsweise eine Warnung auslösen und eine Benachrichtigung an das Operations-Team senden, wenn die 5xx-Fehlerrate für einen Zeitraum von 5 Minuten für den in Ihrer Produktionsumgebung bereitgestellten Order-Prod-API-Proxy 23% übersteigt.

Die folgende Abbildung zeigt, wie Benachrichtigungen in der Benutzeroberfläche angezeigt werden:

Im Folgenden finden Sie ein Beispiel für eine E-Mail-Benachrichtigung, die Sie erhalten können, wenn eine Benachrichtigung ausgelöst wird.

Klicken Sie im Text der Benachrichtigungsbenachrichtigung auf die folgenden Links, um weitere Informationen zu erhalten:

  • Zeigen Sie Details an, um weitere Details anzuzeigen, einschließlich der Benachrichtigungseinstellungen und der Aktivität für jede Bedingung in der letzten Stunde.
  • Warnungsdefinition, um die Definition der Benachrichtigung anzusehen.
  • Benachrichtigungsverlauf, um weitere Informationen zur betreffenden Benachrichtigung anzuzeigen.
  • Sehen Sie sich das Playbook an, um die empfohlenen Maßnahmen anzusehen, falls vorhanden.
  • API-Analysebericht anzeigen, um einen benutzerdefinierten Bericht für die Benachrichtigungsbedingungen anzuzeigen.

In den folgenden Abschnitten wird beschrieben, wie Sie Benachrichtigungen einrichten und verwalten.

Über Benachrichtigungstypen

Mit der ersten Version von API-Monitoring können Sie musterbasierte Regeln erstellen, die festlegen, wann eine Benachrichtigung basierend auf einer Reihe vordefinierter Bedingungen ausgelöst werden soll. Diese Benachrichtigungstypen werden als feste Benachrichtigungen bezeichnet und waren in der ersten Version von API-Monitoring der einzige Benachrichtigungstyp.

Sie können beispielsweise eine feste Benachrichtigung auslösen, wenn:

  • [Rate von 5xx-Fehlern] [ist größer als] [10 %] für [10 Minuten] ab [ target mytarget1]
  • [Anzahl der 2xx-Fehler] [ist weniger als] [50] für [5 Minuten] in [Region us-east-1]
  • [p90-Latenz] [ist größer als] [750 ms] für [10 Minuten] am [Proxy myproxy1]

Der Betaversion von Security Reporting 19.11.13 enthält neue Arten von Benachrichtigungen:

  • Benachrichtigungen zum Gesamt-Traffic (Beta). Ein Benachrichtigungstyp, mit dem Sie benachrichtigt werden, wenn sich der Traffic in einem Zeitraum um einen bestimmten Prozentsatz ändert.
  • Benachrichtigungen zu Anomalien (Beta). Ein Benachrichtigungstyp, bei dem Edge Verkehrs- und Leistungsprobleme erkennt, ohne dass Sie diese selbst bestimmen müssen. Sie können dann eine Warnung für diese Anomalien auslösen lassen.
  • Benachrichtigungen über TLS Expiry (Beta) Ein Benachrichtigungstyp, mit dem Sie eine Benachrichtigung auslösen können, wenn ein TLS-Zertifikat bald abläuft.

Da das API-Monitoring jetzt mehrere Arten von Benachrichtigungen unterstützt, wird im Dialogfeld „Benachrichtigung erstellen“ jetzt die Option zur Auswahl des Benachrichtigungstyps angezeigt:

Das Dialogfeld zum Erstellen von Benachrichtigungen enthält jetzt mehrere Benachrichtigungstypen

Benachrichtigungseinstellungen ansehen

Klicken Sie zum Anzeigen der aktuell definierten Benachrichtigungseinstellungen in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln.

Die Benachrichtigungsseite wird angezeigt, wie in der folgenden Abbildung dargestellt:

Benachrichtigungs-E-Mail

Wie in der Abbildung hervorgehoben, können Sie auf der Seite „Benachrichtigung“ Folgendes tun:

Verlauf der Benachrichtigungen ansehen, die für Ihre Organisation ausgelöst wurden

Um den Verlauf der Benachrichtigungen anzuzeigen, die in den letzten 24 Stunden für Ihre Organisation ausgelöst wurden, klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln und klicken Sie dann auf den Tab Verlauf.

Die Seite „Alarmverlauf“ wird angezeigt.

Benachrichtigungsverlauf

Klicken Sie auf den Namen der Benachrichtigung, um die Details der Benachrichtigung im Investigate-Dashboard anzuzeigen. Sie können die Liste filtern, indem Sie den gesamten oder einen Teil des Benachrichtigungsnamens durchsuchen.

Benachrichtigungen hinzufügen

So fügen Sie Warnungen 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.
    Benachrichtigungstyp Wählen Sie Fest aus. Weitere Informationen finden Sie unter Benachrichtigungstypen.
    Beschreibung Beschreibung der Benachrichtigung
    Umgebung Wählen Sie die Umgebung aus der Drop-down-Liste aus.
    Status Aktivieren oder deaktivieren Sie die Benachrichtigung.
  4. Definieren Sie den Messwert, den Schwellenwert und die Dimension für die erste Bedingung, die die Benachrichtigung auslösen soll.
    Bedingungsfeld Beschreibung
    Messwert

    Wählen Sie einen der folgenden Messwerte aus:

    • Statuscode: Wählen Sie einen Statuscode aus der Liste, z. B. 401, 404, 2xx, 4xx oder 5xx HTTP.

      Hinweise:

      • Mit der API können Sie einen größeren Bereich von Statuscodes festlegen. Verwenden Sie die API, um einen Statuscode zwischen 200–299 und 400–599 und die Platzhalterwerte 2xx, 4xx oder 5xx anzugeben. Siehe Benachrichtigung erstellen.
      • Setzen Sie für Ratenbegrenzungsbenachrichtigungen (HTTP-Statuscode 429) die Metrik auf einen Spike Arrest-Fehlercode.
      • Sie können die AssignMessage-Richtlinie verwenden, um den HTTP-Antwortcode entweder aus einem Proxy-Fehler oder einem Zielfehler neu zu schreiben. Das API-Monitoring ignoriert alle umgeschriebenen Codes und protokolliert die tatsächlichen HTTP-Antwortcodes.
    • Latenz: Wählen Sie einen Latenzwert aus der Drop-down-Liste aus. Insbesondere gilt Folgendes: p50 (50. Perzentil), p90 (90. Perzentil), p95 (95. Perzentil) oder p99 (99. Perzentil). Wählen Sie beispielsweise p95 aus, um eine Benachrichtigung einzurichten, die ausgelöst wird, wenn die Antwortlatenz für das 95. Perzentil größer als der unten festgelegte Grenzwert ist.
    • Fehlercode: Wählen Sie eine Kategorie, eine Unterkategorie und einen Fehlercode aus der Liste aus. Oder wählen Sie innerhalb einer Kategorie oder Unterkategorie eine der folgenden Optionen aus:

      • Alle - Die Summe aller Fehlercodes in dieser Kategorie/Unterkategorie muss die Messwertkriterien erfüllen.
      • Alle - Einzelfehlercode in dieser Kategorie/Unterkategorie muss die Messwertkriterien erfüllen.

      Siehe Fehlercode-Referenz für weitere Informationen:

    • Gesamter Traffic (Beta): Wählen Sie Trafficzunahme oder -abnahme. Siehe Traffic-Benachrichtigungen (Beta) für weitere Informationen.

    Grenzwert

    Konfigurieren Sie den Grenzwert für den ausgewählten Messwert:

    • Statuscode: Legen Sie den Schwellenwert als Prozentsatz, Anzahl oder Transaktionen pro Sekunde (TPS) im Zeitverlauf fest.
    • Latenz: Wählen Sie den Grenzwert aus als Gesamt- oder Ziel-Latenzzeit (ms) im Laufe der Zeit. In diesem Fall wird eine Benachrichtigung ausgelöst, wenn die angegebene Perzentil-Latenz, die bei Traffic jede Minute aktualisiert wird, die Grenzwertbedingung für den Zeitraum für die angegebene Zeitdauer überschreitet. Das heißt, die Grenzwertbedingung wird nicht über die gesamte Dauer hinweg aggregiert.
    • Fehlercode: Legen Sie den Grenzwert fest als Prozentsatz, Anzahl oder Transaktionen pro Sekunde (TPS) im Laufe der Zeit.
    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, Zieldienst oder Entwickler-App und Region.

    Wenn Sie eine bestimmte Dimension auf Folgendes festlegen:

    • Alle: Alle Entitäten in der Dimension müssen die Messwertkriterien erfüllen. Sie können nicht Alle für einen Messwert vom Typ Latenz auswählen.
    • Jede - Gilt nur für die Region. Eine Entität in der Dimension muss die Messwertkriterien für eine einzelne Region erfüllen.
      Hinweis: Wählen Sie für API-Proxys oder Zieldienste eine Sammlung aus, um die Funktion "Jede" zu unterstützen.
    • Sammlungen - Wählen Sie eine Sammlung aus der Liste aus, um den Satz von API-Proxys oder Zieldiensten anzugeben. In diesem Fall muss jede Entität in der Sammlung die Kriterien erfüllen.

    Wenn Sie die Dimension auf Ziel setzen, können Sie einen Zieldienst oder den durch eine ServiceCallout-Richtlinie festgelegten Dienst auswählen. Das Ziel einer ServiceCallout-Richtlinie wird als Wert mit dem Präfix "sc://" angezeigt, zum Beispiel "sc://my.endpoint.net".

  5. Klicken Sie auf Bedingungsdaten anzeigen, um die letzten Daten für die Bedingung in der letzten Stunde anzuzeigen.
    Die Fehlerrate in der Grafik wird rot angezeigt, wenn der Grenzwert für Benachrichtigungen überschritten wird.
    Bedingungsdaten anzeigen

    Klicken Sie auf Bedingungsdaten ausblenden, um die Daten auszublenden.

  6. Klicken Sie auf + Bedingung hinzufügen, um weitere Bedingungen hinzuzufügen, und wiederholen Sie die Schritte 4 und 5.

    Hinweis: Wenn Sie mehrere Bedingungen angeben, wird die Benachrichtigung ausgelöst, wenn alle Bedingungen erfüllt sind.

  7. Klicken Sie auf API-Analyseberichte basierend auf Benachrichtigungsbedingungen erstellen, wenn Sie einen benutzerdefinierten Bericht basierend auf den von Ihnen konfigurierten Benachrichtigungsbedingungen erstellen möchten. Diese Option ist ausgegraut, wenn Sie kein Organisationsadministrator sind.

    Weitere Informationen finden Sie unter Erstellen eines benutzerdefinierten Berichts aus einer Benachrichtigung.

    Hinweis: Sie können den benutzerdefinierten Bericht nach dem Speichern der Warnung ändern, wie unter Verwalten von benutzerdefinierten Berichten beschrieben.

  8. 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: die Webhook-URL, z. B. https://apigee.com/test-webhook. Eine Beschreibung des an die URL gesendeten Objekts finden Sie unter Webhook-Objektformat.

      Übergeben Sie alle Anmeldedaten in der URL des Webhooks. Beispiel: https://apigee.com/test-webhook?auth_token=1234_abcd.

      Sie können die URL zu einem Endpunkt angeben, der das Webhook-Objekt parsen kann, um es zu ändern oder zu verarbeiten. Sie können beispielsweise die URL zu einer API (z. B. einer Edge-API) oder zu einem anderen Endpunkt angeben, der das Objekt verarbeiten kann.

      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.

  9. Wenn Sie weitere Benachrichtigungen hinzufügen möchten, wiederholen Sie Schritt 8.
  10. Wenn Sie eine Benachrichtigung hinzugefügt haben, legen Sie die folgenden Felder fest:
    Field Beschreibung
    Playbook (Optional) Textfeld mit freiem Format, das eine kurze Beschreibung der empfohlenen Aktionen zum Beheben der Alarme enthält, 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. Gültige Werte sind: 15 Minuten, 30 Minuten und 1 Stunde.
  11. Klicken Sie auf Speichern.

Webhook-Objektformat

Wenn Sie eine Webhook-URL als Ziel einer Benachrichtigungsbenachrichtigung angeben, hat das an die URL gesendete Objekt das folgende Format:
{
  "alertInstanceId": "event-id",
  "alertName": "name",
  "org": "org-name",
  "description": "alert-description",
  "alertId": "alert-id",
  "alertTime": "alert-timestamp",
  "thresholdViolations":{"Count0": "Duration=threshold-duration Region=region Status Code=2xx Proxy=proxy Violation=violation-description"
  },
  "thresholdViolationsFormatted": [
    {
      "metric": "count",
      "duration": "threshold-duration",
      "proxy": "proxy",
      "region": "region",
      "statusCode": "2xx",
      "violation": "violation-description"
    }
  ],
  "playbook": "playbook-link"
}

Die Attribute thresholdViolations und thresholdViolationsFormatted enthalten Details zur Benachrichtigung. Das Attribut thresholdViolations enthält einen einzelnen String mit den Details, während thresholdViolationsFormatted ein Objekt enthält, das die Benachrichtigung beschreibt. In der Regel wird die Eigenschaft thresholdViolationsFormatted verwendet, da sie sich einfacher decodieren lässt.

Das obige Beispiel zeigt den Inhalt dieser Attribute für eine feste Benachrichtigung, wenn Sie den Benachrichtigungsmesswert basierend auf dem HTTP-Statuscode 2xx konfigurieren, wie durch das statusCode angegeben.

Der Inhalt dieser Attribute hängt vom Typ der Benachrichtigung (z. B. fest oder Anomalie) und der spezifischen Konfiguration der Benachrichtigung ab. Wenn Sie beispielsweise eine feste Benachrichtigung basierend auf einem Fehlercode erstellen, enthält die Eigenschaft thresholdViolationsFormatted eine faultCode-Eigenschaft anstelle einer statusCode-Eigenschaft.

In der folgenden Tabelle sind alle möglichen Attribute des Attributs thresholdViolationsFormatted für verschiedene Benachrichtigungstypen aufgeführt:

Benachrichtigungstyp Mögliche thresholdViolationsFormatted-Inhalte
Fixed
metric, proxy, target, developerApp,
region, statusCode, faultCodeCategory, faultCodeSubCategory,
faultCode, percentile, comparisonType, thresholdValue,
triggerValue, duration, violation
Verkehr insgesamt
metric, proxy, target, developerApp,
region, comparisonType, thresholdValue, triggerValue,
duration, violation
Anomalie
metric, proxy, target, region,
statusCode, faultCode, percentile, sensitivity,
violation
TLS-Ablauf
envName, certificateName, thresholdValue, violation

Benutzerdefinierten Bericht aus einer Benachrichtigung erstellen

So erstellen Sie einen benutzerdefinierten Bericht aus einer Warnung:

  1. Klicken Sie beim Erstellen einer Benachrichtigung auf API-Analyseberichte basierend auf Benachrichtigungsbedingungen erstellen, wie unter Hinzufügen von Benachrichtigungen und Benachrichtigungen beschrieben.

    Nachdem Sie die Benachrichtigung gespeichert haben, wird auf der Benutzeroberfläche die folgende Meldung angezeigt:

    Alert alertName saved successfully. To customize the report generated, click here.

    Klicken Sie auf die Nachricht, um den Bericht in einem neuen Tab mit relevanten Feldern zu öffnen. Standardmäßig heißt der benutzerdefinierte Bericht: API Monitoring Generated alertName

  2. Bearbeiten Sie den benutzerdefinierten Bericht nach Wunsch und klicken Sie dann auf Speichern.
  3. Klicken Sie auf den Namen des Berichts in der Liste und führen Sie den benutzerdefinierten Bericht aus.

So verwalten Sie den benutzerdefinierten Bericht, der anhand von Benachrichtigungsbedingungen erstellt wurde:

  1. Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln.
  2. Klicken Sie auf den Tab Einstellungen.
  3. Klicken Sie in der Spalte Berichte auf den benutzerdefinierten Bericht, der der Benachrichtigung zugeordnet ist, die Sie verwalten möchten.

    Die Seite mit benutzerdefinierten Berichten wird auf einem neuen Tab angezeigt. Wenn die Spalte Berichte leer ist, wurde noch kein benutzerdefinierter Bericht erstellt. Bei Bedarf können Sie die Warnung bearbeiten, um einen benutzerdefinierten Bericht hinzuzufügen.

  4. Bearbeiten Sie den benutzerdefinierten Bericht nach Wunsch und klicken Sie dann auf Speichern.
  5. Klicken Sie auf den Namen des Berichts in der Liste und führen Sie den benutzerdefinierten Bericht aus.

Benachrichtigung aktivieren oder deaktivieren

So aktivieren oder deaktivieren Sie eine Benachrichtigung:

  1. Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln.
  2. Klicken Sie in der Spalte Status auf die Ein-/Aus-Schaltfläche für die zu aktivierende oder zu deaktivierende Benachrichtigung.

Benachrichtigung bearbeiten

So bearbeiten Sie eine Benachrichtigung:

  1. Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln.
  2. Klicken Sie auf den Namen der Benachrichtigung, die Sie bearbeiten möchten.
  3. Bearbeiten Sie die Benachrichtigung nach Bedarf.
  4. Klicken Sie auf Speichern.

Benachrichtigung löschen

So löschen Sie eine Benachrichtigung:

  1. Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln.
  2. Positionieren Sie den Cursor über der Benachrichtigung, die Sie löschen möchten, und klicken Sie im Aktionsmenü auf .

Apigee empfiehlt, dass Sie die folgenden Benachrichtigungen einrichten, um über häufige Probleme informiert zu werden. Einige dieser Benachrichtigungen beziehen sich speziell auf die Implementierung Ihrer APIs und sind nur in bestimmten Situationen nützlich. Die folgenden Benachrichtigungen treffen beispielsweise nur dann zu, wenn Sie die ServiceCallout-Richtlinie oder die JavaCallout-Richtlinie verwenden.

Benachrichtigung UI-Beispiel API-Beispiel
5xx-Statuscodes für alle/jede APIs 5xx-Statuscode für einen API-Proxy einrichten 5xx-Statuscode für einen API-Proxy mithilfe der API einrichten
P95-Latenz für einen API-Proxy P95-Latenzbenachrichtigung für einen API-Proxy einrichten P95-Latenzbenachrichtigung für einen API-Proxy mithilfe der API einrichten
404 (Application Not Found)-Statuscodes für alle API-Proxys Für alle API-Proxys einen 404-Code (Application Not Found) einrichten Für alle API-Proxys einen 404-Statuscode-Warnung (Application Not Found) mit der API einrichten
API-Proxy-Anzahl für APIs API-Proxy-Zählungsbenachrichtigung für APIs einrichten API-Proxy-Zählungsbenachrichtigung für APIs mithilfe der API einrichten
Fehlerraten für Zieldienste Fehlerratenbenachrichtigung für Zieldienste einrichten Warnung für Fehlerraten für Zieldienste mit der API einrichten
Fehlerraten für ServiceCallout-Richtlinien (falls zutreffend) Fehlerratenbenachrichtigung für die ServiceCallout-Richtlinie einrichten Benachrichtigung für Fehlerraten für die ServiceCallout-Richtlinie mithilfe der API einrichten
Spezifische Fehlercodes, einschließlich:
  • API-Protokollfehler (normalerweise 4xx)
    • UI: API-Protokoll > Alle
    • API:
      "faultCodeCategory":"API Protocol",
      "faultCodeSubCategory":"ALL"
  • Alle HTTP-Fehler einfangen
    • UI: Gateway > Andere > Gateway HTTPErrorResponseCode
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Others",
      "faultCodeName": "Gateway HTTPErrorResponseCode"
  • Fehler bei der Ausführung des Java-Service-Callouts (falls zutreffend)
    • Benutzeroberfläche: Ausführungsrichtlinie > Java-Callout > JavaCallout ExecutionFailed
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Java Callout",
      "faultCodeName": "JavaCallout ExecutionFailed"
  • Fehler bei der Ausführung des Knotenskripts (falls zutreffend)
    • UI: Ausführungsrichtlinie > Knotenskript > NodeScript ExecutionError
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Node Script",
      "faultCodeName": "NodeScript ExecutionError"
  • Kontingentverstöße
    • UI: Richtlinie für Trafficmanagement > Kontingent > Kontingentverstoß
    • API:
      "faultCodeCategory": "Traffic Mgmt Policy",
      "faultCodeSubCategory": "Quota",
      "faultCodeName": "Quota Violation"
  • Fehler der Sicherheitsrichtlinie
    • Benutzeroberfläche: Sicherheitsrichtlinie > Alle
    • API:
      "faultCodeCategory": "Security Policy",
      "faultCodeName": "Any"
  • Sense-Fehler (falls zutreffend)
    • Benutzeroberfläche: Sense > Sense > Sense IncreaseFault
    • API:
      "faultCodeCategory": "Sense",
      "faultCodeSubCategory": "Sense",
      "faultCodeName": "Sense RaiseFault"
  • Fehler bei der Ausführung von Service-Callouts (falls zutreffend)
    • Benutzeroberfläche: Ausführungsrichtlinie > Service-Callout > ServiceCallout ExecutionFailed
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Service Callout",
      "faultCodeName": "ServiceCallout ExecutionFailed"
  • Zielfehler
    • UI: Gateway > Ziel > Gateway TimeoutWithTargetOrCallout
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TimeoutWithTargetOrCallout"
  • Zielfehler, keine aktiven Ziele
    • UI: Gateway > Target > Gateway TargetServerConfiguredInLoadBalancerIsDown
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TargetServerConfiguredInLoadBalancerIsDown
  • Zielfehler, unerwartetes EOF
    • UI: Gateway > Ziel > Gateway unerwartetEOFAtTarget
    • API:
      "faultCodeCategory": "Gateway", "faultCodeSubCategory": "Target", "faultCodeName" : "Gateway UnexpectedEOFAtTarget"
  • Fehler beim virtuellen Host
    • UI: Gateway > virtueller Host > VirtualHost InvalidKeystoreOrTrustStore
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Virtual Host",
      "faultCodeName": "VirtualHost InvalidKeystoreOrTrustStore"
Richtlinienfehlercode-Benachrichtigung einrichten Richten Sie mithilfe der API eine Richtlinienfehlercode-Benachrichtigung ein

5xx-Statuscode für einen API-Proxy einrichten

Im Folgenden finden Sie ein Beispiel für das Einrichten einer Benachrichtigung mithilfe der Benutzeroberfläche, die ausgelöst wird, wenn die Transaktionen pro Sekunde (TPS) von 5xx-Statuscodes für den Hotels-API-Proxy 100 für 10 Minuten für eine beliebige Region überschreitet. Weitere Informationen finden Sie unter Hinzufügen von Warnungen und Benachrichtigungen.

Informationen zur Verwendung der API finden Sie unter 5xx-Statuscode für einen Proxy mithilfe der API einrichten.

P95-Latenzbenachrichtigung für einen API-Proxy einrichten

Im Folgenden finden Sie ein Beispiel für das Einrichten einer Warnung mithilfe der Benutzeroberfläche, die ausgelöst wird, wenn die Gesamtantwortlatenz für das 95. Perzentil für 5 Minuten für den Hotels API-Proxy für eine Region größer als 100 ms ist. Weitere Informationen finden Sie unter Hinzufügen von Warnungen und Benachrichtigungen.

Informationen zur Verwendung der API finden Sie unter Einrichten einer P95-Latenzzeitbenachrichtigung für einen API-Proxy mithilfe der API

404-Warnung (Anwendung nicht gefunden) für alle API-Proxys einrichten

Im Folgenden finden Sie ein Beispiel für das Einrichten einer Benachrichtigung mithilfe der Benutzeroberfläche, die ausgelöst wird, wenn der Prozentsatz der 404-Statuscodes für alle API-Proxys für 5 Minuten 5 % in einer Region übersteigt. Weitere Informationen finden Sie unter Hinzufügen von Warnungen und Benachrichtigungen.

Informationen zur Verwendung der API finden Sie unter Einrichten einer Warnung 404 (Application Not Found) für alle API-Proxys, die die API verwenden.

API-Proxy-Zählungsbenachrichtigung für APIs einrichten

Im Folgenden finden Sie ein Beispiel für das Einrichten einer Warnung mithilfe der Benutzeroberfläche, die ausgelöst wird, wenn die 5xx-Codeanzahl für APIs 5 Minuten lang für eine Region 200 überschreitet. In diesem Beispiel werden die APIs in der Critical API Proxies-Sammlung erfasst. Weitere Informationen finden Sie unter:

Informationen zur Verwendung der API finden Sie unter: API-Proxy-Zählungsbenachrichtigung für APIs mithilfe der API einrichten.

Fehlerratenbenachrichtigung für Zieldienste einrichten

Im Folgenden finden Sie ein Beispiel für das Einrichten einer Warnung mithilfe der Benutzeroberfläche, die ausgelöst wird, wenn die 500-Code-Rate für Zieldienste 1 Stunde lang für eine Region 10% übersteigt. In diesem Beispiel werden die Zieldienste in der Sammlung „Kritische Ziele“ erfasst. Weitere Informationen finden Sie unter:

Informationen zur Verwendung der API finden Sie unter: Mithilfe der API eine Fehlerratenbenachrichtigung für Zieldienste einrichten.

Fehlerratenbenachrichtigung für ServiceCallout-Richtlinie einrichten

Im Folgenden finden Sie ein Beispiel für das Einrichten einer Benachrichtigung mithilfe der Benutzeroberfläche, der ausgelöst wird, wenn die 500-Code-Rate für den durch die ServiceCallout-Richtlinie angegebenen Dienst für eine Region 1 Stunde lang 10% übersteigt. Weitere Informationen finden Sie unter:

Informationen zur Verwendung der API finden Sie unter: Mithilfe der API eine Fehlerratenbenachrichtigung für die Service-Callout-Richtlinie einrichten.

Richtlinienfehlercode-Benachrichtigung einrichten

Im Folgenden finden Sie ein Beispiel zum Einrichten einer Benachrichtigung mithilfe der Benutzeroberfläche, die ausgelöst wird, wenn der JWT AlgorithmMismatch-Fehlercode der VerifyJWT-Richtlinie 10 Minuten lang für alle APIs größer als 5 ist. Weitere Informationen finden Sie unter:

Informationen zur Verwendung der API finden Sie unter Fehlercode-Benachrichtigung für Richtlinienfehlercode mithilfe der API einrichten.