Übersicht über Vorgangsanomalien

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Vorgangsanomalien erkennt ungewöhnliche oder unerwartete Datenmuster in Ihren APIs. Bei Vorgangsanomalien werden API-Daten kontinuierlich überwacht und statistische Analysen durchgeführt, um Anomalien zu erkennen.

Vorgangsanomalien erkennt folgende Anomalietypen automatisch:

• Zunahme aller HTTP 4xx- oder 5xx-Fehler auf Organisations-, Umgebungs- und Regionsebene
• Zunahme der Gesamtantwortlatenz für das 90. Perzentil (p90) auf Organisations-, Umgebungs- und Regionsebene

In diesem Diagramm der API-Fehlerrate steigt die Rate beispielsweise plötzlich um 7:00 Uhr an. Im Vergleich zu den Daten bis zu diesem Zeitpunkt ist dieser Anstieg ungewöhnlich genug, um als Anomalie eingestuft zu werden.

Bei Vorgangsanomalien können auch Abweichungen erkannt werden, die weniger wahrscheinlich auf Anomalien hindeuten. Sie können beispielsweise einige geringfügige Schwankungen der Fehlerrate vor der Anomalie erkennen, diese sind jedoch nicht groß genug, um sie als Anomalie zu bezeichnen.

Mit Anomalien im Betrieb haben Sie folgende Möglichkeiten:

• Anomalien ansehen und untersuchen: Operations-Anomalien melden ungewöhnliche API-Ereignisse (Anomalien). Sie können ermitteln, wo und wann der Vorfall aufgetreten ist und was ihn ausgelöst hat. So können Sie das Problem schnell beheben.
• Anomaliebenachrichtigungen erstellen und Benachrichtigungen einrichten, damit Apigee Ihnen bei einem Vorfall eine Nachricht sendet.

Voraussetzungen für die Verwendung von Vorgangsanomalien

So verwenden Sie Vorgangsanomalien:

• Das AAPI Ops-Add‑on muss für Ihre Organisation aktiviert sein. Weitere Informationen finden Sie unter AAPI Ops in einer Organisation aktivieren.
• Nutzer von Vorgangsanomalien müssen die folgenden Rollen haben:
  • roles/apigee.readOnlyAdmin
  • roles/logging.viewer
  • roles/monitoring.viewer
• Nutzer, die Anomalien im Dashboard untersuchen, benötigen außerdem die Rolle roles/logging.viewer.

AAPI Ops in einer Organisation aktivieren

Wenn Sie AAPI Ops verwenden möchten, müssen Sie die Funktion in Ihrer Organisation aktivieren. Rufen Sie vorher ein OAuth 2.0-Zugriffstoken ab. Sie können dann AAPI Ops mit einem API-Aufruf aktivieren, der das Zugriffstoken übergibt.

Aktuelle Add-on-Konfiguration anzeigen

Bevor Sie AAPI Ops aktivieren, prüfen Sie, ob es bereits aktiviert ist. Führen Sie dazu den folgenden API-Aufruf aus:

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

Dabei ist YOUR_ORG der Name Ihrer Organisation und $TOKEN die Umgebungsvariable für ein OAuth-Zugriffstoken. Dadurch werden grundlegende Informationen zu Ihrer Organisation zurückgegeben, darunter ein Abschnitt für Apigee-Add-ons, der mit der folgenden Zeile beginnt:

