Reconciliation job logging
The Reconciliation Engine logs all activities that it performs: Identification, Compare, Merge, Delete, and Purge. A log file for a job is created each time the Reconciliation Engine runs that job. The Reconciliation job logging is enabled by default.
The Reconciliation job logging topic provides information about log details, naming conventions, viewing events, and interpreting log entries.
Log entry details
Each entry in the log provides the following details:
- Timestamp — The date and time of the log entry.
- Log Type — The type of log entry:
- Error — Logs detailed messages for errors and warnings (default).
- Info — Logs class-level details, such as dataset name and class name.
- Debug — Logs trace messages, which are used for debugging errors.
All these logging levels are inclusive of their preceding levels. For example, if you set the Logging Level at Debug, you receive log messages for Error, Info, and Debug types. You can specify the Logging Level for the log files from the Modify Server Configuration window of the Reconciliation Engine Console.
- Message — The message for the log entry.
Log file naming convention
The Reconciliation job log files use the following naming convention:
jobName is the name of the job that you created in the Reconciliation Manager (for example, BMCAsset - Identification and Purge).
ctr is a numeric value that starts from 1 and is incremented when a new log file is created for the job run. The Reconciliation Engine continues to log errors in a new log file when an existing log reaches its size limit.
For example, if multiple files are created for the BMCAsset - Identification and Purge job run, the job log files will be named as:
- BMCAsset - Identification and Purge_1.log
- BMCAsset - Identification and Purge_2.log
Viewing Reconciliation job events in the log file
When the log file for the Reconciliation job is created, an event associated to the job is added to the Reconciliation Engine Console. This event contains the job file name and location.
To change the log levels
- Log in to the BMC Remedy Mid Tier.
- In the AR System Home page, select Atrium Core > Atrium Core Console.
If you access multiple servers from the AR System Home page, select Atrium Core > Atrium Core Console.
The Atrium Core Console opens.
- Select Application Launcher > Advanced > Reconciliation.
- In the reconciliation console, click Edit Server Configuration .
- In the Server Configuration Editor dialog, select an option in the Logging Level list.
To view the event for the log
- Log in to the BMC Remedy Mid Tier.
- Select BMC Atrium Core Console > Reconciliation Manager.
- From the navigation link on the left, click Job History.
The Job History Console is displayed.
- From the Jobs table on the top of the window, choose the specific job.
The Related Runs table is populated with the run status of the job.
- Select the specific job run for the job.
The Related Events table is populated with event information for the job.
- Click the RE Log File & Location event and click View.
The Job Event Information window is displayed.
- Click the Diary field to view the log file path information.
To analyze Reconciliation job log files
The general process of analyzing Reconciliation job logs is the following:
- Open the first job log in a text editor
- Disable line wrap, so you can see the activity more clearly by scrolling to the right in the log.
- To find a particular Configuration Item (CI) in the log, search for its instanceid or ReconciliationIdentity value.
- If the Reconciliation job run generated multiple logs, search in each of the log files.
- When you identify the particular CI, note the value of the thread ID (TID) on that line.
- Search up and down in the file for lines with that TID to view the processing of that CI.
- If the particular CI is not found, search for the class of the CI to see how or if the class was processed.
To debug Reconciliation Engine errors using the log file
The Reconciliation Engine logs errors that can help you to troubleshoot reconciliation issues.
- Search for the entry in the Reconciliation Engine log file that contains [ERROR] in its description.
- Note the thread ID (TID) specified in this error entry.
- Trace back to the beginning of the log file while looking for more entries with the specific TID.
You will find several entries for the specific TID. Each entry reports the task that the Reconciliation Engine performs at each stage.
Interpreting entries in the log file
The Reconciliation job log is a multi-threaded program with all threads writing to the same log file. The log files are divided by activity names. Each of these activities has a start or run entry, indicating the start of the activity, and an end or completed entry indicating the end of the activity. The following examples illustrate both these entries.
Example 1: Starting an activity
Example 2: Ending an activity
Each entry contains a thread ID (TID) that identifies a unique activity. If multiple instances need to be identified, the Reconciliation job creates separate threads for each instance identification. Therefore, the log file contains mixed entries for various threads instead of having one section for each thread.
The following code is an example of a Reconciliation job log file.
In this example, the Identification Rule looks for a match based on the value of the
Character_Field attribute. An error is generated for this job because the Reconciliation Engine finds multiple matches in the lookup dataset against which the CI is to be identified. As a result of the error, the Configuration Item (CI) in the source dataset is not identified and the Reconciliation ID remains 0.
In the Reconciliation Engine if the logging level is set to debug, the arrecond.log file that stores the logs becomes large in size. It can grow to a size that is in multiple Gigabytes (GB). As a result, it is difficult to open the log file to analyze logs.
To control the file size of the log file, you can edit the reconciliation engine configuration options. A value of zero indicates that the limit on the maximum file size is not specified. In that case, the log file takes the default value. The default value is of 20480KB (20MB). You can specify the log file size value in the range from 0 to 2097152 KB (2GB).
When the file size of the arrecond.log file reaches the maximum size, the Reconciliation Engine automatically renames this file to arrecond_1.log and writes further logs to the arrecond.log file. Thus, the arrecond.log file is always the latest log file, and the arrecond_highestNumber.log is the latest backup file.