Gestion des évènements (server)

De Wiki1000
(Différences entre les versions)
(→Propriétés)
 
(36 révisions intermédiaires par un utilisateur sont masquées)
Ligne 2 : Ligne 2 :
 
{{Version700}}
 
{{Version700}}
 
La gestion des logs et des évènements permet de centraliser les logs dans un gestionnaire externe.
 
La gestion des logs et des évènements permet de centraliser les logs dans un gestionnaire externe.
 +
 +
===Types d'évènement===
 +
Les évènements sont typés
 +
 +
{|class="wikitable"
 +
|-
 +
!Type
 +
!Usage
 +
|-
 +
|success
 +
|not used
 +
|-
 +
|information
 +
|Message d'activité
 +
|-
 +
|error
 +
|
 +
* Erreur critique et fatale
 +
* Exceptions (700)
 +
|-
 +
|warning
 +
|
 +
* Avertissement, pas fatal mais significatif
 +
* Exceptions (700p)
 +
|-
 +
|audit_success
 +
|Message d'audit succès (700p)
 +
|-
 +
|audit_failure
 +
|Message d'audit en erreur (700p)
 +
|-
 +
|monitor
 +
|Evènements générés par l'[[horloge (perf)|horloge interne]] (700p)
 +
|}
  
 
===Catégories d'évènement===
 
===Catégories d'évènement===
Ligne 37 : Ligne 71 :
 
|confevent
 
|confevent
 
|Messages de configuration
 
|Messages de configuration
 +
|-
 +
|audit
 +
|Messages d'audit
 +
|-
 +
|uxevent
 +
|Messages d'évènement d'interface utilisateur
 
|}
 
|}
  
 
===Propriétés===
 
===Propriétés===
 
Les messages transmis aux gestionnaires externes sont paramétrés par des variables, lors de l'envoie d'un message les paramètres du message sont substitués.
 
Les messages transmis aux gestionnaires externes sont paramétrés par des variables, lors de l'envoie d'un message les paramètres du message sont substitués.
 +
 +
'''Propriétés statiques'''
  
 
{|class="wikitable"
 
{|class="wikitable"
Ligne 57 : Ligne 99 :
 
|-
 
|-
 
|ParitionKey
 
|ParitionKey
−
|HostName:HostPort
+
|NodeID
 
|-
 
|-
 
|gaUA
 
|gaUA
Ligne 84 : Ligne 126 :
 
|-
 
|-
 
|NodeID
 
|NodeID
−
|identifiant unique de noeud
+
|identifiant unique de noeud (host.port.service)
 +
|-
 +
|NodeGUID
 +
|GUID identifiant le noeud ([[Service_1000_(server)|switch NODEGUID]] ou GUID unique de machine)
 
|-
 
|-
 
|systemOSName
 
|systemOSName
Ligne 91 : Ligne 136 :
 
|systemOSInfo
 
|systemOSInfo
 
|Chaîne d'information courte du système d'exploitation
 
|Chaîne d'information courte du système d'exploitation
 +
|-
 +
|systemOSVersion
 +
|Version du système d'exploitation
 
|-
 
|-
 
|systemOSInfoEx
 
|systemOSInfoEx
Ligne 97 : Ligne 145 :
 
|systemOSLanguage
 
|systemOSLanguage
 
|Langage par défaut du système d'exploitation
 
|Langage par défaut du système d'exploitation
−
|-
 
−
|platformInfo
 
−
|
 
−
|-
 
−
|platformVersion
 
−
|
 
 
|-
 
|-
 
|databaseInfo
 
|databaseInfo
Ligne 118 : Ligne 160 :
 
|serialNumber
 
|serialNumber
 
|Numéro de série du produit
 
|Numéro de série du produit
 +
|-
 +
|memoryVirtualSetSize
 +
|Taille de mémoire virtuelle du processus
 +
|-
 +
|memoryWorkingSetSize
 +
|Taille de jeu de travail du processus
 +
|-
 +
|memoryPageFault
 +
|Nombre de page fault du processus
 
|-
 
|-
 
|productName
 
|productName
Ligne 133 : Ligne 184 :
 
|*
 
|*
 
|toutes les informations disponibles liées à l'événement  
 
|toutes les informations disponibles liées à l'événement  
 +
|}
 +
 +
'''Propriétés liées au contexte utilisateur'''
 +
 +
{|class="wikitable"
 +
|-
 +
!Nom
 +
!Contenu
 +
|-
 +
|SessionID
 +
|Identifiant de session
 +
|-
 +
|UserName
 +
|Nom de l'utilisateur
 +
|-
 +
|UserID
 +
|Identifiant de l'utilisateur
 +
|-
 +
|CustomerID
 +
|Numéro de série du produit
 +
|-
 +
|SocName
 +
|Nom du dossier
 +
|-
 +
|RemoteIP
 +
|Adresse distante de l'utilisateur
 +
|-
 +
|AppName
 +
|Nom de l'application
 +
|-
 +
|AppVersion
 +
|Version de l'application
 +
|-
 +
|authDirectory
 +
|Nom de l'annuaire utilisé
 +
|-
 +
|authGroup
 +
|Nom du groupe ayant identifié
 +
|-
 +
|UserArgent
 +
|UserAgent de connexion
 +
|-
 +
|Referer
 +
|Referer de connexion
 +
|-
 +
|tenantID
 +
|Identifiant de tenant (multitenant)
 +
|-
 +
|OrganizationName
 +
|Nom de l'organisation (multitenant)
 +
|-
 +
|ShareSocietyName
 +
|Société de partage
 +
|-
 +
|ShareRestitution
 +
|Mode de partage
 +
|-
 +
|LoginInfo
 +
|Informations de connexion
 
|}
 
|}
  
