xUML Runtime Logger Configuration

channel

A channel is an object that describes the data that will be written to a log file. It is identified by a channel name.

The following channel names are reserved for internal use of the xUML Runtime:

• error

• access

• channels starting with "xUML" in any casing

error

Write service logging data (bridgeserver log).

access

Write transaction logging data.

sink

A channel can contain an arbitrary number of sinks. Sinks define the logging output and how it is written:

• log file name and path patterns

• log file format

• logged content

Sink names are not important but you need them to access the logging configurations via the xUML Runtime API (refer to Integration User's Guide for further information). Do not rename the sinks of the access and error channels.

type

Define whether to write to a file (daily or hourly rotation), or to std_out or std_err.

std_out

Write logs to std_out.

^{"type": "hourly_rotated_file",
"params": {
"name_pattern": logs/transaction_%Y-%m-%d-%H.log"
}}

std_err

Write logs to std_err.

daily_rotated_file

Write to a daily rotated log file.

hourly_rotated_file

Write to an hourly rotated log file.

params

Define parameters of the sink. At the moment, only accepted parameter is name_pattern to define the name of the log file.

name_pattern

Defines the relative path and file name pattern of the log file. See Name Patterns for Log Files for available placeholders.

formatter

type

Define in which format the log data will be logged to the log file.

json

Log the log file data in JSON format.

Example 1:

^{"formatter" : {
   "type" : "pattern" ,
  "params": {
     "pattern" : "{timestamp:%Y-%m-%d\t%T\t%z}\t..."
  }
}}

Example 2:

^{"formatter" : {
  "type": "json"
}}

pattern

Log the log file data according to a given pattern. The used pattern is defined in the params attribute via attribute pattern.

params

If format type is pattern, specify the log file pattern.

See Format Variables for Log File Content for more on the available variables.

legacy_utc

Enable UTC timestamp for monitoring logs.

This is a legacy option. Do not use.

true

Use UTC in timestamp.

false

Do not use UTC in timestamp.

filters

level

Provide an array of service log levels to let pass through the filter.

One of None, Fatal, Error, Warning, Info and Debug (case-sensitive).
Refer to Integration User's Guide > Log Levels of an xUML Service for more information.

^{"filters" : [
   {
     "trx_level" : [ "SERVICE" ],
     "domains" : [ "*" , "!PSTATE" , "!CONVERSATION" ]
   },
   {
     "trx_level" : [ "IO_INTERNAL" ],
     "domains" : [ "PSTATE" , "CONVERSATION" ]
   }
]}

trx_level

Provide an array of transaction log levels to let pass through the filter.

One of NONE, CUSTOM, SERVICE, IO_EXTERNAL and IO_INTERNAL (case-sensitive).
Refer to Contents of the Transaction Log > Log Levels for more information.

domains

Provide an array of error domains let pass through the filter. You can invert the filtering by adding a ! sign in front of a domain name.

["*"]

Nothing is filtered.

list of domains
["<domain_1>", "<domain_2>, ...] 

Let logs containing one of the listed domains pass through the filter.

You can invert the filtering by adding a ! sign in front of a domain name, so !domain_1 will not let logs with this domain pass through the filter.

%Y

year, 4 digits

%m

month, 2 digits

%d

day of the month, 2 digits

%H

hour, 24-hour format, 2 digits

%M

minute, 2 digits

%S

second, 2 digits

Format Patterns For Date/Time Variables

%Y

Year as a 4-digit decimal number.

²⁰²⁰

%m

Month as a 2-digit decimal number (range [01,12]).

⁰⁷

%d

Day of the month as a decimal number (range [01,31]).

¹⁵

%F

Equivalent to %Y-%m-%d.

^2020-07-15

%H

Hour as a 2-digit decimal number, 24 hour clock (range [00-23])

¹⁶

%M

Minute as a 2-digit decimal number (range [00,59])

³⁴

%S

Second as a 2-digit decimal number (range [00,60])

²⁵

%T

Equivalent to "%H:%M:%S" (the ISO 8601 time format).

^16:34:25

%z

Offset from UTC in the ISO 8601 format, or no characters if the time zone information is not available.

⁺⁰²⁰⁰

Format Patterns for Numeric Variables

099

Sign-aware zero-padding for numeric types, where 0 is the indicator to apply the padding and 99 the maximum padding width.

010 → 10-digit number with leading zeros.

code

String

error code

^{code}

domain

String

error domain

^{domain}

level

String

error level

^{level}

message

String

error message details

^{message}

pid

Numeric

process id

^{pid}

^{pid:010}

session_id

Numeric

session id

^{{session_id}
{session_id:010}}

timestamp

DateTime

timestamp when the log occurred

^{{timestamp}
{timestamp:%F %T %z}}

component

String

name of the component

^{component}

correlation_id

String

correlation ID

^{{correlation_id}}

domain

String

error domain name

^{domain}

elapsed_ms

Numeric

milliseconds since session start

^{{elapsed_ms}
{elapsed_ms:010}}

param1

String

parameter 1

^{param1}

param2

String

parameter 2

^{param2}

session_id

Numeric

session ID

^{session_id}

timestamp

DateTime

timestamp when the log occurred

^{{timestamp}
{timestamp:%F %T %z}}

trx_entry_type

String

log type

^{{trx_entry_type}}

trx_id

String

transaction ID

^{trx_id}

trx_status

String

status

^{trx_status}

xUML Service Log (bridgeserver)

^{{timestamp:%Y-%m-%d\t%T\t%z}\t{trx_id}\t{session_id}\t{component}\t{elapsed_ms}\t{trx_status}\t{domain}\t{trx_entry_type}\t{param1}\t{param2}\t{correlation_id}}

Transaction Log

^{[{timestamp:%F %T %z}][{session_id:010}][{level}][Internal][{domain}][{code}][{message}]}

Monitoring

^{e2eruntime[{pid}[{timestamp:%F %T UTC}[{level}[Internal[{domain}[{code}[[{message}]]}