Status von FoxIDs überwachen und Protokolle von

Plattformbetreiber können die Verfügbarkeit, Abhängigkeiten, Anmeldeaktivitäten und Fehler von FoxIDs überwachen, indem sie Zustandsprüfungen mit strukturierten Protokollen kombinieren. Verwenden Sie das Überwachungssystem, das zur jeweiligen Bereitstellung passt:

  • Azure-App-Service-Bereitstellungen können Protokolle an Azure Log Analytics oder Application Insights senden.
  • Bei den Bereitstellungen Docker und Kubernetes werden die Containerprotokolle in stdout geschrieben, wo sie vom Plattform-Protokollsammler erfasst werden können.
  • In jeder unterstützten Bereitstellung können Azure Application Insights oder Log Analytics als FoxIDs-Protokollstrom konfiguriert werden.

Erstellen Sie Warnmeldungen und Dashboards für die Serviceverfügbarkeit, den Ressourcenverbrauch, Anmeldefehler und Anwendungsfehler. Zu den nützlichen Verfügbarkeitsprüfungen gehören:

  • https://--foxids-domain--/health
  • https://--foxids-domain--/master/master/foxids_control_client(*)/.well-known/openid-configuration
  • https://--foxids-control-domain--/master
  • https://--foxids-control-domain--/api/health
  • https://--foxids-control-domain--/api/swagger/v2/swagger.json

Abfrageparameter für den Gesundheitscheck

Der Endpunkt /health akzeptiert optionale Abfrageparameter, mit denen Sie bestimmte Abhängigkeiten einzeln überprüfen können. Werden keine Parameter angegeben, gibt der Endpunkt den Wert 200 OK zurück, um zu bestätigen, dass die Website läuft, ohne dabei externe Dienste zu überprüfen. Verwenden Sie einen oder mehrere der folgenden Parameter (Groß-/Kleinschreibung spielt keine Rolle):

Parameter Beschreibung Gilt für
?db Überprüft die Datenspeicherung, indem sichergestellt wird, dass das Master-Tenant-Dokument vorhanden ist. Alle unterstützten Datenbanken.
?log Führt eine Protokollierungsprüfung durch. OpenSearch überprüft Rollover-Aliase; Application Insights sendet eine Ablaufverfolgung. Wenn die Protokollierung für OpenSearch oder Application Insights konfiguriert ist.
?cache Führt einen Redis-PING-Befehl aus. Wenn der Redis-Cache konfiguriert ist.
?all Überprüft automatisch jede Komponente, die in der Konfiguration aktiviert ist.

Wird eine Komponente angefordert, die in der aktuellen Konfiguration nicht verfügbar ist, wird 400 Bad Request mit der festen Meldung Requested health check is unavailable. zurückgegeben. Unbekannte Abfrageparameter werden ignoriert. Ist eine der angeforderten Komponenten fehlerhaft, gibt der Endpunkt 503 Service Unavailable zurück und listet die fehlgeschlagenen Prüfungen auf; andernfalls gibt er 200 OK zurück.

Antworten auf Integritätsprüfungen enthalten den Gesamtstatus, den Prüfzeitpunkt und die Ergebnisse der einzelnen Komponenten. Jede Komponente verwendet eine der festen Meldungen Health check succeeded., Health check failed. oder Health check skipped.. Die Antworten enthalten keine Ausnahmemeldungen, Stapelüberwachungen, Antworten von Abhängigkeiten oder Konfigurationsdetails. Verwenden Sie die Protokolle, um Fehler zu untersuchen.