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

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

A rotação de registros, que é o processo de alternar entre o uso e a não utilização de vários arquivos de registro, 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áticos de arquivos de registro.

No Edge para nuvem privada, alguns dos principais arquivos de registro em cada componente apigee 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

Existem arquivos semelhantes para outros componentes edge-* (com nomes que 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 respectivo componente. No caso do componente 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 pela biblioteca Logback, mas sim usando logrotate e crontab.

Antes de começar

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, a compactação, a remoção e o envio automáticos de arquivos de registro.

Por padrão, alguns dos principais arquivos de registro em cada um dos componentes apigee são configurados com um mecanismo de rotação padrão. Por exemplo, no componente "Processador de mensagens", os seguintes arquivos 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 nos processadores de mensagens

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

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 seguinte comando:
    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 job cron.

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

  1. Quando o job cron programado for executado, o arquivo de registro será rotacionado. No exemplo acima, o cron job é 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 rotacionado.

    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 os arquivos edge-message-processor.log não estiverem sendo girados, verifique se você seguiu corretamente todas as etapas descritas em Ativar a rotação de registros para edge-message-processor.log nos processadores de mensagens. Se você tiver perdido alguma etapa, repita todas as etapas novamente.
  4. Se a rotação de registro ainda não estiver funcionando, entre em contato com o suporte do Apigee Edge.