Troubleshooting
Problem
Resolving The Problem
In Maximo, administrators can log messages from a simple configuration file and see the log messages output in various different formats. From these log files, it should be possible to figure out the process flow from the log messages to debug the problem. This document explains logging for Maximo.
Maximo incorporates logging functionality based on an open source logging API called Log4j. The Log4j API was developed by Apache Software Foundation as part of the Apache Jakarta Project. The purpose of Maximo logging functionality and its usage is to help resolve problems quickly without changing released code.
Maximo Logging Basics
Logging is performed in Maximo using a logger object. Loggers define a hierarchy and provide the run-time control to print statements or not. Loggers are named entities. Logger names are case-sensitive and they follow the hierarchical naming rule.
Specifying Log Information
Make changes in the Logging application by going to System Configuration > Platform Configuration. You must be logged in as a user with administrative privileges to modify the Logging and apply and save changes. You can change logging properties without restarting Maximo, and they will take effect immediately upon selecting Apply Settings from the Select Action Menu.
See Creating a SQL Log File to Troubleshoot Problems for details on setting up logging in Maximo.
Log Levels in Detail
A logger is said to be an ancestor of another logger if its name followed by a dot is a prefix of the descendant logger name. A logger is said to be a parent of a child logger if there are no ancestors between it and the descendant logger. Loggers are assigned levels.
A log statement is printed depending on its level and its logger. The following log levels supported for any logger are FATAL, ERROR, WARN, INFO, DEBUG.
A level of OFF can be used to turn off log messages to a specific logger.
The log levels are also inherited. If a given logger is not assigned a level, then it inherits the one from its closest ancestor with an assigned level.
The inherited level for a given logger C, is equal to the first non-null level in the logger hierarchy, starting at C and proceeding upwards in the hierarchy towards the root logger.
Appenders
An Appender is an output destination (usually a file, or sometimes a location, such as a console window) where log information can be written to. Logging requests can be sent to more than one output destination (appender, file).
Usage
FATAL
ERROR
WARN
INFO
DEBUG
NOTE: DEBUGFATAL
Maximo loggers are organized based on Maximo functional hierarchy. Application framework code uses the following fixed loggers to output framework related messages that are common to all.
Hierarchy
A logging request is enabled if its level is equal to or higher than the logger level. Otherwise, the request is disabled. The levels are in the following order from highest to lowest:
FATAL> ERROR > WARN> INFO > DEBUGThis means that if a logger is enabled for INFO level, it would accept FATAL, ERROR, WARN level messages and discards DEBUG level messages.
Maximo Root Loggers
|
|
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| log4j.logger.maximo.script | To help you identify errors in automation scripts, you can add child script loggers to the root logger for automation scripts. |
See Out of the Box Maximo Loggers for a complete list.
Configuring Maximo Logging
See Enabling Logging and Appenders to Log Application Events for details on setting up logging in Maximo.
Enabling SQL Logging
To see SQL statements that executed by Maximo, set the following setting in the Logging application:
log4j.logger.maximo.sql=INFO
By default, this setting writes all SQL statements that are executed by all business objects to system.out (SystemOut.log for WebSphere). However, setting the root SQL Logger to INFO writes a a large number of messages. Depending on how the application server has been configured to set the number and size of system.out files, the results will most likely not be helpful troubleshooting performance or execution loggers. Therefore, it should be left at ERROR unless the system administrator is advised by Maximo support to change it.
To see SQL statements that are executed by a particular business object and its related business objects, set the following setting in the Maximo log configuration file. For example, to see all WORKORDER service-related SQL statements:
log4j.logger.maximo.sql=ERROR
log4j.logger.maximo.sql.WORKORDER=INFO
Setting the log level of the new WORKORDER logger to INFO writes only SQL statements that executed by business objects of the WORKORDER service to the system.out log files.
The Logging application already contains two SQL loggers (log4j.logger.maximo.sql.WORKORDER.WOSTATUS=INFO and log4j.logger.maximo.sql.crontask.EmailNotification=INFO), as above. You can create, delete and make active or inactive by adding and deleting rows on the sql root logger.
Enable Business Object Logging
To see messages that are output by Maximo business object (mbo) code, set the following setting in the Maximo log configuration file:
log4j.logger.maximo.service=INFO
By default, this setting would output all general messages for all business objects. To see messages that are output by a particular Maximo service and its related business objects, set the following setting in the Maximo log configuration file. To see all WORKORDER service-related messages, set the service and service.WORKORDER loggers as follows:
log4j.logger.maximo.service=ERROR
log4j.logger.maximo.service.WORKORDER=INFO
Those settings would output general messages for all business objects of the WORKORDER service. To see messages that are output by a particular business object only, place the following setting in the Maximo log configuration file to see all WOSTATUS business object messages:
The Logging Application already contains several service loggers, for example,
log4j.logger.maximo.service.BIRTREPORTlog4j.logger.maximo.service.WORKORDER
log4j.logger.maximo.service.CONFIGURE
log4j.logger.maximo.service.WORKORDER.WOSTATUS You can create, delete and make active or inactive service loggers by adding and deleting rows on the service root logger.
Related Information
Historical Number
M04685
Product Synonym
MAXIMO
Was this topic helpful?
Document Information
Modified date:
12 December 2023
UID
swg21264064