7.1.1.2.6. Output Messaging Log

The messaging log is output when sending and receiving messages in Intersystem Messaging . The log is output in the application by configuring the log output.

7.1.1.2.6.1. Output policy for messaging log

The messaging log is output to an application log that outputs the log of the entire application.

Output policy for messaging log
Log level Logger name
INFO MESSAGING

A configuration example of the log output for the above mentioned output policy is shown below

Configuration example of log.properties
writerNames=appLog

# Output destination of application log
writer.appLog.className=nablarch.core.log.basic.FileLogWriter
writer.appLog.filePath=/var/log/app/app.log
writer.appLog.encoding=UTF-8
writer.appLog.maxFileSize=10000
writer.appLog.formatter.className=nablarch.core.log.basic.BasicLogFormatter
writer.appLog.formatter.format=$date$ -$logLevel$- $runtimeLoggerName$ [$executionId$] boot_proc = [$bootProcess$] proc_sys = [$processingSystem$] req_id = [$requestId$] usr_id = [$userId$] $message$$information$$stackTrace$

availableLoggersNamesOrder=MESSAGING,ROO

# Configure application log
loggers.ROO.nameRegex=.*
loggers.ROO.level=INFO
loggers.ROO.writerNames=appLog

# Configure messaging log
loggers.MESSAGING.nameRegex=MESSAGING
loggers.MESSAGING.level=INFO
loggers.MESSAGING.writerNames=appLog
Configuration example of app-log.properties
# MessagingLogFormatter
#messagingLogFormatter.className=
#messagingLogFormatter.maskingChar=
#messagingLogFormatter.maskingPatterns=
# Format for MOM messaging
messagingLogFormatter.sentMessageFormat=@@@@ SENT MESSAGE @@@@\
                                          \n\tthread_name    = [$threadName$]\
                                          \n\tmessage_id     = [$messageId$]\
                                          \n\tdestination    = [$destination$]\
                                          \n\tcorrelation_id = [$correlationId$]\
                                          \n\treply_to       = [$replyTo$]\
                                          \n\ttime_to_live   = [$timeToLive$]\
                                          \n\tmessage_body   = [$messageBody$]
messagingLogFormatter.receivedMessageFormat=@@@@ RECEIVED MESSAGE @@@@\
                                              \n\tthread_name    = [$threadName$]\
                                              \n\tmessage_id     = [$messageId$]\
                                              \n\tdestination    = [$destination$]\
                                              \n\tcorrelation_id = [$correlationId$]\
                                              \n\treply_to       = [$replyTo$]\
                                              \n\tmessage_body   = [$messageBody$]
# Format for HTTP messaging
messagingLogFormatter.httpSentMessageFormat=@@@@ HTTP SENT MESSAGE @@@@\
                                              \n\tthread_name    = [$threadName$]\
                                              \n\tmessage_id     = [$messageId$]\
                                              \n\tdestination    = [$destination$]\
                                              \n\tcorrelation_id = [$correlationId$]\
                                              \n\tmessage_header = [$messageHeader$]\
                                              \n\tmessage_body   = [$messageBody$]
messagingLogFormatter.httpReceivedMessageFormat=@@@@ HTTP RECEIVED MESSAGE @@@@\
                                                  \n\tthread_name    = [$threadName$]\
                                                  \n\tmessage_id     = [$messageId$]\
                                                  \n\tdestination    = [$destination$]\
                                                  \n\tcorrelation_id = [$correlationId$]\
                                                  \n\tmessage_header = [$messageHeader$]\
                                                  \n\tmessage_body   = [$messageBody$]

7.1.1.2.6.2. How to use

7.1.1.2.6.2.1. Configure the messaging log

The messaging log is configured in the property file described in Configure various logs .

Description rules

messagingLogFormatter.className
Class that implements messagingLogFormatter.className MessagingLogFormatter . Specify to replace.
messagingLogFormatter.maskingPatterns

Specify the character string to be masked in the message body with a regular expression. The first capture part (enclosed in parentheses) specified by the regular expression will be the target for masking.

For example, if “<password>(.+?)</password>” is specified as the pattern, and “<password>hoge</password>” is included in the message, then the output string will be “<password>****</password>”.

If more than one is specified, separate them with commas. The specified regular expression is not case-sensitive.

messagingLogFormatter.maskingChar
Character used for masking. Default is “*”.
messagingLogFormatter.sentMessageFormat

Format used for the log output of MOM outgoing message.

Placeholders that can be specified for the format
Thread name:$threadName$
Message ID:$messageId$
Send destination:
 $destination$
Correlation message ID:
 $correlationId$
Reply to:$replyTo$
Expiry interval:
 $timeToLive$
Message body content:
 $messageBody$ [1]
Hex dump of message body:
 $messageBodyHex$ [1]
Message body byte length:
 $messageBodyLength$
