h1. Logs content & formatting on MONIT level

The default directory for Petals ESB log files is petals-esb/logs (you can change logs directory and logs level by following the related configuration documentation). This directory is shared between:
* the petals.log file which holds all informations about bus runtime (bus starting, installing or removing a component, etc);
* a flowMonitoring directory.

The flowMonitoring directory itself will contain subfolders, each one being named after a flow's flowInstanceId. Each such subfolder will contain a file flow.log which will record all logs relating to this particular flow instance (from INFO to MONIT level, or even FINEST level when active).
\\

Whatever their level and usage, logs names (traces in petals.log and flow.log) are always structured like this:
Petals-node-name Date LEVEL \[loggerName\] : Message
FIXME (Petals-node-name : représente le noeud sur lequel se fait les logs) :
\\

\\
On MONIT level, log messages packs two kind of informations:
* standard parameters for this level (are included in every component)
* specific parameters for some logging component.

h4. Standard parameters

_Parameters included in every trace of MONITORING level_
*traceCode*: (represents) the position of the trace in the flow (confer last paragraph).

*flowInstanceId*: (represents) the id of a flow instance.

*flowStepId*: the unique id of a flow step.

*dumpPath*: path for the directory where the IN or OUT message is saved.

_Parameters included only in starting step's traces (MONIT level)_
{section}
{column}

h6. For a Consume Service

*flowInterfaceName*: interface name of the first provide invoked (consume service only).

*flowServiceName*: service name of the first provide service invoked (consume service only).

*flowOperationName*: operation name of the first provide service invoked (consume service only).
{column}

{column}

h6. For a Provide Service

*traceCode*: (represents) the position of the trace in the flow (confer last paragraph).

*flowStepInterfaceName*: interface name of invoked provide service.

*flowStepServiceName*: service name of invoked provide service.

*flowStepOperationName*: operation name of invoked provide service.

*flowStepEndpointName*: endpoint name of invoked provide service.

*flowPreviousStepId*: flowStepId of service which initiated the call (provide service only). \|
{column}
{section}

Parameters recorded in MONIT level when a step fails (ERROR or FAULT state):

*failureMessage*: content of a fault message or an error message .


h4. Specific parameters

These are all parameters which are recorded when a step is starting. It is varying depending on the component.
The table here under presents these traces, varying on component itself and its configuration (consume or provide).
\\
|| Component || Consume || Provide ||

Definitions of traceCode:
*consumeFlowStepBegin*: détermine la réception d'une requ?te extérieur sur un consume.

*consumeFlowStepEnd*: end message sent to consumer (out message, or Acknowledgement - ACK-).

*consumeFlowStepFailure*: defines if a problem occured during step execution (a fault or a technical error).



*provideFlowStepBegin*: record of the fact that a provide service receives a call/request from a consume.

*provideFlowStepEnd*: record of the fact that provide service send the answer (out message or request ACK).

*provideFlowStepExtBegin*: record of the fact that provide service calls another service (external call).

*provideFlowStepExtEnd*: record of the fact that a provide service receives the answer to its external call (FIXME soit la réponse réelle, soit l'accusé réception s'il est possible envoyé par le service extérieur, sinon elle ne sera pas présente) .

*provideFlowStepFailure*: defines if a problem occured during step execution (a fault or a technical error).




h1. Logs content & formatting on MONIT-MSG level

When you activate the MONIT-MSG level, the logger saves the messages running through the bus, in corresponding flowInstanceId folder. Each message is named after this model:
flowStepId_traceCode.xml.
Once the dump is done, a MONIT-MSG level log trace is recorded in the flow.log file, with the following informations: traceCode, flowInstanceId and flowStepId (which are the same as the ones of corresponding MONIT level trace) and dumpPath (wich tells where the message is actually recorded).

{show-to:users=llacote, strino}

h1. VERSION FRANÇAISE ORIGINALE VISIBLE UNIQUEMENT PAR LAURENT ET SANDRA


h2. Format des Logs avec niveau MONIT activé


Les fichiers de logs de petals-esb se trouvent par défaut dans le répertoire petals-esb/logs (pour changer le répertoire de destination et le niveau des logs, voir la documentation de configuration)

Ce répertoire s'organise en deux partie :

