Sie lesen die Dokumentation zu Apigee X.
Apigee Edge-Dokumentation aufrufen
Apigee stellt Standard-Systemdiagnosen auf Umgebungsebene bereit, die den Zustand des Message Processors (MP) dieser Umgebung zurückgeben. Für komplexe Anwendungsfälle können Sie einen dedizierten API-Proxy als benutzerdefinierten Systemdiagnose-Endpunkt konfigurieren.
Standardmäßige Systemdiagnose auf Umgebungsebene ausführen
Sie können eine Systemdiagnose 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 Header
User-Agent: GoogleHC/*hinzu.
Beispiel: /catalog ist ein gültiger Proxy-Basispfad. Für eine Systemdiagnose rufen Sie den Proxy so auf:
curl -H 'User-Agent: GoogleHC/' https://api.foo.com/healthz/catalog Server Ready
Dieser Proxy-API-Aufruf führt den Proxy nicht aus. Der Basispfad /catalog wird nur zum Weiterleiten der API an die richtige Umgebung verwendet. Wenn der MP fehlerfrei ist, wird die Antwort Server Ready zurückgegeben.
Benutzerdefinierte Systemdiagnose auf Umgebungsebene ausführen
Sie können 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.
Rufen Sie einfach den Proxy auf, um den Zustand der MP-Datei der Produktionsumgebung zu prüfen. Beispiel:
curl https://api.foo.com/healthcheck-prod
Verwendungshinweise
Bei Apigee Hybrid ist die Systemdiagnose nur ab der Version 1.4 verfügbar.
Für eine benutzerdefinierte Systemdiagnose müssen Sie den Header User-Agent nicht angeben.
Der Header User-Agent ist für den standardmäßigen Systemdiagnosetest erforderlich. Wenn die Systemdiagnose vom Google Cloud-Load-Balancer Externe HTTP(s) genutzt wird, legt der Load-Balancer den richtigen User-Agent-Header fest. Wenn Ihr eigener Client den Standard-API-Aufruf der Systemdiagnose verwendet, müssen Sie prüfen, ob die richtige User-Agent festgelegt ist.