Registo

O FoxIDs regista avisos, erros, erros críticos e eventos por predefinição. As entradas de registo incluem um carimbo temporal e o contexto relevante da solicitação ou da identidade, como o endereço IP do cliente, quando disponível. Podem ser ativados rastreios e métricas adicionais por ambiente para fins de diagnóstico.

Resolução de erros do navegador

A página de erro do navegador apresenta uma mensagem genérica em caso de falhas inesperadas, juntamente com a hora e o identificador da operação, quando disponível. Se for possível identificar a sequência de início de sessão ou da ação na conta, a página apresenta também o respetivo identificador de sequência. Utilize o identificador da operação para encontrar o pedido que falhou e o identificador de sequência para acompanhar operações relacionadas nos registos do FoxIDs Control ou no destino de registo configurado. Situações conhecidas que permitem recuperação, como o tempo limite excedido no início de sessão, podem apresentar orientações específicas e uma opção para tentar novamente. Se uma funcionalidade não estiver disponível no plano atual, a página apresenta o nome do plano e orientações para mudar para um plano superior. Os fluxos de conta também podem fornecer uma mensagem de interface específica e localizada, por exemplo, sobre a falta de um número de telefone necessário para a autenticação de dois fatores.

As mensagens técnicas de exceção, os rastreios de pilha e os dados de diagnóstico do conector não são apresentados na página de erro genérica em nenhum ambiente de alojamento. Se a própria gestão de erros falhar, a página de recurso também mantém os detalhes técnicos nos registos. Consulte os registos de diagnóstico apenas com acesso de administrador autorizado; não partilhe o seu conteúdo com um chamador não autenticado.

Destinos de registo

Defina o destino do registo com Settings__Options__Log. FoxIDs suporta três opções:

• O Stdout grava registos na saída da consola. É adequado para pequenas implementações do Docker e do Kubernetes, nas quais a plataforma de alojamento recolhe os registos da consola.
• O OpenSearchAndStdoutErrors grava registos pesquisáveis no OpenSearch e também grava erros na saída da consola. É normalmente utilizado para implementações do Kubernetes.
• O ApplicationInsights envia registos pesquisáveis para o Azure Application Insights. É normalmente utilizado para implementações no Azure.

O FoxIDs Control pode pesquisar registos e dados de utilização e de auditoria quando OpenSearchAndStdoutErrors ou ApplicationInsights estiver configurado. Com Stdout, utilize as funcionalidades de registo fornecidas pela plataforma de alojamento.

Formato stdout e nível mínimo

O FoxIDs utiliza a configuração de logging padrão do .NET Console em Logging:Console para o output escrito em stdout. O formatador de texto simples é utilizado, a menos que esteja configurado outro formatador. O deployment Kubernetes fornecido seleciona o formatador JSON para que cada entrada de log possa ser recolhida como uma única linha estruturada.

Com o formatador JSON, o texto do log é escrito em Message, as propriedades contextuais como RequestId, RequestPath, tenant e ambiente são escritas como campos separados em State, e os detalhes das exceções são escritos em Exception. As métricas também incluem um valor numérico em State.Value. Por predefinição, as entradas JSON utilizam timestamps UTC no formato yyyy-MM-ddTHH:mm:ss.fffZ. O formatador simples mantém a representação de texto em várias linhas.

Defina o formatador JSON com uma variável de ambiente:

Logging__Console__FormatterName=json

Os valores predefinidos do timestamp podem ser substituídos através das opções padrão do formatador, por exemplo:

Logging__Console__FormatterOptions__TimestampFormat=yyyy-MM-ddTHH:mm:ssZ
Logging__Console__FormatterOptions__UseUtcTimestamp=true

O nível mínimo de logging do Console é Trace por predefinição, preservando todos os tipos de log ativados nas definições de log do ambiente FoxIDs. Pode aumentar o nível mínimo de forma independente para cada deployment, por exemplo:

Logging__Console__LogLevel__Default=Information

O nível mínimo afeta o output stdout da seguinte forma:

O nível mínimo de logging do Console é um filtro adicional. Não ativa traces nem métricas que estejam desativadas nas definições de log do ambiente.

Registos no FoxIDs Control

Abra Registos no FoxIDs Control Client para alternar entre registos operacionais, de utilização, registos de auditoria e definições de registos do ambiente.

Registos

O separador Registos permite pesquisar entradas nos registos operacionais. Selecione o intervalo de tempo e os tipos de registo e, opcionalmente, introduza um texto de pesquisa para restringir os resultados. Os erros e os avisos estão selecionados por predefinição. Num ambiente normal, os eventos também estão selecionados por predefinição, enquanto os rastreios e as métricas estão disponíveis quando tiverem sido ativados nas configurações de registo do ambiente.

