Module d'envoi de logs par email
Le module d’envoi de récapitulatifs de log permet aux administrateurs techniques de paramétrer la réception de récapitulatifs de log par e-mail à des groupes de membres identifiés.
Themes : Notification, Sauvegarde
Version 1.1
Compatibility : JCMS 9, 10
Documentation
Introduction
Le module d’envoi de récapitulatifs de log permet aux administrateurs techniques de paramétrer la réception de récapitulatifs de log par e-mail à des groupes de membres identifiés.
Ces logs seront envoyés dans le corps du mail, dans un fichier en pièce-jointe ou seront accessible par un lien de téléchargement (en fonction des propriétés réglées en BackOffice et d’un poids maximum de pièce-jointe).
Il permet de choisir les niveaux de log désirés (du plus au moins fin dans l’analyse) :
- TRACE : utilisé par exemple pour journaliser l'entrée ou la sortie d'une méthode
- DEBUG : utilisé pour générer des messages pouvant être utiles au débogage
- INFO : utilisé pour journaliser des messages à caractère informatif (nom des fichiers, etc.)
- WARN : utilisé pour journaliser un avertissement, il peut s'agir par exemple d'une incohérence dans la configuration, l'application peut continuer à fonctionner mais pas forcément de la façon attendue
- ERROR : utilisé pour journaliser une erreur qui n'empêche cependant pas l'application de fonctionner
- FATAL : utilisé pour journaliser une erreur grave pouvant mener à l'arrêt prématuré de l'application
Ainsi que la fréquence de réception des emails récapitulatifs afin de suivre l’activité du site en continu :
- Toutes les heures
- Tous les jours
- Toutes les semaines
- Tous les mois
Un email est envoyé par niveau paramétré.
Exemple d’e-mail récapitulatif sur le niveau « FATAL » :
Exemple d’e-mail récapitulatif sur le niveau « ERROR » :
Exemple d’e-mail sur le niveau « WARN » lorsque les logs sont trop volumineux :
Exemple d’e-mail sur le niveau « INFO » lorsque le fichier de logs est trop volumineux :
Exemple d’e-mail sur le niveau « TRACE » lorsqu’il n’y a aucun log trouvé :
Pour rappel, en standard dans JCMS, il est possible de récupérer les logs de la journée à tout moment depuis l’administration technique > Supervision > Journal des évènements (http://.../admin/logsDownload.jsp?zip=true) :
Informations 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.
Prérequis
Pour une meilleure compréhension et utilisation de ce module, il est conseillé d’avoir suivi les formations JCMS suivantes :
- Formation d’administrateur technique
- Formation d’administrateur fonctionnel
Ce module ne dépend d’aucun autre module.
Installation du module
Ajouter ce module avec le gestionnaire de modules depuis l’administration technique et redémarrer JCMS.
Paramétrage
Liste des propriétés
Editez le module pour paramétrer ou modifier ses propriétés :
| Propriété |
Nom technique | Description |
| Niveau TRACE : |
||
| Date d’envoi du prochain email |
|
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é. |
| Fréquence d'envoi des emails |
|
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é. |
| Groupe destinataire |
|
Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé. |
| Recevoir les emails uniquement s'il y a des nouveaux logs |
|
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. |
| Format de réception |
|
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*. |
| Niveau DEBUG : |
||
| Date d’envoi du prochain email |
|
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é. |
| Fréquence d'envoi des emails |
|
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é. |
| Groupe destinataire |
|
Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé. |
| Recevoir les emails uniquement s'il y a des nouveaux logs |
|
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. |
| Format de réception |
|
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*. |
| Niveau INFO : |
||
| Date d’envoi du prochain email |
|
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é. |
| Fréquence d'envoi des emails |
|
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é. |
| Groupe destinataire |
|
Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé. |
| Recevoir les emails uniquement s'il y a des nouveaux logs |
|
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. |
| Format de réception |
|
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*. |
| Niveau WARN : |
||
| Date d’envoi du prochain email |
|
Indiquez dans cette propriété la date à laquelle vous souhaitez recevoir le premier e-mail récapitulatif pour le niveau de log "WARN". |
| Fréquence d'envoi des emails |
|
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é. |
| Groupe destinataire |
|
Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé. |
| Recevoir les emails uniquement s'il y a des nouveaux logs |
|
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. |
| Format de réception |
|
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*. |
| Niveau ERROR : |
||
| Date d’envoi du prochain email |
|
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é |
| Fréquence d'envoi des emails |
|
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é. |
| Groupe destinataire |
|
Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé. |
| Recevoir les emails uniquement s'il y a des nouveaux logs |
|
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. |
| Format de réception |
|
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*. |
| Niveau FATAL : |
||
| Date d’envoi du prochain email |
|
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é. |
| Fréquence d'envoi des emails |
|
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é. |
| Groupe destinataire |
|
Choisissez le groupe destinataire de l’email envoyé contenant les logs de ce niveau. Si vide, le mail ne sera pas envoyé. |
| Recevoir les emails uniquement s'il y a des nouveaux logs |
|
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. |
| Format de réception |
|
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*. |
| Autres propriétés : |
||
| Volume des données avant la création d'un fichier |
|
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 |
| Taille du fichier avant compression de celui-ci |
|
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 |
*sauf si la taille limite avant la création d’un fichier ou compression a été atteinte
Enregistrement des nouvelles propriétés
Les changements de valeur des propriétés sont pris en compte directement lors de l'enregistrement sans avoir besoin de redémarrer l'application.
FAQ
Il suffit de laisser les propriétés relatives à ce niveau de log à vide.
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.
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
Change logs
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.
Glossary
A
ACSII
L'American Standard Code for Information Interchange (Code américain normalisé pour l'échange d'information), plus connu sous l'acronyme ASCII ([askiː]) est une norme de codage de caractères en informatique ancienne. Le jeu de caractères codés ASCII est le principal système qui a permis l'échange de textes en anglais à un niveau mondial, limitant ainsi l'usage des langues locales au travers d'extensions régionales.
ACSII ·
Actions entrantes & actions sortantes
Ces actions sont paramétrables dans les workflows. Elles définissent l’entrée ou la sortie d’un état de workflow. Une action entrante signifie l’arrivée dans un état du workflow (ex : une publication qui est planifié). Une action sortante signifie la sortie d’un état vers un autre (ex : une publication qui passe de l’état planifié vers l’état publié).
Actions entrantes & actions sortantes ·
C
Classe
En programmation orientée objet, une classe définie un ensemble d’objets ayant des attributs communs, et le même ensemble d'opérations.
Classe ·
J
Jsync
Jsync est un moteur de réplication des données et des fichiers. La tâche principale de JSync est de synchroniser les données d'un groupe de serveurs JCMS (aussi appelés réplicas), et de répartir la charge de ces serveurs. Ainsi, toute création, modification ou suppression de données (catégorie, membre, contenu, …) sur l'un des réplicas sera propagée par le réplica leader aux réplicas membres du groupe. JSync assure ainsi la cohérence globale des données d'un groupe de serveur JCMS. Ajouter un lien vers la fiche jsync sur jalios.com.
Jsync ·
L
LOG
Correspond à un historique d’évènements stockés dans un fichier, appelé fichier de log (diminutif de logging), permettant de suivre et repérer toutes activités du site. Les évènements sont horodatés et ordonnés en fonction du temps.
LOG ·
LOG4J
Log4j est une bibliothèque de log en Java. Elle permet entre autres de gérer plusieurs niveaux de log :
- FATAL: utilisé pour journaliser une erreur grave pouvant mener à l'arrêt prématuré de l'application
- ERROR: utilisé pour journaliser une erreur qui n'empêche cependant pas l'application de fonctionner
- WARN: utilisé pour journaliser un avertissement, il peut s'agir par exemple d'une incohérence dans la configuration, l'application peut continuer à fonctionner mais pas forcément de la façon attendue
- INFO: utilisé pour journaliser des messages à caractère informatif (nom des fichiers, etc.)
- DEBUG: utilisé pour générer des messages pouvant être utiles au débogage
- TRACE: utilisé par exemple pour journaliser l'entrée ou la sortie d'une méthode
LOG4J ·
M
MailPolicyFilter
Il s’agit d’un point de débranchement (hook) intervenant lors de l’envoi d’un e-mail dans JCMS. Plus détails ici.
MailPolicyFilter ·
Modale
Fenêtre s'ouvrant dynamiquement généralement pour une action précise : déposer un document, initier une conversation, planifier un événement,... fenêtre appelant une action de l'utilisateur.
Modale ·
N
Notifications email
Il s’agit de notifications transmises par email à un ou plusieurs utilisateurs JCMS. Ces emails permettent d’alerter, informer ou d’envoyer un rappel aux utilisateurs concernant un évènement passé ou à venir, d’une action traitée ou à traiter. Sous JCMS, il existe 3 types de notification : INFO, ACTION, ALERTE.
Notifications email ·
P
Portail
Un portail permet d’agréger et de personnaliser des informations de provenances multiples pour en offrir une vision unique. On distingue les portails documentaires étroitement liés à la gestion de contenu, et les portails d’infrastructure liés à des problématiques d’intégration d’applications.
Portail ·
Portlet
Elément de portail. Il existe différents types de portlets :
- portlets de construction de page
- portlets de contenu (en charge de récupérer et de formater l'information),
- portlets de navigation,
- portlets fonctionnelles,
- portlets de log.
L'assemblage des différents types de portlets permet de construire des gabarits de page portail.
Portlet ·
S
Store
Fichier .xml stockant des données sur les publications, les portlets, les espaces de travails, et d'autres fonctionnalités propres à JCMS.
Certaines données de l'application peuvent aussi être stockées en base.
Voir les contenus liés :
- Fiche "Utiliser le store" (fiche Jalios ou Wisen)
- Fiche "Nettoyer le store" (fiche Jalios ou Wisen)
- Autre entrée de glossaire
Store ·
T
Top-bar
La top-bar ou super-header correspond à la barre de menu affichée en haut de page :
Top-bar ·
W
Wiki
Le wiki est une site Web ou page web collaborative dont le contenu peut être modifié par les internautes autorisés.
Wiki ·