Ligne 149 : Ligne 259 :
 
|exceptionClass
 
|exceptionClass
 
|Classe de l'exception
 
|Classe de l'exception
 +
|-
 +
|exceptionCode
 +
|Code de l'exception
 
|-
 
|-
 
|exceptionDatetime
 
|exceptionDatetime
Ligne 163 : Ligne 276 :
 
|}
 
|}
  
−
===Propriétés liées au contexte de l'utilisateur===
+
 
 +
===Propriétés définies pour les actions===
 +
Les actions sont des évènements liés à l'activité de l'utilisater, ils sont notamment utilisés pour la collecte des statistiques analytiques.
 +
 
 
{|class="wikitable"
 
{|class="wikitable"
 
|-
 
|-
Ligne 169 : Ligne 285 :
 
!Contenu
 
!Contenu
 
|-
 
|-
−
|userName
+
|ActionType
−
|Login de l'utilisateur
+
|Type d'action
 
|-
 
|-
−
|socName
+
|ActionName
−
|Nom du dossier
+
|Nom de l'action
 
|-
 
|-
−
|remoteIP
+
|ActionCategory
−
|Adresse IP de l'utilisateur
+
|Catégrorie de l'action
 
|-
 
|-
−
|appName
+
|ActionTitle
−
|Nom de l'application 1000
+
|Libellé de l'action
 
|-
 
|-
−
|appVersion
+
|ActionLabel
−
|Version de l'application 1000
+
|Identique à ActionTitle
 
|-
 
|-
−
|customerID
+
|ActionParams
−
|identifiant client, numéro de série de l'application
+
|Paramètre de l'action
 
|-
 
|-
−
|userID
+
|ActionOrigin
−
|Identifiant de l'utilisateur chez ce client customerID-oidEntity
+
|Origin de l'action
 
|-
 
|-
−
|authDirectory
+
|ActionReferrer
−
|Répertoire d'authentification
+
|Référant de l'action
 
|-
 
|-
−
|tenantID
+
|ActionGroup1
−
|Identifiant de tenant (multi-tenant).
+
|Regroupement 1
 
|-
 
|-
−
|organizationName
+
|ActionGroup2
−
|Nom d'organisation de ce tenant.
+
|Regroupement 2
 
|-
 
|-
−
|UserAgent
+
|ActionGroup3
−
|
+
|Regroupement 3
 
|-
 
|-
−
|Referer
+
|ActionTiming
−
|
+
|Durée de l'action
 
|-
 
|-
−
|LoginInfo
+
|ActionValue
−
|
+
|Valeur associée à l'action
 +
|-
 +
|ActionValue1
 +
|Valeur associée à l'action
 +
|-
 +
|ActionValue2
 +
|Valeur associée à l'action
 
|}
 
|}
  
