MailLogger (logger)
(Page créée avec « Un logger Mail permet d'envoyer des messages SMTP en réponse à des évènements {|class="wikitable" |- !Propriété !Paramétrage !Usage |- |type |non |azure |- |mailAd... ») |
|||
| Ligne 1 : | Ligne 1 : | ||
Un logger Mail permet d'envoyer des messages SMTP en réponse à des évènements | Un logger Mail permet d'envoyer des messages SMTP en réponse à des évènements | ||
| + | |||
| + | '''Paramètres communs :''' | ||
| + | |||
| + | {{:Paramètres (logger)}} | ||
| + | |||
| + | '''Paramètres spécifiques :''' | ||
{|class="wikitable" | {|class="wikitable" | ||
| Ligne 26 : | Ligne 32 : | ||
|non | |non | ||
|Référence des mails | |Référence des mails | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Version actuelle en date du 10 avril 2015 à 12:49
Un logger Mail permet d'envoyer des messages SMTP en réponse à des évènements
Paramètres communs :
Les loggers peuvent être paramétrés pour filter les évènements pris en compte :
| Propriété | Paramétrage | Usage |
|---|---|---|
| content | oui | Contenu du message |
| contentFile | non | Le contenu du message est contenu dans un fichier |
| encodeType | non | Le format d'encodage du message
|
| categories | non | Liste des catégories gérées par le logger |
| eventTypes | non | Liste des type d'évènements gérées par le logger |
| eventFilter | non | Une expression pour filter les évènements |
| openChar | non | Le caractère de début de substitution |
| closeChar | non | Le caractère de fin de substitution |
Encodage du message
Si encodeType n'est pas défini la valeur peut être défini par le contentType :
| ContentType | EncodeType |
|---|---|
| application/json | json |
| application/x-www-form-urlencoded | form |
La structure du message généré dépend du paramètres encodeType :
| EncodeType | Remarque | Content | Message |
|---|---|---|---|
| json | [host],[port],[service] | {"host":"hostname","port":443,"service":"GCF"} | |
| json | content commence par { | {"hostName":[host],"httpPort":[port],"serviceName":[service]} | {"hostName":"hostname","httpPort":443,"serviceName":"GCF"} |
| text | Un message texte du service [service] sur le serveur [host].[port] | Un message texte du servie GCF sur le serveur hostname.443 | |
| text | (*) | [jsonPerfs] | {"status":"up","since":"xxxx", .....} |
| form | [host][port][service] | host=hostname&port=443&service=GCF | |
| form | content contient = | hostName=[host]&httpPort=[port]&serviceName=[service] | hostName=hostname&httpPort=443&serviceName=GCF |
(*) jsonPerfs est une variable spéciale qui retourne une structure json de tous les compteurs de performances.
Paramètres du message
Les parammètres du message peuvent être définie ainsi:
[nom] [nom:cible] [nom!default] [nom!default:cible]
- nom
- Nom du paramètre
- cible
- Nom du paramètre écrit dans le message
- default
- Valeur par défaut si le paramètre est absent.
Compteurs de performances
Les compteurs de performances peuvent être inclus soit individuellement comme les autres paramètres soit en blocs par des paramètres spéciaux :
| Paramètre | Contenu |
|---|---|
| jsonPers | Tous les compteurs |
| jsonPerfStatus | Tous les compteurs d'état |
| jsonPerfHits | Tous les compteurs de taux |
Ces paramètres retourne une structure json sous la forme {p1:v1,....pn:vn}
suivant le type d'encodage :
| encodeType | content | message |
|---|---|---|
| text | [jsonPerfs] | {p1:v1,....pn:vn} |
| json | [P],[jsonPerfs:perfs] | {P:V,perfs:{p1;v1,...pn;vn}} |
| json | [P],[@jsonPerfs] | {P:V,p1;v1,...pn;vn} |
Le préfix @ devant le paramètre permet d'inclure la structure
Exemple :
[\SOFTWARE\Sage\Ligne 1000\Administration\LOGManager\ES_EVENTS] type = http keep-alive = 1 url = http://elastic_hostname0/sage1000-[DayStamp]/event/[id]?timestamp=[timestamp] method = PUT contentType = application/json accept = application/json categories=service,automate,bp,authenticate,hit eventTypes=audit_success,audit_failure content = [NodeId],[timestamp],[host],[port],[service],[ResourceGroupName],[Message],[EventType],[Category],[TenantID],[OrganizationName],[UserName],[auditAction]
Dans cet exemple le logger ne prend en compte que les évènements des catégories service, automate, business process, et page hit et que les évènements de type audit_success et ausit_failure.
Paramètres spécifiques :
| Propriété | Paramétrage | Usage |
|---|---|---|
| type | non | azure |
| mailAddress | oui | Adresse destinataire |
| maiSubject | oui | Sujet du mail |
| mailFrom | non | Adresse mail d'origine |
| mailReference | non | Référence des mails |
|
Tip : Les mails sont envoyés par une file d'attente asynchrone |
Exemple :
Envoyé une alerte lorsque la valeur d'un compteur de performance dépasse un seuil
[\SOFTWARE\Sage\Ligne 1000\Administration\LOGManager\mail] type=mail [email protected] mailSubject=Mail from -[NodeID]-[processId] content=Memory warning [system.memory.virtualSetSize] eventTypes=monitoring eventFilter=system.memory.virtualSetSize > 100*1024