la première est le fichier petals.log qui contient tous les logs de fonctionnement du bus (exemple démarrage du bus, installation d'un composant, …)

la seconde partie est le dossier flowMonitoring, ce dernier contiendra des sous-dossiers nommés avec le flowInstanceId de chaque exécution de flow et qui contiendront un fichier flow.log où seront inscrits tous les logs relatifs à l'exécution d'un flow (du niveau INFO à MONIT jusqu'au FINEST s'il est activé).
\\
\\

Les traces de logs s'organisent, quelque soit le niveau et leur utilité (traces dans petals.log et dans flow.log), ainsi  (Petals-node-name : représente le noeud sur lequel se fait les logs) :

Format : Petals-node-name Date LEVEL \[loggerName\] : Message
\\

Les traces de niveau Monit  : leurs messages se composent de deux parties :

{color:#0099ff}1{color}{color:#0084d1}è{color}{color:#0084d1}re{color}{color:#0084d1}partie{color} :

Paramètres présents dans toutes les traces de niveau MONIT :

*traceCode*: représente où la trace se situe dans le flux (voir la description dernier paragraphe).

*flowInstanceId* : représente l'identifiant d'une exécution d'un flow. *f{*}{*}lowStepId *: représente l'identifiant unique d'une étape.

Paramètres présents dans les traces qui représente le début d'une étape (niveau MONIT) :

*flow{*}{*}Step{*}{*}InterfaceName *: représente le nom de l'interface du provide invoqué.

*flow{*}{*}Step{*}{*}ServiceName *: représente le nom du service du provide invoqué.

*f{*}{*}low{*}{*}Step{*}{*}Operation{*}{*}Name* : représente le nom de l'opération du provide invoqué

*flowStep{*}{*}Endpoint{*}{*}Name{*}* *: représente le nom de l'endpoint du provide invoqué.

*flowPrevi{*}{*}ous{*}{*}StepId* : ce dernier représente le flowStepId de l'appelant (pour les provides).

*f{*}{*}lowInterfaceName *: représente le nom de l'interface du 1er provide appelé par un consumme.

*flowServiceName *: représente le nom de service du 1er provide appelé par un consumme.

*flowOperation{*}{*}Name{*}* *: représente l'opération du 1er provide appelé par un consumme.

*dumpPath *: représente le chemin où est enregistré le message (début ou fin d'étape).

Paramètres présents dans les traces qui représente une étape en fault ou error (niveau MONIT) :

*f{*}{*}aultMessage* : représente le message de la fault qui est remontée.

*errorMessage *: représente le message de l'erreur qui est remontée.

{color:#0099ff}2{color}{color:#0084d1}ème partie{color} : elle est spécifique aux composants JBI qui logguent (début d'étape).

Le tableau suivant représente les traces spécifiques par composant et selon qu'ils sont en consume ou en provide.
\\
| Composant | Consume | Provide |
| bc-soap | *client*, *requestedURL* | *requestedURL* |
| bc-mail | *URLMailboxFolder* | *emailAddress*, *smtpURL* |
| bc-sftp | X | *o{*}{*}peration*, *fileName* (ou{*}listFileName*), *destDirName*, *user*, *sftpURL* |
| bc-ftp | X | *o{*}{*}peration*, *fileName* (ou{*}listFileName*) , *destDirName*, *user*, *ftpURL* |
| bc-filetransfer | *file{*}{*}Path* | *o{*}{*}peration*, *fileName* (ou{*}listFileName*) , *destDirName* |
| bc-sql | X | *SQL{*}{*}Operation*, *jdbcURL*, *user* |
| se-bpel | Pas d'informations spécifiques | Pas d'informations spécifiques |
| se-eip | Pas d'informations spécifiques | Pas d'informations spécifiques |
| se-validation | X | *operation*,*schema* |
| se-xslt | X | *operation*, *stylesheet*,*listParameters* \\ |
| se-quartz | *eventTime* | X |
| se-jsr-181 | X | class |
\\

Définition des traceCode :

*c{*}{*}onsume{*}{*}F{*}{*}lowStepBegin *: détermine la réception d'une requ?te extérieur sur un consume.

*c{*}{*}onsume{*}{*}F{*}{*}lowStepEnd *: est la réponse faîte au consomateur (soit le out, soit l'accusé-réception de la demande).

*c{*}{*}onsume{*}{*}Fl{*}{*}owStepFault *: détermine quand la réponse est une fault.

*c{*}{*}onsume{*}{*}F{*}{*}lowStepError *: détermine quand une erreur est survenue.

*p{*}{*}rovide{*}{*}F{*}{*}lowStepBegin *: détermine qu'un provide reçoit une demande d'un consomateur.

*p{*}{*}rovide{*}{*}F{*}{*}lowStepEnd *: détermine quand un provide renvoie sa réponse (soit le out, soit l'accusé-réception de la demande).

*p{*}{*}rovide{*}{*}F{*}{*}lowStepExtBegin *: détermine quand un provide fait son appel extérieur.

*p{*}{*}rovide{*}{*}F{*}{*}lowStepExtEnd *: détermine quand un provide reçoit la réponse de son appel extérieur (soit la réponse réelle, soit l'accusé réception s'il est possible envoyé par le service extérieur, sinon elle ne sera pas présente) .

*p{*}{*}rovide{*}{*}F{*}{*}lowStepFault *: détermine quand la réponse est une fault.

*p{*}{*}rovideflowStepError *: détermine quand une erreur est survenue.
{show-to}