Os pedidos rejeitados antes do encaminhamento para o tenant e o ambiente são classificados como pedidos rejeitados e excluídos dos eventos normais. No tenant principal, selecione pedidos rejeitados para os investigar pelo caminho do pedido, método HTTP e contexto de pedido disponível. Os pedidos rejeitados não estão disponíveis noutros tenants.

As entradas relacionadas estão agrupadas por sequência e operação, para que possa acompanhar um fluxo de autenticação ou um pedido e analisar os seus eventos, propriedades contextuais e exceções.

Utilização

O separador Utilizações resume a atividade para um período e intervalo de tempo selecionados. Pode incluir métodos de autenticação, utilizadores, inícios de sessão, pedidos de tokens, operações adicionais e chamadas Control API.

O âmbito de administração selecionado determina qual a utilização apresentada:

• Num ambiente normal, o resultado contém os dados de utilização relativos a esse ambiente.
• No ambiente principal de um inquilino, o resultado contém os dados de utilização relativos a todo o inquilino e pode ser limitado a um ambiente específico.
• No ambiente principal do inquilino principal, o resultado contém os dados de utilização relativos à implementação completa do FoxIDs e pode ser limitado a um inquilino e a um ambiente.

Registos de auditoria

O separador Auditoria regista a atividade dos utilizadores relevante para a segurança e as alterações administrativas. A pesquisa nos registos de auditoria está disponível com OpenSearchAndStdoutErrors e ApplicationInsights; não está disponível quando o destino dos registos é Stdout.

Selecione um intervalo de tempo de até sete dias e, opcionalmente, introduza texto de pesquisa. Uma pesquisa devolve até 300 dos registos correspondentes mais recentes e apresenta um aviso quando o resultado é truncado. O texto é pesquisado no nome do evento, tipo de auditoria, ação, identificadores do utilizador, método de autenticação, ID de registo ou de documento, tenant, ambiente e dados alterados.

Os registos de auditoria utilizam os seguintes tipos:

Cada registo apresenta o tipo de auditoria e o contexto disponível. A atividade do utilizador pode incluir o ID do utilizador, endereço de e-mail, número de telefone, nome de utilizador, ID da sessão e método de autenticação. Apenas são registados os identificadores disponíveis nas claims de início de sessão ou na sessão. O registo de uma aplicação de autenticação também inclui o respetivo RegistrationId.

Num registo Data, DataType identifica o tipo de dados de configuração, DocumentId identifica o item afetado e Action é Create, Update, Save ou Delete. Os dados JSON formatados mostram os valores alterados com os valores before e after, quando aplicável. As propriedades confidenciais, como segredos, hashes, nonces e chaves, são mascaradas.

O âmbito de administração selecionado determina os registos de auditoria que podem ser pesquisados:

• Num ambiente normal, o resultado contém registos desse ambiente.
• No ambiente principal de um tenant, o resultado contém registos do tenant e pode ser limitado a um ambiente específico.
• No ambiente principal do tenant principal, o resultado contém registos de toda a implementação do FoxIDs e pode ser limitado a um tenant e ambiente.

Definições de registo

Abra Registos > Definições para configurar os detalhes de diagnóstico registados para o ambiente selecionado:

• Rastreio de informações de registo regista detalhes sobre as sequências de início e fim de sessão.
• Rastreio de reivindicações de registo regista as reivindicações recebidas e reencaminhadas ou emitidas por métodos de autenticação e registos de aplicações.
• Rastreio de mensagens de registo regista as mensagens de protocolo em bruto recebidas e enviadas.
• Métrica de registo regista os tempos de resposta e a taxa de transferência.

Os avisos, erros, erros críticos e eventos continuam a ser registados independentemente destas definições.

Os registos de reivindicações e mensagens podem conter dados pessoais, tokens e outros conteúdos sensíveis do protocolo. Ative-os apenas quando necessário para fins de diagnóstico, restrinja o acesso ao repositório de registos e aplique um período de retenção adequado.

Fluxo de registos

Um fluxo de registos encaminha tipos de registos selecionados para um repositório externo, independentemente do destino de registos principal configurado. Por exemplo, adicione um fluxo de registos do Azure Application Insights e selecione quais os tipos de registos que o FoxIDs deve enviar.

Documentação relacionada

• Consultar logs, auditoria e uso com o Control API- Monitorização e verificações de integridade
• FoxIDs Control Client e API
• Implementação no Kubernetes
• Implementação no Azure
• Transformações de reivindicações e rastreios de diagnóstico de reivindicações