Monitor FoxIDs health and logs

Platform operators can monitor FoxIDs availability, dependencies, login activity and errors by combining health checks with structured logs. Use the monitoring system that fits the deployment:

  • Azure App Service deployments can send logs to Azure Log Analytics or Application Insights.
  • Docker and Kubernetes deployments write container logs to stdout, where the platform log collector can ingest them.
  • Any supported deployment can configure Azure Application Insights or Log Analytics as a FoxIDs log stream.

Create alerts and dashboards for service availability, resource consumption, login failures and application errors. Useful availability checks include:

  • 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

Health check query parameters

The /health endpoint accepts optional query parameters that allow you to verify specific dependencies individually. When no parameters are supplied, the endpoint returns 200 OK to confirm the site is running without validating external services.
Use one or more of the following parameters (case-insensitive):

Parameter Description Works for
?db Verifies data storage by ensuring the master tenant document exists. All supported databases.
?log Runs a logging check. OpenSearch validates rollover aliases; Application Insights sends a trace. When logging is configured for OpenSearch or Application Insights.
?cache Executes a Redis PING command. When Redis cache is configured.
?all Automatically checks every component that is enabled in configuration.

An invalid component name returns 400 Bad Request with a JSON response describing the issue. If any requested component is unhealthy, the endpoint returns 503 Service Unavailable and lists the failing checks.