−
===Propriétés définies par les actions===
+
Les catégories associés aux actions :
  
 
{|class="wikitable"
 
{|class="wikitable"
 
|-
 
|-
−
!Nom
+
!Catégorie
−
!Contenu
+
!Usage
 +
!Déclenchés par
 
|-
 
|-
−
|ActionType
+
|hit
−
|
+
|Ouverture d'écran
 +
|form
 
|-
 
|-
−
|ActionName
+
|processevent
−
|
+
|Exécution de traitement
 +
|Défini dans le code métier
 
|-
 
|-
−
|ActionCategory
+
|timing
−
|
+
|Durée d'utilisation
 +
|form
 
|-
 
|-
−
|ActionTitle
+
|uxevent
−
|
+
|Evènements d'interface
 +
|dataset, lookup, menu
 +
|}
 +
 
 +
'''Exemple, collecter les actions utilisateurs :'''
 +
 +
<pre>
 +
[\SOFTWARE\Sage\Ligne 1000\Administration\LOGManager\ACTIONS]
 +
type=file
 +
FileName=logs\actions-[NodeID]-[processId].csv
 +
categories=sysevent,confevent,taskevent,processevent,uxevent,event,hit,timing
 +
content=[Timestamp];[UserName];[SessionID];[MemoryVirtualSetSize];[ShareSocietyName];[actionCategory];[actionName];[actionTitle];[actionParams];[actionValue];[actionValue1];[actionReferrer];[actionOrigin];[ActionModule];[actionTiming]
 +
</pre>
 +
 
 +
===Messages d'audit===
 +
(A partir de 700p)
 +
 
 +
Ces messages sont émis sous les types AUDIT_SUCCESS et AUDIT_FAILURE
 +
 
 +
'''Propriétés des messages d'audit'''
 +
 
 +
{|class="wikitable"
 
|-
 
|-
−
|ActionLabel
+
!Nom
−
|Identique à ActionTitle
+
!Contenu
 
|-
 
|-
−
|ActionParams
+
|auditAction
−
|
+
|Action
 
|-
 
|-
−
|ActionReferrer
+
|message
−
|
+
|Libellé associé à l'action
 +
|}
 +
 
 +
'''Liste des actions auditées'''
 +
 
 +
{|class="wikitable"
 
|-
 
|-
−
|ActionGroup1
+
!Action
−
|
+
!Source
 +
!Type
 +
!informations
 
|-
 
|-
−
|ActionGroup2
+
|authenticate.login
−
|
+
|session
 +
|success
 +
|utilisateur
 
|-
 
|-
−
|ActionGroup3
+
|authenticate.login
−
|
+
|session
 +
|failure
 +
|utilisateur
 
|-
 
|-
−
|ActionTiming
+
|authenticate.logout
−
|
+
|session
 +
|success
 +
|utilisateur
 
|-
 
|-
−
|ActionValue
+
|form.open
−
|
+
|form
 +
|success
 +
|Interface concernée
 
|-
 
|-
−
|ActionValue1
+
|form.close
−
|
+
|form
 +
|success
 +
|Interface concernée
 +
|-
 +
|task.start
 +
|Automate
 +
|success
 +
|tâche démarrée
 +
|-
 +
|task.success
 +
|Automate
 +
|success
 +
|tâche exécutée
 
|-
 
|-
−
|ActionValue2
+
|task.failure
−
|
+
|Automate
 +
|failure
 +
|tâche exécutée
 
|}
 
|}
  
Ligne 263 : Ligne 439 :
  
 
Leur rôle est de transmettre les messages aux gestionnaires externes.
 
Leur rôle est de transmettre les messages aux gestionnaires externes.
 +
 +
* Un gestionnaire de log peut filtrer les évènements sur leur type (700p) et leur catégorie
 +
* Un même évènement peut être géré par plusieurs gestionnaires de log
  
 
Les gestionnaires de log sont référencés dans le fichier de configuration du service par le paramètre "Log Manager" :
 
