Systemdiagnosen durchführen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Apigee stellt Systemdiagnosen auf verschiedenen Ebenen bereit, die Sie je nach Anwendungsfall nutzen können.

  1. Systemdiagnose auf regionaler Ebene / Apigee-Instanz: Gibt den Zustand der gesamten Apigee-Instanz in einer Region zurück.
  2. Systemdiagnosen auf Umgebungsebene: Gibt den Zustand einer bestimmten Umgebung in der Apigee-Instanz zurück.
  3. Benutzerdefinierte Systemdiagnose über einen API-Proxy:Für komplexe Anwendungsfälle können Sie einen dedizierten API-Proxy als benutzerdefinierten Systemdiagnose-Endpunkt konfigurieren.

Systemdiagnose auf regionaler Ebene ausführen

Apigee bietet eine Systemdiagnose auf regionaler Ebene bzw. für Apigee-Instanzen, um den Gesamtstatus der Apigee-Instanz in einer bestimmten Region zu bewerten. Dieses Systemdiagnosemuster wird häufig von Load Balancern verwendet, um den Status von Apigee-Instanzen zu ermitteln und regionale Failover auszuführen. Sie können eine Systemdiagnose auf regionaler Ebene ausführen, indem Sie die Anfrage folgendermaßen erstellen:

  • Pfad der Systemdiagnose: /healthz/ingress
  • Fügen Sie den Anfrageheader hinzu: User-Agent: GoogleHC.
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress
Apigee Ingress is healthy
 wobei $HOST der Hostname ist, der in der Apigee-Umgebungsgruppe definiert ist und vom Load Balancer bereitgestellt wird.

Systemdiagnose auf Umgebungsebene ausführen

Apigee bietet eine Systemdiagnose auf Umgebungsebene, um den Zustand einer bestimmten Umgebung zu bewerten, die von der Apigee-Instanz bereitgestellt wird. Dieses Systemdiagnosemuster wird bevorzugt, wenn Sie regionale Failover basierend auf dem Zustand bestimmter kritischer/ausgewählter Umgebungen ausführen möchten. Sie können eine Systemdiagnose auf Umgebungsebene ausführen, indem Sie einen beliebigen gültigen API-Proxy in einer Umgebung aufrufen. Dazu erstellen Sie die Anfrage folgendermaßen:

  • Stellen Sie dem Proxy-Basispfad /healthz/ voran.
  • Fügen Sie den Anfrageheader hinzu: User-Agent: GoogleHC.

Angenommen, /catalog ist ein gültiger Proxy-Basispfad, der in einer Umgebung bereitgestellt wird. Für eine Systemdiagnose rufen Sie den Proxy so auf: 

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready
 wobei $HOST der Hostname ist, der in der Apigee-Umgebungsgruppe definiert ist und vom Load Balancer bereitgestellt wird.

Benutzerdefinierte Systemdiagnose über einen API-Proxy ausführen

Wenn Sie zusätzliche Validierungen ausführen möchten, können Sie eine benutzerdefinierte Systemdiagnoselogik in einem API-Proxy definieren, der in einer Umgebung bereitgestellt wird. Beispielsweise kann die Systemdiagnose fehlschlagen, wenn mehrere Umgebungen nicht erreichbar sind. Alternativ können Sie die Systemdiagnose auf Grundlage des Zielzustands oder der Latenz fehlschlagen.

In diesem Fall können Sie die Systemdiagnose mit einem regulären API-Aufruf an diesen Proxy senden.

Angenommen, Sie möchten den Zustand einer Umgebung namens prod prüfen. Stellen Sie einen API-Proxy in dieser Umgebung mit dem Basispfad /healthcheck-prod bereit. Wenn Sie den Zustand der prod-Umgebung prüfen möchten, die von der Apigee-Instanz bereitgestellt wird, rufen Sie den Proxy so auf: 

$ curl https://$HOST/healthcheck-prod
 wobei $HOST der Hostname ist, der in der Apigee-Umgebungsgruppe definiert ist und vom Load Balancer bereitgestellt wird.

Verwendungshinweise

Systemdiagnosen auf regionaler und Umgebungsebene:Wenn sie von den Google Cloud-Load Balancern ausgeführt werden, legt der Load Balancer den richtigen User-Agent-Header fest. Wenn Ihr eigener Client diese API-Aufrufe für die Systemdiagnose verwendet, müssen Sie prüfen, ob die richtige User-Agent festgelegt ist.

Apigee Hybrid: Die Systemdiagnose ist nur ab Version 1.4 verfügbar.