Default format
@@@@ SENT MESSAGE @@@@
    \n\tthread_name    = [$threadName$]
    \n\tmessage_id     = [$messageId$]
    \n\tdestination    = [$destination$]
    \n\tcorrelation_id = [$correlationId$]
    \n\treply_to       = [$replyTo$]
    \n\ttime_to_live   = [$timeToLive$]
    \n\tmessage_body   = [$messageBody$]
messagingLogFormatter.receivedMessageFormat

Format used for the log output of MOM incoming message.

Placeholders that can be specified for the format
Thread name:$threadName$
Message ID:$messageId$
Send destination:
 $destination$
Correlation message ID:
 $correlationId$
Reply to:$replyTo$
Expiry interval:
 $timeToLive$
Message body content:
 $messageBody$ [1]
Hex dump of message body:
 $messageBodyHex$ [1]
Message body byte length:
 $messageBodyLength$
Default format
@@@@ RECEIVED MESSAGE @@@@
    \n\tthread_name    = [$threadName$]
    \n\tmessage_id     = [$messageId$]
    \n\tdestination    = [$destination$]
    \n\tcorrelation_id = [$correlationId$]
    \n\treply_to       = [$replyTo$]
    \n\tmessage_body   = [$messageBody$]
messagingLogFormatter.httpSentMessageFormat

Format used for the log output of HTTP outgoing message.

Placeholders that can be specified for the format
Thread name:$threadName$
Message ID:$messageId$
Sent to:$destination$
Correlation message ID:
 $correlationId$
Message body content:
 $messageBody$ [1]
Hex dump of message body:
 $messageBodyHex$ [1]
Message body byte length:
 $messageBodyLength$
Message header:$messageHeader$
Default format
@@@@ HTTP SENT MESSAGE @@@@
    \n\tthread_name    = [$threadName$]
    \n\tmessage_id     = [$messageId$]
    \n\tdestination    = [$destination$]
    \n\tcorrelation_id = [$correlationId$]
    \n\tmessage_header = [$messageHeader$]
    \n\tmessage_body   = [$messageBody$]
messagingLogFormatter.httpReceivedMessageFormat

Format used for the log output of HTTP incoming message.

Placeholders that can be specified for the format
Thread name:$threadName$
Message ID:$messageId$
Sent to:$destination$
Correlation message ID:
 $correlationId$
Message body content:
 $messageBody$ [1]
Hex dump of message body:
 $messageBodyHex$ [1]
Message body byte length:
 $messageBodyLength$
Message header:$messageHeader$
Default format
@@@@ HTTP RECEIVED MESSAGE @@@@
    \n\tthread_name    = [$threadName$]
    \n\tmessage_id     = [$messageId$]
    \n\tdestination    = [$destination$]
    \n\tcorrelation_id = [$correlationId$]
    \n\tmessage_header = [$messageHeader$]
    \n\tmessage_body   = [$messageBody$]
[1](1, 2, 3, 4, 5, 6, 7, 8)
  • $messageBody$: Outputs the result of encoding the message with ISO-8859-1 fixed.
  • $messageBodyHex$: $messageBody$ are output by hexadump.
Example of the description
messagingLogFormatter.className=nablarch.fw.messaging.logging.MessagingLogFormatter
messagingLogFormatter.maskingChar=#
messagingLogFormatter.maskingPatterns=<password>(.+?)</password>,<mobilePhoneNumber>(.+?)</mobilePhoneNumber>

# MOM messaging format
messagingLogFormatter.sentMessageFormat=@@@@ SENT MESSAGE @@@@\n\tthread_name    = [$threadName$]\n\tmessage_id     = [$messageId$]\n\tdestination    = [$destination$]\n\tcorrelation_id = [$correlationId$]\n\treply_to       = [$replyTo$]\n\ttime_to_live   = [$timeToLive$]\n\tmessage_body   = [$messageBody$]
messagingLogFormatter.receivedMessageFormat=@@@@ RECEIVED MESSAGE @@@@\n\tthread_name    = [$threadName$]\n\tmessage_id     = [$messageId$]\n\tdestination    = [$destination$]\n\tcorrelation_id = [$correlationId$]\n\treply_to       = [$replyTo$]\n\tmessage_body   = [$messageBody$]

# Format for HTTP messaging
messagingLogFormatter.httpSentMessageFormat=@@@@ HTTP SENT MESSAGE @@@@\n\tthread_name    = [$threadName$]\n\tmessage_id     = [$messageId$]\n\tdestination    = [$destination$]\n\tcorrelation_id = [$correlationId$]\n\tmessage_header = [$messageHeader$]\n\tmessage_body   = [$messageBody$]
messagingLogFormatter.httpReceivedMessageFormat=@@@@ HTTP RECEIVED MESSAGE @@@@\n\tthread_name    = [$threadName$]\n\tmessage_id     = [$messageId$]\n\tdestination    = [$destination$]\n\tcorrelation_id = [$correlationId$]\n\tmessage_header = [$messageHeader$]\n\tmessage_body   = [$messageBody$]