Les gestionnaires de log sont référencés dans le fichier de configuration du service par le paramètre "Log Manager" :
Ligne 280 : Ligne 459 :
 
</pre>
 
</pre>
  
 +
'''Voir aussi :'''
 +
 +
* [[Paramètres (logger)|Paramètres des Logger]]
 +
* [[LogEvent_(rtl)|Emettre un évènement dans le code métier]]
 
* [[httpLogger (logger)|Logger http]]
 
* [[httpLogger (logger)|Logger http]]
 +
* [[mailLogger (logger)|Logger mail]]
 +
* [[fileLogger (logger)|Logger fichier]]
 +
* [[azureLogger (logger)|Logger azure]]
  
 
[[Category:Logger]]
 
[[Category:Logger]]
 
[[Category:Serveur]]
 
[[Category:Serveur]]
 
[[Category:Version700]]
 
[[Category:Version700]]

Version actuelle en date du 10 août 2018 à 13:27

Sommaire

version700-32x32.png La gestion des logs et des évènements permet de centraliser les logs dans un gestionnaire externe.

Types d'évènement

Les évènements sont typés

Type Usage
success not used
information Message d'activité
error
  • Erreur critique et fatale
  • Exceptions (700)
warning
  • Avertissement, pas fatal mais significatif
  • Exceptions (700p)
audit_success Message d'audit succès (700p)
audit_failure Message d'audit en erreur (700p)
monitor Evènements générés par l'horloge interne (700p)

Catégories d'évènement

Les différents évènements sont catégorisés, un gestionnaire peut gérer une ou plusieurs catégories.

Nom Usage
service Message issus du service (trace et debug)
automate Messages issus de l'automate
bp Messages issus des Processus Métiers
authenticate Messages d'authentification
hit Messages d'exécution d'interface (form et report)
timing Messages de durée d'exécution (form,report,processus...)
processevent Messages d'exécution de processus
taskevent Messages d'exécution de tâche
confevent Messages de configuration
audit Messages d'audit
uxevent Messages d'évènement d'interface utilisateur

Propriétés

Les messages transmis aux gestionnaires externes sont paramétrés par des variables, lors de l'envoie d'un message les paramètres du message sont substitués.

Propriétés statiques

