Logs de monitoramento

Introdução

O monitoramento dos logs gerados durante o processamento de fluxos é essencial para a manutenção e otimização das operações no Workspace. O Floui disponibiliza uma interface que permite a consulta detalhada desses logs, auxiliando na identificação de possíveis erros, na análise de desempenho e no acompanhamento das execuções diárias.

Logs de monitoramento

Para acessar a tela de Logs de Monitoramento, acesse o Workspace Floui, no menu lateral, na seção Monitoramento, clique em Logs de Monitoramento.

Por meio desta tela é possível visualizar todas as informações geradas pelo processamento de fluxos, além de filtros relevantes que podem ser aplicados para consultar registros específicos.

A tela de monitoramento pode ser separada em 3 diferentes seções, cada uma contendo funcionalidades e informações relevantes para o monitoramento dos processos executados. Sendo elas:

• Informações gerais do Workspace.

• Gerenciamento de filtros.

• Listagem e visualização dos logs.

Informações gerais do workspace

Esta seção contem as informações de operação do seu Workspace. Informando a disponibilidade do Workspace, fluxos em execução naquele momento, processos agendados e prontos para execução, filas internas cadastradas (em espera ou em execução) e o endpoint do ambiente atual.

Gerenciamento de filtros

Por esta seção, é possível gerenciar os filtros para realizar a consulta de logs específicos oriundos dos processamentos executados, além dos filtros selecionáveis a ferramenta disponibiliza algumas funcionalidades que visam a experiência do usuário no monitoramento.

São disponibilizados os seguintes filtros e funcionalidades:

Listagem e visualização de logs

Seção principal por onde os logs gerados poderão ser visualizados. Conterá logs internos do Workspace e logs gerados a partir dos fluxos.

Cada log gerado possui as seguintes colunas:

Para obter informações mais detalhadas sobre um log específico, clique no botão Detalhes ao lado do log. Nesta tela, é possível visualizar a mensagem completa do log gerado e demais dados do registro, facilitando a análise e o diagnóstico de possíveis falhas ou comportamentos inesperados no fluxo.

Tipos de logs de monitoramento

A ferramenta armazena dois tipos de logs: Eventos Internos e logs de Usuários.

Os logs de Eventos Internos são usados para identificar registros internos de ínicio e finalização do fluxo, além de possíveis eventos de exceção que podem ser gerados na execução. Consulte nosso Glossário para saber mais sobre Eventos Internos.

Logs de Usuários referem-se a registros que são aplicados de forma pelo usuário em algum fluxo. Estes logs podem ser usados para registrar possíveis ramificações que ocorreram na execução do fluxo, registrar erros e sucessos na execução, entre várias outras possibilidades de acordo com o contexto da operação e regras de negócio. Estes logs são totalmente customizáveis, permitindo que seja registrado somente informações relevantes para o contexto. Para saber mais sobre como adicionar registros customizáveis, acesse a seção Geração de logs customizados.

Geração de logs customizados em fluxos

A plataforma Floui disponibiliza um conector próprio para a captura de logs de execução, este conector pode ser inserido em qualquer ramificação e processamento realizado pelo fluxo. O uso deste conector permite refinar o conteúdo dos logs, fornecendo informações claras sobre a execução do fluxo.

Por meio do conector Logger é possível customizar os dados que serão adicionados ao log, através do acesso ao objeto message, que contem todas as informações de determinada execução do fluxo. Utilize a notação Mustache para acessar, de forma dinâmica, estes dados.

Para saber mais sobre o conector Logger, consulte sua documentação oficial.

Boas práticas na estrutura de logs

A utilização inteligente do conector Logger é um grande aliado no monitoramento de processos realizados, na operação diária, além de fornecer informações claras sobre possíveis comportamentos ocorridos durante a execução do fluxo.

Para isso, seguem algumas boas práticas ao configurar o conector Logger, para que possam ser gerados logs com as informações relevantes para o contexto e evitando poluição de dados:

• Evite capturar o objeto msg completo no conector Logger: O objeto message (msg) contem todos os dados gerados no contexto de execução do fluxo. Ao enviar o objeto message completo no log poderá causar uma poluição de dados que não são relevantes para serem registrados. Busque tratar o objeto message, dentro do fluxo antes de enviar para o log de monitoramento ou utilize a notação Mustache para montar logs de fácil entendimento.

• Adicione um título ao seu log: Busque adicionar um título no log gerado pelo conector Logger. Isto facilita o entendimento de possíveis comportamentos e a execução de ramificações que podem haver em um fluxo.

• Atente-se a frequência em que os logs são gerados pelo fluxo: A geração constante de logs em um curto período de tempo pode atrapalhar a sua operação, além de comprometer a saúde do seu Workspace. Verifique por fluxos que geram logs em alta frequência e busque otimizá-los.

• Busque alternativas ao conector Logger: Em casos onde é necessário testar um processamento ou armazenar informações não relevantes, utilize o conector Debugger. Os logs gerados por este conector são armazenados de forma temporária no fluxo e não são enviados para o Log de Monitoramento. Diferente do conector Logger, o conector Debugger não possui limitação de tamanho máximo de log. Consulte a documentação do conector Debugger para saber mais.

Política de retenção

Os registros do log de monitoramento seguem a política de retenção de logs, logo são armazenados temporariamente no Workspace e deletados ao atingir a data limite. Por padrão os logs são armazenados por 90 dias até serem removidos. Esta limpeza visa manter a saúde do ambiente.