"addonsConfig": {

Prüfen Sie, ob dieser Abschnitt einen Eintrag enthält, der mit "advancedApiOpsConfig" beginnt, wie im folgenden Beispiel:

"advancedApiOpsConfig": {
          "enabled": "true"
      }

Wenn dieser Eintrag vorhanden ist, ist AAPI Ops bereits in der Organisation aktiviert. Wenn nicht, müssen Sie sie wie unten beschrieben aktivieren.

AAPI Ops aktivieren

Zum Aktivieren von AAPI Opps in der Organisation mit der Standardkonfiguration senden Sie eine POST-Anfrage wie die folgende.

Achtung: Dieser API-Aufruf überschreibt die aktuelle Add-on-Konfiguration. Sie müssen die aktuellen Konfigurationen für alle Add-ons in der obigen Anfrage einschließen, um zu verhindern, dass sie überschrieben werden.

Hinweis: Der folgende API-Aufruf startet einen Vorgang mit langer Ausführungszeit, der einige Zeit in Anspruch nehmen kann.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

Dabei ist <Current add-ons configuration> die aktuelle Add-on-Konfiguration. Sie finden die aktuelle Add-on-Konfiguration in der Antwort auf den Aufruf zum Anzeigen der aktuellen Add-on-Konfiguration. Wenn die aktuelle Add-on-Konfiguration beispielsweise

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

der Befehl zur Aktivierung von AAPI Ops wäre

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

Nachdem Sie die Anfrage gesendet haben, wird eine Antwort wie diese angezeigt:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

AAPI Ops in Ihrer Organisation deaktivieren

Wenn Sie die AAPI Ops für Ihre Organisation deaktivieren müssen, können Sie dazu eine POST-Anfrage senden und die Add-on-Konfiguration im Anfragetext übergeben, wie unten gezeigt.

Achtung: Die Add-on-Konfiguration, die Sie im Anfragetext übergeben, überschreibt die aktuelle Add-on-Konfiguration. Rufen Sie die vorhandene Add-on-Konfiguration im Apigee-Organisationsprofil auf und achten Sie darauf, dass Sie sie in die Anfragenutzlast einfügen.

Hinweis: Der folgende API-Aufruf startet einen Vorgang mit langer Ausführungszeit, der einige Zeit in Anspruch nehmen kann.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

Das folgende Beispiel enthält eine Antwort, die zeigt, dass der Vorgang läuft:

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Weitere Informationen finden Sie unter Organization Add-ons API konfigurieren.

Funktionsweise der Anomalieerkennung

Die Anomalieerkennung umfasst die folgenden Phasen:

• Modelle trainieren
• Anomalieereignisse loggen

Modelle trainieren

Bei Vorgangsanomalien wird ein Modell des Verhaltens Ihrer API-Proxys aus historischen Verlaufsdaten der Zeitachse trainiert. Sie müssen nichts weiter tun, um das Modell zu trainieren. Apigee erstellt und trainiert automatisch Modelle aus den API-Daten der letzten sechs Stunden. Daher benötigt Apigee mindestens sechs Stunden an Daten für einen API-Proxy, um das Modell zu trainieren, bevor eine Anomalie protokolliert werden kann.

Das Ziel des Trainings besteht darin, die Genauigkeit des Modells zu verbessern, das dann an Verlaufsdaten getestet werden kann. Die Genauigkeit eines Modells lässt sich am einfachsten mit der Fehlerrate (der Summe von falsch positiven und falsch negativen Ergebnissen) geteilt durch die Gesamtzahl der vorhergesagten Ereignisse messen.

Anomalieereignisse loggen

Während der Laufzeit vergleicht „Vorgangsanomalien“ das aktuelle Verhalten Ihrer API-Proxys mit dem vom Modell vorhergesagten Verhalten. Mit Vorgangsanomalien kann dann ein bestimmter Konfidenzwert festgelegt werden, wenn ein Betriebswert den vorhergesagten Wert überschreitet. Das gilt zum Beispiel, wenn die Rate von 5xx-Fehlern die vom Modell vorhergesagte Rate überschreitet.

Wenn Apigee eine Anomalie erkennt, wird das Ereignis automatisch im Dashboard für Vorgangsanomalien protokolliert. Die im Dashboard angezeigte Liste der Ereignisse enthält alle erkannten Anomalien sowie ausgelöste Benachrichtigungen.