Overvåk tilstanden til FoxIDs og loggene til

Plattformoperatører kan overvåke tilgjengeligheten, avhengighetene, påloggingsaktiviteten og feilene i FoxIDs ved å kombinere tilstandskontroller med strukturerte logger. Bruk det overvåkingssystemet som passer best til distribusjonen:

  • App Service-distribusjoner med ID-en Azure kan sende logger til Azure Log Analytics eller Application Insights.
  • Distribusjonene Docker og Kubernetes skriver containerlogger til stdout, hvor plattformens logginnsamler kan hente dem inn.
  • Alle støttede distribusjoner kan konfigurere Azure Application Insights eller Log Analytics som en FoxIDs-loggstrøm.

Opprett varsler og oversiktssider for tjenestetilgjengelighet, ressursforbruk, innloggingsfeil og applikasjonsfeil. Nyttige tilgjengelighetskontroller inkluderer:

  • 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

Spørringsparametere for helsesjekk

Endepunktet /health godtar valgfrie spørringsparametere som lar deg kontrollere bestemte avhengigheter hver for seg. Når ingen parametere angis, returnerer endepunktet 200 OK for å bekrefte at nettstedet er i drift, uten å validere eksterne tjenester. Bruk én eller flere av følgende parametere (skiller ikke mellom store og små bokstaver):

Parameter Beskrivelse Fungerer for
?db Kontrollerer datalagringen ved å sikre at hoveddokumentet for leietakeren finnes. Alle støttede databaser.
?log Utfører en loggkontroll. OpenSearch validerer rollover-aliaser; Application Insights sender en sporingsmelding. Når loggføring er konfigurert for OpenSearch eller Application Insights.
?cache Utfører en Redis PING-kommando. Når Redis-cachen er konfigurert.
?all Kontrollerer automatisk alle komponenter som er aktivert i konfigurasjonen.

Hvis det forespørres en komponent som ikke er tilgjengelig i den gjeldende konfigurasjonen, returneres 400 Bad Request med den faste meldingen Requested health check is unavailable.. Ukjente spørringsparametere ignoreres. Hvis en av de forespurte komponentene ikke fungerer som den skal, returnerer endepunktet 503 Service Unavailable og viser de mislykkede kontrollene; ellers returneres 200 OK.

Svar fra helsesjekker inneholder den samlede statusen, tidspunktet for kontrollen og resultatene for de enkelte komponentene. Hver komponent bruker en av de faste meldingene Health check succeeded., Health check failed. eller Health check skipped.. Svarene inneholder ikke unntaksmeldinger, stakkspor, svar fra avhengigheter eller konfigurasjonsdetaljer. Bruk loggene til å undersøke feil.