Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
titleAtenção

Esta página foi revisada para considerar as configurações da atualização Waterdrop (Página destinada a atualizações 1.6.4).Caso possua uma atualização 1.6.0 à 1.6.3 acesse: Como realizar a gestão de logs do fluig da release 1.6.0 a 1.6.3?0 e superiores do fluig.

Para atualizações 1.5.13 ou inferiorinferiores, acesse: Como realizar a gestão de logs do fluig na release 1.5.13 e inferiores?

...

Como funciona?

As configurações de de log são  são realizadas por instalação da plataforma e são definidas no arquivo 'domain.xml' localizado em [Instalação fluig]/appserver/domain/configuration.

...

O 'handler' é responsável pela forma de processamento/armazenamento dos registros de log log, enquanto o 'logger' é responsável por definir o nível de um pacote específico e por qual(is) 'handler(s)' este pacote será tratado.

Por exemplo, o 'handler' do arquivo de de log padrão  padrão da plataforma (server.log) possui a seguinte configuração:

...

Basicamente esta configuração define que o arquivo de de log definido  definido na propriedade propriedade <file> (server.log), será rotacionado no final de cada dia, ou seja, o conteúdo que estava no arquivo será salvo em outro arquivo contendo a data como sufixo, seguindo o padrão definido na propriedade propriedade <suffix>, e o arquivo original será zerado para registrar as próximas mensagens. 

É importante verificar que a propriedade propriedade <level> deste  deste 'handler' possui, por padrão, o valor 'INFO'. Isso significa que este 'handler' irá registrar apenas mensagens de nível "INFO" ou superior. Sendo assim, mesmo que existam pacotes enviando mensagens em nível de 'DEBUG', eles não serão registrados, pois 'DEBUG' é um nível mais baixo que 'INFO'. Caso deseje visualizar mensagens em nível de 'DEBUG' no arquivo 'server.log', é necessário primeiramente alterar a configuração de '<level name="INFO"/>' para '<level name="DEBUG"/>'.

...

Cada configuração de 'logger' está  está atrelada à um ou mais 'handlers'. Quando esta informação não é configurada na declaração de um 'logger', é considerada a configuração realizada para o 'root-logger', que no caso do fluig possui a configuração abaixo:

...

Neste caso, todos os 'loggers' que não definirem um 'handler' específico, serão processados por estes três 'handlers: CONSOLE' (caso seja iniciado via script no terminal do sistema operacional), 'FILE' (arquivo server.log) e 'USERLOGGING' (ver ver aqui).

A configuração de um 'logger' normalmente  normalmente é feita conforme abaixo:

Bloco de código
languagexml
themeEclipse
titledomain.xml
<logger category="io.undertow.request">
    <level name="FATAL"/>
</logger>
  • O parâmetro 'category' indica o pacote ou nome completo da classe que este 'logger' está configurando.
  • O parâmetro 'level' indica o nível mínimo das mensagens que serão apresentadas para esta categoria (pacote ou classe). Neste caso, as mensagens de log enviadas pelo pacote 'io.undertow.request' serão registradas apenas se forem do nível 'FATAL'.


Configuração via

...

interface de gerenciamento do servidor de aplicação

Usuário do Servidor de Aplicação

Caso não possua um usuário de gerenciamento do servidor de aplicação, é necessário criá-lo:

  1. No prompt de comando do Windows ou no console do Linux, navegue até o diretório bin do servidor de aplicação ([Instalação do fluig]/appserver/bin);
  2. Executar o script add-user.bat ou add-user.sh;
  3. Na primeira pergunta exibida, apenas dê ENTER;
  4. Informe o nome do usuário na segunda pergunta;
  5. Escolha uma senha e digite-a na terceira e quarta perguntas;
  6. Após a confirmação da senha, efetue um ENTER na quinta pergunta;
  7. Na sexta e sétima perguntas é necessário digitar "Sim" (ou "Yes", se o console estiver em inglês) e confirmar com a tecla Enter


Adicionando Classe ou Pacote 

  1. Acesse http://[IP ou hostname]:9990 e informe o usuário e senha criados no passo anterior;
  2. Acesse Configuration → Profiles → full → Logging → View;
  3. Na tela de log, acesse a aba Log Categories;
  4. Clique em Add;
  5. Em name informe o pacote ou classe a ser monitorada (Ex.: com.datasul.technology.webdesk.workflow.engine );
  6. Defina a opção Debug no Level, selecione a opção 'Use parent handlers' e Salve;


Veja abaixo um exemplo dos procedimentos citados acima, sendo eles: criando 'Usuário do servidor de aplicação' e 'Adicionando Classe ou Pacote':

Image Added


Visualizando o Log

À partir da atualização Waterdrop (1.6.4) é possível modificar as configurações de log via API. Para acessá-la através do navegador é só utilizar o endereço (IP ou hostname e porta) do seu ambiente com o contexto '/management/swagger-ui/'. Conforme o exemplo abaixo:

Painel

protocolo://[host_fluig]/management/swagger-ui/

A API de Logs, disponível nesse endereço, permite verificar e alterar configurações de 'handlers' e de 'loggers', incluíndo facilitadores para alterar níveis de log por funcionalidade (alias), sem a necessidade de saber os nomes dos pacotes ou das classes específicas.

Um dos 'alias' disponíveis, por exemplo, é o 'INDEX'. Ao passar este valor no parâmetro 'category' dos métodos de gerenciamento de 'loggers', serão modificados os níveis de log dos pacotes referentes a indexação na plataforma, sem a necessidade de realizar várias chamadas e nem de conhecer quais são estes pacotes.

A documentação completa da API também encontra-se na URL 'http://<endereco_fluig>/management/swagger-ui/', bem como facilitadores para realizar requisições parametrizadas à partir do navegador.

Nota

Se o ambiente estiver em alta disponibilidade, é necessário realizar os procedimentos acima em cada máquina do cluster.

...

de Debug

Após realizada as configurações, o log pode ser monitorado a partir do arquivo [Instalação fluig]/appserver/domain/servers/fluig1/log/server.log.

Use uma das ferramentas de análise recomendadas para visualizar o arquivo ou, caso o sistema operacional seja Linux, é possível usar o comando:

...

tail

...

-f

...

[Instalação

...

fluig]/appserver/domain/servers/fluig1/log/server.log