Módulo Log

• Definição

• Configuração do módulo

• Configuração da mensagem

Definição

O módulo ferramental "Log", módulo padrão da plataforma para a utilização em qualquer fluxo, foi criado para possibilitar a identificação do que está ocorrendo em cada uma das operações de um fluxo, auxiliando na resolução de problemas com sistemas externos.

Durante a execução de um fluxo, você pode obter diversas respostas de módulos e sistemas externos utilizados no fluxo. Algumas dessas situações são automaticamente tratadas dentro do fluxo, mas outras requerem uma notificação. O módulo "Log" cumpre este propósito, registrando essas situações com todas as informações pertinentes e alertando da forma desejada.

Como exemplo, se você solicitasse a inclusão em uma empresa X, a mesma chamada poderia retornar:

1. 200 com sucesso

2. 200 com código de erro de aplicação (código não válido)

3. 500 com código de erro de servidor

A situação 2 ocorre em um loop, durante a inserção de centenas de produtos. Com o módulo Log, no lugar de interromper o fluxo, o módulo "Log" registra os produtos que obtiveram esse tipo de erro, para posterior análise.

Este é apenas um exemplo, que mostra o valor deste módulo. Existem diversas outras situações em que existe o interesse de registrar quais informações estão sendo manipuladas.

Configuração do módulo Log

O módulo "Log" é composto por uma única operação (Log events), que permite a seleção de até três locais de armazenamento dos logs, a seleção das informações que você deseja incluir e a criação de parâmetros, que também serão utilizados na mensagem de log.

Saiba sobre o Cabeçalho do Módulo aqui.

Configuração da mensagem

Em "Configuração da mensagem" você consegue selecionar ou remover a seleção o de cada item, como o destino, conteúdo da mensagem, etc.

Tela de configuração

Sendo que:

• Destino: envia os logs para o local informado; caso não você não selecione uma opção, os logs aparecerão na aba Componentes do Logger (módulo Log)

  • Local: armazena os logs no mesmo repositório em que são armazenadas as mensagens de logs de execução dos módulos (Logger, aba Logs)

  • Syslog: servidor Syslog informado (requer configuração adicional)

  • E-mail: endereço de e-mail informado (requer configuração adicional)

• Conteúdo da mensagem de LOG (caixas de seleção): aqui você deverá escolher dentre as informações opcionais que podem ser exibidas na mensagem de log, além de poder escolher o nível de log

  • ID da integração: identificação única da integração

  • ID do fluxo: identificação única do fluxo

  • ID de execução: identificação única de cada execução do fluxo

  • ID do componente: arraste para este campo um parâmetro da operação desejada

  • Gravidade: nível de gravidade do log que será exibido (CRITICAL, ERROR, WARNING, DEBUG); se esta opção estiver desmarcada, DEBUG será utilizado por padrão

  • Timestamp: registro da data e hora de ocorrência de um determinado evento no fluxo

    • Formato da data (JSONATA): aqui você pode mudar o formato da data

    • Timezone (fuso horário): o campo timezone (fuso horário) segue o formato "±HHMM", em que ± é o sinal de mais ou menos e HHMM é a diferença em horas e minutos, em relação ao UTC. A diferença positiva é para fusos horários a leste do UTC, enquanto que a negativa é para fusos horários a oeste do UTC. Exemplo: digite "-0300" para "GMT-3".

• Parâmetro: aqui você pode criar/remover um ou mais parâmetros de log para serem exibidos na mensagem, sendo possível arrastar parâmetros de outros módulos e até mesmo utilizar uma SMOP.

Para finalizar a configuração do módulo, clique em "Salvar".