Pipeline logging components help you create custom pipeline
logging configurations. They provide the system with instructions
on how to log pipeline events and messages.
- Log writer
- Specifies which log writer to use to write or display the log
file:
- file
- Writes the log events and messages to a specified file name.
- The file log writer uses the Path, Parameter, White Space, and
Filter logging components. For example:
- file://absolute path?parameters [white
space] filter
- cmeadmin
- Writes the log events and messages to the cmeadmin log.
- The cmeadmin log writer uses the White Space and Filter logging
components. For example:
- cmeadmin://[white space] filter
- console
- Writes the log events and messages to the command line console.
- The console log writer uses the Location, Parameters, and Filter
logging components. For example:
- console://file location?parameters filter
- eventlog
- (Microsoft Windows platforms only) Writes the log events and messages
to the Microsoft Windows Event Viewer.
- The eventlog log writer uses the Filter logging components. For
example:
- eventlog://./filter
- Path
- Specifies the file location and file name to write the log information
to:
- File location
- Valid values include:
- stdout - used with the console log writer
- stderr - used with the console log writer
- absolute path - used with the file log writer
- file name
- Indicates which standard product log file to write the information
to. The file name extension determines the type of log file. Valid
log file extension names include:
- .err
- .bad
- .msg
- .SqlDebug.log
- .SqlErr.log
- .MQErr.log
- Parameter
- Specifies optional logging parameters. Valid values include:
- style=bare
- Indicates that the logging does not include timestamps or other
header information. This parameter is typically includes in files
that log UMF messages.
- rotateSize=maximum file size number
- Indicates the maximum file size in kilobytes for the log file.
When the file exceeds the maximum file size, the system automatically
archives the log file and creates a new file to use for logging. The
system appends a 0 to the archive file name, and the new file takes
on the original file name. This process continues until the system
reaches the maximum number of archive files indicated in the keep parameter.
- keep=maximum number of archive files
- Indicates the maximum number of archive files to keep during the
automatic file rotation, based on the rotateSize parameter.
When the maximum number of files is exceeded, the system writes over
the oldest archive log file with the new log information.
- White Space
- Indicates what type of white space to place in the log file. Valid
values include:
- Filter
- Indicates the log information to be recorded. Valid values include:
- Module
- Indicates the type of messages to log.Valid values include:
- $NODE_NAME - generic messages
- sql - SQL messages
- mq - message queue messages
- bad_xml - invalid or malformed UMF messages
- msg - UMF exceptions
- logger - logger messages
If you want to include all module types, use an asterisk wild
card character. For example:
- console://stdout *.ERR
- Severity
- Indicates the severity level of the log message. Valid values
include:
- CRIT - critical messages
- ERR - error messages
- WARN - warning messages
- NOTE - notices
- INFO - informational messages
- PERF - performance messages
- DBUG - debug messages
If you want to include all severity types, use an asterisk wild
card character. For example:
- console://stdout *.*
- If you want to exclude one severity from being reported, use the
exclamation point. For example:
- console://stdout mq.!DBUG