7.1.1.2.6.2.2. Output as a structured log in JSON format

Logs can be output in JSON format by using Output as a structured log in JSON format setting, but MessagingLogFormatter outputs each item of the failure log as a string in the message value.

To output each item in the failure log as a JSON value as well, use the MessagingJsonLogFormatter. You can configure in the property file described in Configure various logs.

Description rules

The properties to be specified when using MessagingJsonLogFormatter are as follows.

messagingLogFormatter.className required
To output logs in JSON format, specify MessagingJsonLogFormatter.
messagingLogFormatter.maskingPatterns

Specify the character string to be masked in the message body with a regular expression. The first capture part (enclosed in parentheses) specified by the regular expression will be the target for masking.

For example, if “<password>(.+?)</password>” is specified as the pattern, and “<password>hoge</password>” is included in the message, then the output string will be “<password>****</password>”.

If more than one is specified, separate them with commas. The specified regular expression is not case-sensitive.

messagingLogFormatter.maskingChar
Character used for masking. Default is “*”.
messagingLogFormatter.sentMessageTargets

Items used for the log output of MOM outgoing message. Separated by comma.

Output items that can be specified and default output items
Label:label default
Thread name:threadName default
Message ID:messageId default
Send destination:
 destination default
Correlation message ID:
 correlationId default
Reply to:replyTo default
Expiry interval:
 timeToLive default
Message body content:
 messageBody [2] default
Hex dump of message body:
 messageBodyHex [2]
Message body byte length:
 messageBodyLength
messagingLogFormatter.receivedMessageTargets

Items used for the log output of MOM incoming message. Separated by comma.

Output items that can be specified and default output items
Label:label default
Thread name:threadName default
Message ID:messageId default
Send destination:
 destination default
Correlation message ID:
 correlationId default
Reply to:replyTo default
Expiry interval:
 timeToLive
Message body content:
 messageBody [2] default
Hex dump of message body:
 messageBodyHex [2]
Message body byte length:
 messageBodyLength
messagingLogFormatter.httpSentMessageTargets

Items used for the log output of HTTP outgoing message. Separated by comma.

Output items that can be specified and default output items
Label:label default
Thread name:threadName default
Message ID:messageId default
Send destination:
 destination default
Correlation message ID:
 correlationId default
Message body content:
 messageBody [2] default
Hex dump of message body:
 messageBodyHex [2]
Message body byte length:
 messageBodyLength
Message header:messageHeader default
messagingLogFormatter.httpReceivedMessageTargets

Items used for the log output of HTTP incoming message. Separated by comma.

Output items that can be specified and default output items
Label:label default
Thread name:threadName default
Message ID:messageId default
Send destination:
 destination default
Correlation message ID:
 correlationId default
Message body content:
 messageBody [2] default
Hex dump of message body:
 messageBodyHex [2]
Message body byte length:
 messageBodyLength
Message header:messageHeader default
messagingLogFormatter.sentMessageLabel
Value to be output to the label in the log output of MOM outgoing message. Default is "SENT MESSAGE"。
messagingLogFormatter.receivedMessageLabel
Value to be output to the label in the log output of MOM incoming message. Default is "RECEIVED MESSAGE"。
messagingLogFormatter.httpSentMessageLabel
Value to be output to the label in the log output of HTTP outgoing message. Default is "HTTP SENT MESSAGE"。
messagingLogFormatter.httpReceivedMessageLabel
Value to be output to the label in the log output of HTTP incoming message. Default is "HTTP RECEIVED MESSAGE"。
messagingLogFormatter.structuredMessagePrefix
A marker string given at the beginning of a message to identify that the message string after formatting has been formatted into JSON format. If the marker string at the beginning of the message matches the marker string set in JsonLogFormatter, JsonLogFormatter processes the message as JSON data. The default is "$JSON$". If you change it, set the same value in JsonLogFormatter using LogWriter’s structuredMessagePrefix property (see Configure log output for LogWriter properties).
[2](1, 2, 3, 4, 5, 6, 7, 8)
  • messageBody: Outputs the result of encoding the message with ISO-8859-1 fixed.
  • messageBodyHex: messageBody are output by hexadump.
Example of the description
messagingLogFormatter.className=nablarch.fw.messaging.logging.MessagingJsonLogFormatter
messagingLogFormatter.structuredMessagePrefix=$JSON$

# Targets for MOM messaging
messagingLogFormatter.sentMessageTargets=threadName,messageId,destination,correlationId,replyTo,timeToLive,messageBody
messagingLogFormatter.receivedMessageTargets=threadName,messageId,destination,correlationId,replyTo,messageBody

# Targets for HTTP messaging
messagingLogFormatter.httpSentMessageTargets=threadName,messageId,destination,correlationId,messageHeader,messageBody
messagingLogFormatter.httpReceivedMessageTargets=threadName,messageId,destination,correlationId,messageHeader,messageBody