Ativar a rotação de registros para edge-message-processor.log

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

A rotação de registros, o processo de rotação de vários arquivos de registro em uso e fora de uso, simplifica a administração de sistemas que geram um grande número de arquivos de registro. A rotação de registros permite a rotação, compactação, remoção e envio automático de arquivos de registro.

No Edge para nuvem privada, alguns dos principais arquivos de registro em cada apigee componente são configurados com um mecanismo de rotação padrão. Por exemplo, no componente do processador de mensagens, os arquivos a seguir são configurados com um mecanismo de rotação padrão usando o logback:

  • /opt/apigee/var/log/edge-message-processor/logs/system.log
  • /opt/apigee/var/log/edge-message-processor/logs/events.log
  • /opt/apigee/var/log/edge-message-processor/logs/startupruntimeerrors.log
  • /opt/apigee/var/log/edge-message-processor/logs/configurations.log
  • /opt/apigee/var/log/edge-message-processor/logs/transactions.log

Arquivos semelhantes existem para outros edge-* componentes (cujos nomes começam com edge-), como edge-management-server, edge-router, edge-postgres-server e edge-qpid-server.

Cada um desses componentes edge-* também gera um arquivo de registro adicional, que é uma saída redirecionada do console do componente respectivo. No caso do componente do processador de mensagens, esse arquivo é chamado de /opt/apigee/var/log/edge-message-processor/edge-message-processor.log. Outros componentes edge-* geram um arquivo semelhante. A rotação desses arquivos não é feita por a biblioteca de logback, mas usando logrotate e crontab.

Antes de começar

  • Se você não estiver familiarizado com as configurações logrotate, leia o manual do logrotate.
  • Se você não estiver familiarizado com as configurações crontab, leia o manual do crontab.

Ativar a rotação de registros

Esta seção se aplica às versões 4.50.00 e 4.51.00 do Edge para nuvem privada.

A rotação de registros é um mecanismo projetado para facilitar a administração de sistemas que geram um grande número de arquivos de registro. Ele permite a rotação, compactação, remoção e envio automático de arquivos de registro.

Por padrão, alguns dos principais arquivos de registro em cada um dos apigee componentes são configurados com um mecanismo de rotação padrão. Por exemplo, no componente do processador de mensagens, os arquivos a seguir são configurados com o mecanismo de rotação padrão:

  • /opt/apigee/var/log/edge-message-processor/logs/system.log
  • /opt/apigee/var/log/edge-message-processor/logs/events.log
  • /opt/apigee/var/log/edge-message-processor/logs/startupruntimeerrors.log
  • /opt/apigee/var/log/edge-message-processor/logs/configurations.log
  • /opt/apigee/var/log/edge-message-processor/logs/transactions.log

No entanto, outros arquivos de registro nos componentes apigee não são configurados com a rotação padrão. Por exemplo, a rotação de registros não é configurada por padrão no arquivo edge-message-processor.log do processador de mensagens do componente apigee.

A rotação de registros pode ser ativada usando diferentes utilitários/frameworks, como logrotate, logback, ou log4j. Esta seção explica como configurar a rotação de registros para o arquivo /opt/apigee/var/log/edge-message-processor/edge-message-processor.log usando logrotate e crontab.

Como ativar a rotação de registros para edge-message-processor.log em processadores de mensagens

Esta seção explica como ativar a rotação de registros para /opt/apigee/var/log/edge-message- processor/edge-message-processor.log registros nos processadores de mensagens do Edge.

As etapas a seguir descrevem como ativar a rotação de registros para o arquivo edge-message-processor.log:

  1. Abra o arquivo /opt/apigee/edge-message-processor/logrotate/logrotate.conf na máquina do processador de mensagens em um editor. Se o arquivo não existir, crie-o. Exemplo:
    vi /opt/apigee/edge-message-processor/logrotate/logrotate.conf
    
  2. Adicione um snippet ao arquivo semelhante ao mostrado abaixo:
    /opt/apigee/var/log/edge-message-processor/edge-message-processor.log {
        missingok
        copytruncate
        rotate 5
        size 10M
        compress
        delaycompress
        notifempty
        nocreate
        sharedscripts
        }
  3. Salve as alterações.
  4. Abra o crontab do usuário apigee usando o comando a seguir:
    sudo crontab -u apigee -e
    
  5. Adicione o cron job a seguir ao crontab do usuário apigee :
    0 0 * * * nice -n 19 ionice -c3 /usr/sbin/logrotate -s /opt/apigee/var/run/edge-message-processor/logrotate.status -f /opt/apigee/edge-message-processor/logrotate/logrotate.conf
  6. Salve o crontab e monitore a rotação de registros durante a próxima execução do cron job.

Como verificar a rotação de registros para edge-message-processor.log no processador de mensagens

  1. Depois que o cron job programado for executado, o arquivo de registro será girado. No exemplo acima, o cron job está programado para ser executado todos os dias às 00h para girar o arquivo edge-message- processor.log.
  2. Navegue até o diretório /opt/apigee/var/log/edge-message-processor/ e verifique se o arquivo edge-message-processor.log foi girado.

    Exemplo de lista de arquivos de registro

    ls -ltrh | grep 'edge-message-processor'
    
    -rw-r--r--. 1 apigee apigee  17K Feb  7 00:00 edge-message-processor.log.1.gz
    -rw-r--r--. 1 apigee apigee 5.3K Feb  7 09:12 edge-message-processor.log

    A saída acima indica que os arquivos edge-message-processor.log são girados e salvos como um arquivo GZ.

  3. Se você não vir os arquivos edge-message-processor.log sendo girados, verifique se seguiu todas as etapas descritas em Como ativar a rotação de registros para edge-message-processor.log em processadores de mensagens corretamente. Se você perdeu alguma etapa, repita todas as etapas corretamente.
  4. Se você ainda não conseguir fazer a rotação de registros funcionar, entre em contato com o suporte do Apigee Edge.