Övervaka FoxIDs:s driftstatus och loggar för

Plattformsoperatörer kan övervaka FoxIDs:s tillgänglighet, beroenden, inloggningsaktivitet och fel genom att kombinera hälsokontroller med strukturerade loggar. Använd det övervakningssystem som passar den aktuella driftsmiljön:

  • App Service-distributioner med ID: Azure kan skicka loggar till Azure Log Analytics eller Application Insights.
  • I installationerna av Docker och Kubernetes skrivs containerloggarna till stdout, där plattformens loggsamlare kan hämta dem.
  • I alla stödda driftsmiljöer kan man konfigurera Azure Application Insights eller Log Analytics som en FoxIDs-loggström.

Skapa varningar och översiktspaneler för tjänstens tillgänglighet, resursförbrukning, inloggningsfel och applikationsfel. Exempel på användbara tillgänglighetskontroller är:

  • 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

Parametrar för hälsokontroll

Endpunkten /health accepterar valfria sökparametrar som gör det möjligt att kontrollera specifika beroenden var för sig. Om inga parametrar anges returnerar endpunkten 200 OK för att bekräfta att webbplatsen är igång, utan att validera externa tjänster. Använd en eller flera av följande parametrar (skiftlägesokänsligt):

Parameter Beskrivning Fungerar för
?db Kontrollerar datalagringen genom att säkerställa att huvudhyresgästdokumentet finns. Alla databaser som stöds.
?log Utför en loggningskontroll. OpenSearch validerar rollover-alias; Application Insights skickar en spårningsrapport. När loggning är konfigurerad för OpenSearch eller Application Insights.
?cache Utför ett Redis PING-kommando. När Redis-cachen är konfigurerad.
?all Kontrollerar automatiskt alla komponenter som är aktiverade i konfigurationen.

Om en komponent som inte är tillgänglig i den aktuella konfigurationen begärs, returneras 400 Bad Request med det fasta meddelandet Requested health check is unavailable.. Okända frågeparametrar ignoreras. Om någon av de begärda komponenterna inte fungerar korrekt returnerar slutpunkten 503 Service Unavailable och listar de kontroller som misslyckats; annars returneras 200 OK.

Svar från hälsokontroller innehåller den övergripande statusen, tidpunkten för kontrollen och resultaten för de enskilda komponenterna. Varje komponent använder ett av de fasta meddelandena Health check succeeded., Health check failed. eller Health check skipped.. Svaren innehåller inte undantagsmeddelanden, stackspår, svar från beroenden eller konfigurationsdetaljer. Använd loggarna för att undersöka fel.