Activer la rotation des journaux pour Edge-message-processor.log

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X.
info

La rotation des journaux (processus consistant à faire tourner plusieurs fichiers journaux et à les utiliser ou non) simplifie l'administration des systèmes qui génèrent un grand nombre de fichiers journaux. La rotation des journaux permet de faire pivoter, compresser, supprimer et envoyer automatiquement les fichiers journaux.

Dans Edge pour le cloud privé, certains des fichiers journaux principaux de chaque composant apigee sont configurés avec un mécanisme de rotation par défaut. Par exemple, sur le composant Message Processor, les fichiers suivants sont configurés avec un mécanisme de rotation par défaut à l'aide de 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

Des fichiers similaires existent pour d'autres composants edge-* (dont les noms commencent par edge-), tels que edge-management-server, edge-router, edge-postgres-server et edge-qpid-server.

Chacun de ces composants edge-* génère également un fichier journal supplémentaire qui est une sortie redirigée de la console du composant concerné. Dans le cas du composant Message Processor, ce fichier est appelé /opt/apigee/var/log/edge-message-processor/edge-message-processor.log. Les autres composants edge-* génèrent un fichier similaire. La rotation de ces fichiers n'est pas effectuée par la bibliothèque Logback, mais à l'aide de logrotate et crontab.

Avant de commencer

  • Si vous ne connaissez pas bien les configurations logrotate, consultez le manuel logrotate.
  • Si vous ne connaissez pas bien les configurations crontab, consultez le manuel crontab.

Activer la rotation des journaux

Cette section s'applique aux versions 4.50.00 et 4.51.00 d'Edge pour le cloud privé.

La rotation des journaux est un mécanisme conçu pour faciliter l'administration des systèmes qui génèrent un grand nombre de fichiers journaux. Il permet de faire pivoter, compresser, supprimer et envoyer automatiquement des fichiers journaux.

Par défaut, certains des fichiers journaux principaux de chacun des composants apigee sont configurés avec un mécanisme de rotation par défaut. Par exemple, dans le composant Message Processor, les fichiers suivants sont configurés avec le mécanisme de rotation par défaut:

  • /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

Toutefois, les autres fichiers journaux des composants apigee ne sont pas configurés avec la rotation par défaut. Par exemple, la rotation des journaux n'est pas configurée par défaut dans le fichier edge-message-processor.log du composant apigee Message Processor.

La rotation des journaux peut être activée à l'aide de différentes utilitaires/cadres tels que logrotate, logback ou log4j. Cette section explique comment configurer la rotation des journaux pour le fichier /opt/apigee/var/log/edge-message-processor/edge-message-processor.log à l'aide de logrotate et crontab.

Activer la rotation des journaux pour edge-message-processor.log sur les processeurs de messages

Cette section explique comment activer la rotation des journaux pour les journaux /opt/apigee/var/log/edge-message- processor/edge-message-processor.log sur les processeurs de messages Edge.

La procédure suivante explique comment activer la rotation des journaux pour le fichier edge-message-processor.log:

  1. Ouvrez le fichier /opt/apigee/edge-message-processor/logrotate/logrotate.conf sur la machine du processeur de messages dans un éditeur. Si le fichier n'existe pas, créez-le. Exemple :
    vi /opt/apigee/edge-message-processor/logrotate/logrotate.conf
    
  2. Ajoutez un extrait au fichier semblable à celui ci-dessous:
    /opt/apigee/var/log/edge-message-processor/edge-message-processor.log {
        missingok
        copytruncate
        rotate 5
        size 10M
        compress
        delaycompress
        notifempty
        nocreate
        sharedscripts
        }
  3. Enregistrez les modifications.
  4. Ouvrez le crontab de l'utilisateur apigee à l'aide de la commande suivante:
    sudo crontab -u apigee -e
    
  5. Ajoutez la tâche cron suivante au fichier crontab de l'utilisateur 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. Enregistrez crontab et surveillez la rotation des journaux lors de l'exécution suivante de la tâche cron.

Vérifier la rotation des journaux pour edge-message-processor.log sur le processeur de messages

  1. Une fois la tâche cron planifiée exécutée, le fichier journal est remplacé. D'après l'exemple ci-dessus, la tâche Cron est planifiée pour s'exécuter tous les jours à minuit afin de faire pivoter le fichier edge-message- processor.log.
  2. Accédez au répertoire /opt/apigee/var/log/edge-message-processor/ et vérifiez que le fichier edge-message-processor.log est roté.

    Exemple de liste de fichiers journaux

    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

    La sortie ci-dessus indique que les fichiers edge-message-processor.log sont pivotés et enregistrés en tant que fichier GZ.

  3. Si vous ne constatez pas que les fichiers edge-message-processor.log sont mis en rotation, vérifiez que vous avez correctement suivi toutes les étapes décrites dans la section Activer la rotation des journaux pour edge-message-processor.log sur les processeurs de messages. Si vous avez manqué une étape, répétez-la correctement.
  4. Si vous ne parvenez toujours pas à faire fonctionner la rotation des journaux, contactez l'assistance Apigee Edge.