Monitoring Petals ESB Flows with its logs

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.

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.

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

Parameters included only in starting step's traces (MONIT level)

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).

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). |

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

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

Specific parameters

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

Component Consume Provide
bc-soap client, requestedURL requestedURL
bc-mail URLMailboxFolder emailAddress, smtpURL
bc-sftp X operation, fileName (oulistFileName), destDirName, user, sftpURL
bc-ftp X operation, fileName (oulistFileName) , destDirName, user, ftpURL
bc-filetransfer filePath operation, fileName (oulistFileName) , destDirName
bc-sql X SQLOperation, jdbcURL, user
se-bpel No specific informations No specific informations
se-eip No specific informations No specific informations
se-validation X operation,schema
se-xslt X operation, stylesheet,listParameters
se-quartz eventTime X
se-jsr-181 X class


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).

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).

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.