11 Oracle Identity Manager Logging Functions

This chapter describes the Oracle Identity Manager logging functions. It contains the following topics:

Overview
Setting the Logging Level, Location and Archiving Frequency

Overview

Oracle Identity Manager comes pre-installed with the ability to create log files related to the activities performed in the application. You can customize the level of information that is placed in these log files, the location where these log files reside, and the frequency of archiving the information in these files using configuration files. Oracle Identity Manager also provides logs files that contain standard error and standard out messages.

You can use the logs files created by Oracle Identity Manager to track activities being performed in the various modules (for example, adapter factory, task scheduler) of the application and monitor error messages and queries performed against the database. Both of these activities can be helpful when troubleshooting potential problems or testing anticipated application behavior.

You can control the following:

The level of information, that is, greater or lesser amount of detail, that is written to the logs.
Whether the logs are periodically archived and, if so, if they should be archived based on a user-specified time range or maximum file size.
The location in which the log file will be placed.

By default, Oracle Identity Manager creates six log files when the application is running. Three of these log files are controlled using a dedicated .cfg file.

The location of log file and its properties are controlled by a properties file located in xlclient_home\config\log.properties.

Setting the Logging Level, Location and Archiving Frequency

The following table explains how to set general behavior for the log files controlled using the .cfg files.

To Control Action

The amount of detail that is written to the logs Set the level of all the Logger.Module.<module_name> entries to the desired logging level. For example, set the Logger.Module.ServerManager entry to ERROR.

If the logs are periodically archived and, if so, if they are archived based on a user-specified time range or maximum file size

To Control	Action
The amount of detail that is written to the logs	Set the level of all the `Logger.Module.<module_name>` entries to the desired logging level. For example, set the `Logger.Module.ServerManager` entry to `ERROR`.
If the logs are periodically archived and, if so, if they are archived based on a user-specified time range or maximum file size	To specify that the log file is never to be archived, set the `Logger.LogFile.RollingType` entry to `NONE`. To specify that the log file is to be archived based on time, date range, or both, set the `Logger.LogFile.RollingType` entry to `FREQUENCY`. Then be sure to set the `Logger.LogFile.DatePattern` to one of the following: `yyyy-MM`: Roll over archiving at the beginning of each month `yyyy-ww`: Roll over archiving at the first day of each week. ww is week in year `yyyy-MM-dd`: Roll over archiving at midnight each day `yyyy-MM-dd-a`: Roll over archiving at midnight and midday each day `yyyy-MM-dd-HH`: Roll over archiving at the top of every hour `yyyy-MM-dd-HH-mm`: Roll over archiving at the beginning of every minute The default setting of the `Logger.LogFile.DatePattern` parameter is `yyyy-MM-dd` (that is, archive at midnight each day). Each archival log file will have a date (and if applicable, a time) value appended to its name. For example, using the default setting, the archives logs from January 2, 2004 and January 3, 2004 would be named `<logfilename`>`.log.2004-01-01`, `<logfilename>.log.2004-01-02`, and so on, at 12 AM of each day respectively. Note: Do not employ the ":" (colon) symbol anywhere in the data pattern. To specify that the log file is to be archived based on size of the log file, set the `Logger.LogFile.RollingType` entry to `SIZE`. Then be sure to set the following: The `Logger.LogFile.MaxFileSize` entry to the file size that you want to cause log file archiving. Once the log file reaches that size, its contents are rolled over to an archival file and any new logs are written to the original file. Oracle Identity Manager will continue to create additional archival files until it reaches the number of log files set in the `Logger.LogFile.MaxBackupInde`x entry described below. The `log4j.appender.logFile.MaxBackupIndex` entry to the maximum number of archival log files you wish to allow Oracle Identity Manager to create. For example, if you set this entry to `5`, Oracle Identity Manager will create a maximum of 5 incremental archival log files not including the actual, non-archival log file. After the fifth archival log is created, additional log archiving will cause the contents of the oldest archival log file to be deleted and replaced with the contents of the next oldest.
The location in which the log file will be placed	To specify the location in which the log file is created, set the `Logger.LogFile.FilePath` entry to the desired location. For example, to specify that the ServerManager.log file to be created in `C:\oracle\xellerate\logs` set this entry to `./logs/ServerManager.log` (the `./` specifies the location of `\oracle\xellerate`). Be sure to specify the log file name as well.

To specify that the log file is never to be archived, set the Logger.LogFile.RollingType entry to NONE.

To specify that the log file is to be archived based on time, date range, or both, set the Logger.LogFile.RollingType entry to FREQUENCY. Then be sure to set the Logger.LogFile.DatePattern to one of the following:

yyyy-MM: Roll over archiving at the beginning of each month
yyyy-ww: Roll over archiving at the first day of each week. ww is week in year
yyyy-MM-dd: Roll over archiving at midnight each day
yyyy-MM-dd-a: Roll over archiving at midnight and midday each day
yyyy-MM-dd-HH: Roll over archiving at the top of every hour
yyyy-MM-dd-HH-mm: Roll over archiving at the beginning of every minute

The default setting of the Logger.LogFile.DatePattern parameter is yyyy-MM-dd (that is, archive at midnight each day). Each archival log file will have a date (and if applicable, a time) value appended to its name. For example, using the default setting, the archives logs from January 2, 2004 and January 3, 2004 would be named <logfilename>.log.2004-01-01, <logfilename>.log.2004-01-02, and so on, at 12 AM of each day respectively.

Note: Do not employ the ":" (colon) symbol anywhere in the data pattern.

To specify that the log file is to be archived based on size of the log file, set the Logger.LogFile.RollingType entry to SIZE.

Then be sure to set the following:

The Logger.LogFile.MaxFileSize entry to the file size that you want to cause log file archiving. Once the log file reaches that size, its contents are rolled over to an archival file and any new logs are written to the original file. Oracle Identity Manager will continue to create additional archival files until it reaches the number of log files set in the Logger.LogFile.MaxBackupIndex entry described below.

The log4j.appender.logFile.MaxBackupIndex entry to the maximum number of archival log files you wish to allow Oracle Identity Manager to create. For example, if you set this entry to 5, Oracle Identity Manager will create a maximum of 5 incremental archival log files not including the actual, non-archival log file. After the fifth archival log is created, additional log archiving will cause the contents of the oldest archival log file to be deleted and replaced with the contents of the next oldest.

The location in which the log file will be placed To specify the location in which the log file is created, set the Logger.LogFile.FilePath entry to the desired location. For example, to specify that the ServerManager.log file to be created in C:\oracle\xellerate\logs set this entry to ./logs/ServerManager.log (the ./ specifies the location of \oracle\xellerate). Be sure to specify the log file name as well.