Nom Contenu
id GUID au format XXXXXXXXXXXXXXXXXXXXXXXXXXXX
guid GUID au format {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX}
RowId GUID au format XXXXXXXXXXXXXXXXXXXXXXXXXXXX
ParitionKey NodeID
gaUA Google Analytics Tracking ID
TimeStamp Date et heure UTC au format 1999-05-31T13:20:00.000-05:00
MonthStamp Date UTC au format YYYY.MM
DayStamp Date UTC au format YYYY.MM.DD
Service Nom du service
HostName Nom du serveur
HostPort Port du serveur
HostURL Url de base du serveur
NodeID identifiant unique de noeud (host.port.service)
NodeGUID GUID identifiant le noeud (switch NODEGUID ou GUID unique de machine)
systemOSName Nom du système d'exploitation
systemOSInfo Chaîne d'information courte du système d'exploitation
systemOSVersion Version du système d'exploitation
systemOSInfoEx Chaîne d'information longue du système d'exploitation
systemOSLanguage Langage par défaut du système d'exploitation
databaseInfo Chaîne d'identification du serveur de base de données (de la base master)
applicationInfo Chaîne d'information de l'application 1000
hardwareInfo Chaîne d'information sur le processeur et les coeurs
systemInfo Chaîne d'information affichée au démarrage
serialNumber Numéro de série du produit
memoryVirtualSetSize Taille de mémoire virtuelle du processus
memoryWorkingSetSize Taille de jeu de travail du processus
memoryPageFault Nombre de page fault du processus
productName Nom du produit (issu de la clé)
productOVP OVP du produit
productInfo Nom du produit (issu de l'exécutable)
productVersion Version du produit (issu de l'exécutable)
* toutes les informations disponibles liées à l'événement

Propriétés liées au contexte utilisateur

Nom Contenu
SessionID Identifiant de session
UserName Nom de l'utilisateur
UserID Identifiant de l'utilisateur
CustomerID Numéro de série du produit
SocName Nom du dossier
RemoteIP Adresse distante de l'utilisateur
AppName Nom de l'application
AppVersion Version de l'application
authDirectory Nom de l'annuaire utilisé
authGroup Nom du groupe ayant identifié
UserArgent UserAgent de connexion
Referer Referer de connexion
tenantID Identifiant de tenant (multitenant)
OrganizationName Nom de l'organisation (multitenant)
ShareSocietyName Société de partage
ShareRestitution Mode de partage
LoginInfo Informations de connexion

Propriétés liées à un événement de type exception

Nom Contenu
exceptionEMessage Message court de l'exception
exceptionMessage Message détaillé de l'exception
exceptionClass Classe de l'exception
exceptionCode Code de l'exception
exceptionDatetime Message court de l'exception
exceptionThreadId Thread qui a provoqué l'exception
exceptionStack Pile d'appel de l'exception
* toutes les informations disponibles liées à l'événement


Propriétés définies pour les actions

Les actions sont des évènements liés à l'activité de l'utilisater, ils sont notamment utilisés pour la collecte des statistiques analytiques.

Nom Contenu
ActionType Type d'action
ActionName Nom de l'action
ActionCategory Catégrorie de l'action
ActionTitle Libellé de l'action
ActionLabel Identique à ActionTitle
ActionParams Paramètre de l'action
ActionOrigin Origin de l'action
ActionReferrer Référant de l'action
ActionGroup1 Regroupement 1
ActionGroup2 Regroupement 2
ActionGroup3 Regroupement 3
ActionTiming Durée de l'action
ActionValue Valeur associée à l'action
ActionValue1 Valeur associée à l'action
ActionValue2 Valeur associée à l'action

Les catégories associés aux actions :

Catégorie Usage Déclenchés par
hit Ouverture d'écran form
processevent Exécution de traitement Défini dans le code métier
timing Durée d'utilisation form
uxevent Evènements d'interface dataset, lookup, menu

Exemple, collecter les actions utilisateurs : 

[\SOFTWARE\Sage\Ligne 1000\Administration\LOGManager\ACTIONS]
type=file
FileName=logs\actions-[NodeID]-[processId].csv
categories=sysevent,confevent,taskevent,processevent,uxevent,event,hit,timing
content=[Timestamp];[UserName];[SessionID];[MemoryVirtualSetSize];[ShareSocietyName];[actionCategory];[actionName];[actionTitle];[actionParams];[actionValue];[actionValue1];[actionReferrer];[actionOrigin];[ActionModule];[actionTiming]

Messages d'audit

(A partir de 700p)

Ces messages sont émis sous les types AUDIT_SUCCESS et AUDIT_FAILURE

Propriétés des messages d'audit

Nom Contenu
auditAction Action
message Libellé associé à l'action

Liste des actions auditées

Action Source Type informations
authenticate.login session success utilisateur
authenticate.login session failure utilisateur
authenticate.logout session success utilisateur
form.open form success Interface concernée
form.close form success Interface concernée
task.start Automate success tâche démarrée
task.success Automate success tâche exécutée
task.failure Automate failure tâche exécutée

Gestionnaires de log

Les gestionnaires de log sont des objets techniques réalisant l'interface avec le gestionnaire externe.

Leur rôle est de transmettre les messages aux gestionnaires externes.

  • Un gestionnaire de log peut filtrer les évènements sur leur type (700p) et leur catégorie
  • Un même évènement peut être géré par plusieurs gestionnaires de log

Les gestionnaires de log sont référencés dans le fichier de configuration du service par le paramètre "Log Manager" : 

\SOFTWARE\Sage\Ligne 1000\Administration\Servers\suiteazure]
.....
LOG Manager=AZURE,HHTP1

[\SOFTWARE\Sage\Ligne 1000\Administration\LOGManager\AZURE]
type = azure
....

[\SOFTWARE\Sage\Ligne 1000\Administration\LOGManager\HTTP1]
type = http
....

Voir aussi :

Récupérée de « https://frp.sage.fr/wiki1000/index.php?title=Gestion_des_%C3%A9v%C3%A8nements_(server)&oldid=12234 »
Outils personnels