Envoi de logs par email
Surveillez vos logs et restez informé simplement par email
Les bénéfices
Le module d'envoi de logs par email offre aux administrateurs techniques la possibilité de paramétrer la réception de récapitulatifs de logs par email pour des groupes de membres identifiés. Que ce soit pour surveiller l'activité du site, détecter des erreurs ou suivre les performances, ce module permet de recevoir les logs directement dans le corps de l'email, en pièce jointe ou via un lien de téléchargement, selon les préférences configurées en BackOffice.
Les fonctionnalités
- Paramétrage des niveaux de log : choisissez parmi plusieurs niveaux de log (TRACE, DEBUG, INFO, WARN, ERROR, FATAL) pour recevoir les informations pertinentes ;
- Choix de la fréquence d'envoi : déterminez la fréquence de réception des récapitulatifs d'emails (toutes les heures, tous les jours, toutes les semaines, tous les mois) ;
- Envoi par niveau paramétré : recevez un email pour chaque niveau de log configuré, assurant une surveillance complète de l'activité du site ;
- Flexibilité de réception : choisissez de recevoir les logs dans le corps de l'email, en pièce jointe ou via un lien de téléchargement, selon vos préférences.
Captures d'écran
Les clients aiment
La possibilité de surveiller l'activité du site en recevant des récapitulatifs de logs réguliers.
La flexibilité du paramétrage pour choisir les niveaux de log et la fréquence d'envoi des emails.
L'amélioration de la réactivité grâce à la détection rapide des erreurs et des problèmes potentiels.
FAQ
Plusieurs solutions sont possibles à travers ce module.
Pour diminuer le poids des fichiers envoyés en pièce jointe par e-mails, plusieurs solutions :
- Diminuer la valeur du champ Taille du fichier avant compression de celui-ci pour limiter la taille maximum du fichier de log envoyé par email
- Définir le format de réception en « Lien de téléchargement » pour chaque niveau pour que les fichiers de logs soient systématiquement compressés et envoyés sous la forme d’un lien de téléchargement cliquable depuis l’e-mail récapitulatif.
- Pour diminuer le nombre d’emails envoyés :
- S’assurer que la valeur « Recevoir les emails uniquement s'il y a des nouveaux logs » est bien à « Oui »
- Diminuer la fréquence d'envoi des emails
- Paramétrer différents groupes destinataires pour répartir l’envoi des emails si vous êtes plusieurs et que les différents niveaux ne concernent pas les mêmes personnes dans votre organisation
- Laisser les valeurs vides pour les niveaux pour lesquels vous ne souhaitez pas recevoir de logs
Les fichiers de logs compressés sont automatiquement stockés dans un répertoire du serveur : « […]/WEB-INF/data/zippedsummarylog ». Les fichiers compressés sont automatiquement supprimés le premier jour du sixième mois suivant sa création, à 4h du matin.
Il suffit de laisser les propriétés relatives à ce niveau de log à vide.
Informations détaillées
Prérequis techniques
Compatibilité JSync
Ce module est compatible jSync, il fonctionnera sans problème sur un environnement à plusieurs réplicas.
En revanche, il est important de noter que la configuration du module ne sera pas répliquée et sera à faire sur chaque nœud.
Compatibilité JDK
Ce module est compatible avec la version 1.7 de JDK (Java Development Kit). Si vous êtes sur la version 1.6 de JDK, contactez-nous.
Configuration du module
Ajouter ce module avec le gestionnaire de modules depuis l’administration technique et redémarrer JPlatform.
Une fois le module installé, assurez-vous que les propriétés du module sont correctement paramétrées pour votre plateforme
- Nom technique jcmsplugin.logmailerplugin.1.email.trace.level
- Description Indiquez dans cette propriété la date à laquelle vous souhaitez recevoir le premier e-mail récapitulatif pour le niveau de log "TRACE". Si vide ou inférieur à la date et heure actuelle, le niveau TRACE sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.1.periodicity.trace.level
- Description Choisissez dans le menu déroulant la valeur appropriée, selon que vous souhaitez recevoir le récapitulatif pour le niveau de log "TRACE" (toutes les heures, tous les jours, toutes les semaines ou tous les mois). Si vide, le niveau TRACE sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.1.recipient.grp.id
- Description Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé.
- Nom technique jcmsplugin.logmailerplugin.1.sending.only.with.log
- Description Mettez à « Non » si vous ne souhaitez pas recevoir d’email s’il n’y a aucun log remonté à ce niveau pour la fréquence sélectionnée.
- Nom technique jcmsplugin.logmailerplugin.1.sending.type
- Description Choisissez l'option appropriée selon que vous souhaitez recevoir le récapitulatif de log dans le corps de l'e-mail, dans un fichier en pièce jointe ou en fichier zip téléchargeable via un lien présent dans le l’email. Si vide, le récapitulatif sera dans le corps de l'email.
- Nom technique jcmsplugin.logmailerplugin.2.email.trace.level
- Description Indiquez dans cette propriété la date à laquelle vous souhaitez recevoir le premier e-mail récapitulatif pour le niveau de log "DEBUG". Si vide ou inférieur à la date et heure actuelle, le niveau DEBUG sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.2.periodicity.trace.level
- Description Choisissez dans le menu déroulant la valeur appropriée, selon que vous souhaitez recevoir le récapitulatif pour le niveau de log "DEBUG" toutes les heures, tous les jours, toutes les semaines ou tous les mois. Si vide, le niveau DEBUG sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.2.recipient.grp.id
- Description Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé.
- Nom technique jcmsplugin.logmailerplugin.2.sending.only.with.log
- Description Mettez à « Non » si vous ne souhaitez pas recevoir d’email s’il n’y a aucun log remonté à ce niveau pour la fréquence sélectionnée.
- Nom technique jcmsplugin.logmailerplugin.2.sending.type
- Description Choisissez l'option appropriée selon que vous souhaitez recevoir le récapitulatif de log dans le corps de l'e-mail, dans un fichier en pièce jointe ou en fichier zip téléchargeable via un lien présent dans le l’email. Si vide, le récapitulatif sera dans le corps de l'email*.
- Nom technique jcmsplugin.logmailerplugin.3.email.trace.level
- Description Indiquez dans cette propriété la date à laquelle vous souhaitez recevoir le premier e-mail récapitulatif pour le niveau de log "INFO". Si vide ou inférieur à la date et heure actuelle, le niveau INFO sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.3.periodicity.trace.level
- Description Choisissez dans le menu déroulant la valeur appropriée, selon que vous souhaitez recevoir le récapitulatif pour le niveau de log "INFO" toutes les heures, tous les jours, toutes les semaines ou tous les mois. Si vide, le niveau INFO sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.3.recipient.grp.id
- Description Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé.
- Nom technique jcmsplugin.logmailerplugin.3.sending.only.with.log
- Description Mettez à « Non » si vous ne souhaitez pas recevoir d’email s’il n’y a aucun log remonté à ce niveau pour la fréquence sélectionnée.
- Nom technique jcmsplugin.logmailerplugin.3.sending.type
- Description Choisissez l'option appropriée selon que vous souhaitez recevoir le récapitulatif de log dans le corps de l'e-mail, dans un fichier en pièce jointe ou en fichier zip téléchargeable via un lien présent dans le l’email. Si vide, le récapitulatif sera dans le corps de l'email.
- Nom technique jcmsplugin.logmailerplugin.4.email.trace.level
- Description Indiquez dans cette propriété la date à laquelle vous souhaitez recevoir le premier e-mail récapitulatif pour le niveau de log "WARN". Si vide ou inférieur à la date et heure actuelle, le niveau WARN sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.4.periodicity.trace.level
- Description Choisissez dans le menu déroulant la valeur appropriée, selon que vous souhaitez recevoir le récapitulatif pour le niveau de log "WARN" toutes les heures, tous les jours, toutes les semaines ou tous les mois. Si vide, le niveau WARN sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.4.recipient.grp.id
- Description Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé.
- Nom technique jcmsplugin.logmailerplugin.4.sending.only.with.log
- Description Mettez à « Non » si vous ne souhaitez pas recevoir d’email s’il n’y a aucun log remonté à ce niveau pour la fréquence sélectionnée.
- Nom technique jcmsplugin.logmailerplugin.4.sending.type
- Description Choisissez l'option appropriée selon que vous souhaitez recevoir le récapitulatif de log dans le corps de l'e-mail, dans un fichier en pièce jointe ou en fichier zip téléchargeable via un lien présent dans le l’email. Si vide, le récapitulatif sera dans le corps de l'email.
- Nom technique jcmsplugin.logmailerplugin.5.email.trace.level
- Description Indiquez dans cette propriété la date à laquelle vous souhaitez recevoir le premier e-mail récapitulatif pour le niveau de log "ERROR". Si vide ou inférieur à la date et heure actuelle, le niveau ERROR sera ignoré
- Nom technique jcmsplugin.logmailerplugin.5.periodicity.trace.level
- Description Choisissez dans le menu déroulant la valeur appropriée, selon que vous souhaitez recevoir le récapitulatif pour le niveau de log "ERROR" toutes les heures, tous les jours, toutes les semaines ou tous les mois. Si vide, le niveau ERROR sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.5.recipient.grp.id
- Description Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé.
- Nom technique jcmsplugin.logmailerplugin.5.sending.only.with.log
- Description Mettez à « Non » si vous ne souhaitez pas recevoir d’email s’il n’y a aucun log remonté à ce niveau pour la fréquence sélectionnée.
- Nom technique jcmsplugin.logmailerplugin.5.sending.type
- Description Choisissez l'option appropriée selon que vous souhaitez recevoir le récapitulatif de log dans le corps de l'e-mail, dans un fichier en pièce jointe ou en fichier zip téléchargeable via un lien présent dans le l’email. Si vide, le récapitulatif sera dans le corps de l'email.
- Nom technique jcmsplugin.logmailerplugin.6.email.trace.level
- Description Indiquez dans cette propriété la date à laquelle vous souhaitez recevoir le premier e-mail récapitulatif pour le niveau de log "FATAL". Si vide ou inférieur à la date et heure actuelle, le niveau FATAL sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.6.periodicity.trace.level
- Description Choisissez dans le menu déroulant la valeur appropriée, selon que vous souhaitez recevoir le récapitulatif pour le niveau de log "FATAL" toutes les heures, tous les jours, toutes les semaines ou tous les mois. Si vide, le niveau FATAL sera ignoré.
- Nom technique jcmsplugin.logmailerplugin.6.recipient.grp.id
- Description Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé.
- Nom technique jcmsplugin.logmailerplugin.6.sending.only.with.log
- Description Mettez à « Non » si vous ne souhaitez pas recevoir d’email s’il n’y a aucun log remonté à ce niveau pour la fréquence sélectionnée.
- Nom technique jcmsplugin.logmailerplugin.6.sending.type
- Description Choisissez l'option appropriée selon que vous souhaitez recevoir le récapitulatif de log dans le corps de l'e-mail, dans un fichier en pièce jointe ou en fichier zip téléchargeable via un lien présent dans le l’email. Si vide, le récapitulatif sera dans le corps de l'email.
- Nom technique jcmsplugin.logmailerplugin.7.other.create.file.size
- Description Si le récapitulatif est paramétré pour être dans le corps de l'e-mail et que le volume des données dépasse la valeur de cette propriété, alors les logs seront en pièces jointes. Valeur par défaut : 90Ko
- Nom technique jcmsplugin.logmailerplugin.8.other.create.zip.size
- Description Si le récapitulatif est paramétré pour être dans le corps de l'e-mail ou dans un fichier et que le volume des données dépasse la valeur de cette propriété, alors un lien de téléchargement sera présent dans l'e-mail. Valeur par défaut : 10Mo
Correctif pour que le résultat de l'export des logs soit différencié et téléchargeable suivant qu'il soit généré par le Leader ou le Réplica.
