# 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.

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2F2BpwASI330mV3ArO3VI4%2Fimage.png?alt=media&#x26;token=8d57f8a7-2bfe-4ca1-b56b-bccc60ac0473" alt=""><figcaption><p>Logs de monitoramento</p></figcaption></figure>

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.

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2F3bcdGGqBA7FsDtG4N6Bl%2Fimage.png?alt=media&#x26;token=db94ddb1-b3b7-4cbe-8760-c0403dcceb51" alt=""><figcaption><p>Informações gerais do Workspace</p></figcaption></figure>

### 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.&#x20;

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2Ff2hSoHB6xb9ncOrfNrl9%2Fimage.png?alt=media&#x26;token=824f62cf-627c-4a7c-becc-4b1de6505b87" alt=""><figcaption><p>Filtros em logs de monitoramento</p></figcaption></figure>

São disponibilizados os seguintes filtros e funcionalidades:

<table data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Período</strong></td><td>Usado para filtrar logs a partir de um período de tempo. Fornece opções pré definidas e, ao clicar em Personalizado, é possível aplicar o período que deseja filtrar.</td></tr><tr><td><strong>Auto Refresh</strong></td><td>Opção para que a listagem de logs seja atualizada de forma automática após um determinado período de tempo, permitindo os últimos registros gerados sejam exibidos.</td></tr><tr><td><strong>Atualizar</strong></td><td>Opção para atualizar, de forma manual, a listagem de logs, permitindo que os últimos registros sejam exibidos.</td></tr><tr><td><strong>Remover filtros</strong></td><td>Remove todos os filtros aplicados sobre os logs de monitoramento.</td></tr><tr><td><strong>Termo de busca</strong></td><td>Busca por um termo específico dentro dos logs de monitoramento.</td></tr><tr><td><strong>Execution ID</strong></td><td>Cada execução de fluxo possuí um identificador próprio associado. Este campo permite que possa ser visualizado os logs de uma determinada execução.</td></tr><tr><td><strong>Flow</strong></td><td>Permite filtrar pelos registros gerados por um fluxo específico.</td></tr><tr><td><strong>Tipo do Log</strong></td><td>Permite selecionar entre diferentes tipos de log de monitoramento. Para saber mais sobre os tipos de log, consulte a seção <a href="#tipos-de-logs-de-monitoramento">Tipos de logs de Monitoramento</a>,</td></tr></tbody></table>

### 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.

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FxUOQeoZ9T43L2QobIVkv%2Fimage.png?alt=media&#x26;token=eb979ee6-a500-4cd1-bbde-d34b91953f42" alt=""><figcaption><p>Listagem de logs</p></figcaption></figure>

Cada log gerado possui as seguintes colunas:

<table data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Mensagem</td><td>Contém a mensagem do registro capturado, geralmente em formato JSON ou String. Caso configurado no conector Logger também poderá apresentar um título.</td></tr><tr><td>ID de Execução</td><td>Cada execução de fluxo possuí um identificador próprio associado. Esta coluna informa o identificador da execução que gerou este registro.</td></tr><tr><td>Tipo do Log</td><td>Informa o tipo de log gerado pelo fluxo. Para saber mais sobre os tipos de log, consulte a seção <a href="#tipos-de-logs-de-monitoramento">Tipos de logs de Monitoramento</a>,</td></tr><tr><td>Flow</td><td>Nome do fluxo que gerou este registro.</td></tr><tr><td>Timestamp</td><td>Data e horário em que o registro foi gerado.</td></tr></tbody></table>

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.

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FEmJsHeORaqW76y3PS2mS%2Fimage.png?alt=media&#x26;token=e2bccc52-4ad5-4963-bb35-d078fcf70971" alt=""><figcaption><p>Visualização detalhada de log</p></figcaption></figure>

## Tipos de logs de monitoramento

A ferramenta armazena dois tipos de logs: Eventos Internos e logs de Usuários.&#x20;

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](https://docs.floui.io/guia/docs/glossario#eventos-internos) 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](#geracao-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.&#x20;

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](https://docs.floui.io/guia/conectores/categorias/monitoramento/logger).

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2F4y3Npbj49dRNohCaS8dR%2Fimage.png?alt=media&#x26;token=cdb48ee4-935f-463b-ae50-d2da97fb2e10" alt=""><figcaption><p>Conector Logger</p></figcaption></figure>

### 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.&#x20;

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](https://docs.floui.io/guia/funcionalidades/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.&#x20;
* 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](https://docs.floui.io/guia/conectores/categorias/monitoramento/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.
