Monitorizar o estado do FoxIDs e os registos do

Os operadores da plataforma podem monitorizar a disponibilidade, as dependências, a atividade de início de sessão e os erros do FoxIDs, combinando verificações de integridade com registos estruturados. Utilize o sistema de monitorização mais adequado à implementação:

  • As implementações do App Service com o código Azure podem enviar registos para Azure Log Analytics ou Application Insights.
  • As implementações Docker e Kubernetes gravam os registos dos contentores no stdout, onde o coletor de registos da plataforma os pode recolher.
  • Qualquer implementação suportada pode configurar o Azure Application Insights ou o Log Analytics como um fluxo de registos FoxIDs.

Crie alertas e painéis de controlo relativos à disponibilidade dos serviços, ao consumo de recursos, a falhas de início de sessão e a erros nas aplicações. Entre as verificações de disponibilidade úteis incluem-se:

  • 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

Parâmetros de consulta do relatório de verificação de saúde

O ponto de extremidade /health aceita parâmetros de consulta opcionais que permitem verificar dependências específicas individualmente. Quando não são fornecidos parâmetros, o ponto de extremidade devolve 200 OK para confirmar que o site está a funcionar, sem validar os serviços externos. Utilize um ou mais dos seguintes parâmetros (não se distingue entre maiúsculas e minúsculas):

Parâmetro Descrição Funciona para
?db Verifica o armazenamento de dados, garantindo que o documento do inquilino principal existe. Todas as bases de dados suportadas.
?log Executa uma verificação de registo. O OpenSearch valida os aliases de rollover; o Application Insights envia um rastreio. Quando o registo está configurado para o OpenSearch ou para o Application Insights.
?cache Executa um comando PING do Redis. Quando o cache do Redis está configurado.
?all Verifica automaticamente todos os componentes que estão ativados na configuração.

Se for solicitado um componente que não está disponível na configuração atual, o ponto de extremidade devolve 400 Bad Request com a mensagem fixa Requested health check is unavailable.. Os parâmetros de consulta desconhecidos são ignorados. Se algum dos componentes solicitados não estiver em bom estado, o ponto de extremidade devolve 503 Service Unavailable e apresenta uma lista das verificações que falharam; caso contrário, devolve 200 OK.

As respostas das verificações de estado incluem o estado geral, a hora da verificação e os resultados dos componentes. Cada componente usa uma das mensagens fixas Health check succeeded., Health check failed. ou Health check skipped.. As respostas não incluem mensagens de exceção, rastreios de pilha, respostas das dependências ou detalhes de configuração. Utilize os registos para investigar falhas.