3.4.1 What is log file trapping for JP1/Base?

Log file trapping is one of the functions provided by JP1/Base, and converts log file records to events. To monitor Windows event logs in JP1/IM, log file traps are used.

To set the log file trapping:

Use IM Configuration Management to create a log file trap action-definition file on the host to be monitored.
Use IM Configuration Management to start the log file trap on the host to be monitored.

This manual describes an example of setting the log file trap for log files on host 1 in the basic configuration system shown in 2.1 Overview of a basic configuration system. The target log files have the following format:

Records are sequentially added from the beginning of the file (sequential file).
A line of variable-length character string is stored as a record.

Sample log file:

-----------------------------------------------------

2014/03/07 12:00:00.001 AAAA1111-E "System Error" .....

2014/03/07 12:00:00.002 AAAA1112-I "Information" .....

2014/03/07 12:00:00.003 AAAA1113-I "Warning" .....

:

-----------------------------------------------------

If you want to set the log file trap for log files of a format other than described in this manual, see the descriptions of event conversion in the JP1/Base User's Guide, and check the log file format.

Organization of this subsection

(1) Settings of the the log file trap action-definition file
(2) Using IM Configuration Management to create log file trap action-definition files on hosts to be monitored
(3) Using IM Configuration Management to start the log file trap on the host to be monitored

(1) Settings of the the log file trap action-definition file

The following provides the detailed settings of the log file trap action-definition file, which will be created in 3.4.1 (2) Using IM Configuration Management to create log file trap action-definition files on hosts to be monitored.

Specification details

Specification	Description
`FILETYPE=SEQ` `RECTYPE=VAR '\n'`	Specifies the format of the log file that is the target of the log file trap. In this manual, the target is SEQ sequential files in which a variable-length record is stored per line.
`ACTDEF=<Error>00000111 "System Error"`	Specifies the event conversion condition for records written in the log file. To specify the severity level and event ID of the events converted from records containing a specific character string, specify the following: `ACTDEF=<severity-level>event-ID` `"character-string-in-records-to-be-converted"`. In this example, records containing the character string `System Error` are converted to events whose severity level is `Error` and event ID is `00000111`.

Specification

Description

FILETYPE=SEQ

RECTYPE=VAR '\n'

Specifies the format of the log file that is the target of the log file trap. In this manual, the target is SEQ sequential files in which a variable-length record is stored per line.

ACTDEF=<Error>00000111 "System Error"

Specifies the event conversion condition for records written in the log file. To specify the severity level and event ID of the events converted from records containing a specific character string, specify the following: ACTDEF=<severity-level>event-ID "character-string-in-records-to-be-converted". In this example, records containing the character string System Error are converted to events whose severity level is Error and event ID is 00000111.

The following shows an example of a record to be converted to an event, and an example of an event after conversion.

Record to be converted to an event:

2014/03/07 12:00:00.001 AAAA1111-E "System Error" .....

Event after conversion

Severity level: Error
Event ID: 00000111
Message: 2014/03/07 12:00:00.001 AAAA1111-E "System Error" .....

To Page Top

(2) Using IM Configuration Management to create log file trap action-definition files on hosts to be monitored

Because JP1 users set log file traps, you need to use IM Configuration Management to create log file trap action-definition files on hosts to be monitored. Perform this procedure on the host to be monitored.

Prerequisites

The following conditions must be satisfied:

The basic configuration system is set up according to 3.1 What is IM Configuration Management?.
Host information has been collected.
Log files exist.

Procedure

From the Windows Start menu, select All Programs, JP1_Integrated Management - View, and then Configuration Management. The Login window appears.
Enter jp1admin for User name, jp1admin for Password, and admin for Host to connect, and then log in. The IM Configuration Management window appears.
Click the IM Configuration tab. Then, in the tree area on the IM Configuration page, select the hosts on which you want to monitor log files.
On the menu bar, select View, and then Display Profiles. The Display/Edit Profile window appears.
In the tree display area, select JP1/Base.
In the pop-up menu displayed by right-clicking, select Exclusive Editing Settings to obtain exclusive editing rights.
In the tree display area, select Log File Trapping.
In the pop-up menu displayed by right-clicking, select Add Profile to add a log file trap name.
Specify a log file trap name to ensure that the setting values will be unique.

Enter a unique log file trap name in the text box that appears. To specify a cluster ID, select the Enable check box, and then enter the cluster ID. Note that the log file trap is managed by the log file trap name entered here.
Click the OK button.

The added log file trap name appears in the tree display area. The contents of the log file trap definition file corresponding to the log file trap name appear in the node display area of the Display/Edit Profile window.

Note that immediately after the log file trap name is added, nothing is set in the log file trap action-definition file.
Specify startup options.

The following are specification examples:
- Monitoring log file: c:\log\logfile1.log
- Additional options: None
If the host to be added is running on Linux, in Additional options, specify the character encoding of the log file that will be the target of the log file trap.
Edit the log file trap action-definition file.

The following is an entry example:

FILETYPE=SEQ

RECTYPE=VAR '\n'

ACTDEF=<Error>00000111 "System Error"
After editing the startup options and settings, click the Execute button.
When a dialog box asking you whether you want to apply the settings appears, click the Yes button.

If a KNAN20321-Q message appears in the dialog box, the settings will be applied when IM Configuration Management starts up the log file trap.

Related topics

3.5.1 Setting the profiles on hosts in an agent configuration in the Configuration Guide
5.1.2 IM Configuration page in the manual GUI Reference
5.9 Display/Edit Profiles window in the manual GUI Reference
Descriptions about converting application program log files in the JP1/Base User's Guide
Descriptions of the log file trap action-definition file in the JP1/Base User's Guide
Descriptions of the log-file trap startup definition file in the JP1/Base User's Guide

To Page Top

(3) Using IM Configuration Management to start the log file trap on the host to be monitored

Use IM Configuration Management to start log file traps so that JP1 users can monitor application log file records in JP1/IM. Perform this procedure on the host to be monitored.

Prerequisites

The following conditions must be satisfied:

A log file trap action-definition file has been created on the host to be monitored.
Exclusive editing rights for profiles have been obtained forJP1/Base on the host to be monitored.
TheJP1/Base LogTrap service is running on the host to be monitored.

Procedure

In the tree display area of the Display/Edit Profile window, select the log file trap name for the log file trap you want to start.
Start the log file trap by using either of the following methods:
- On the menu bar, select Operation, and then Start Process.
- In the pop-up menu displayed by right-clicking, select Start Process.

Related topics

3.5.1 Setting the profiles on hosts in an agent configuration in the Configuration Guide
5.9 Display/Edit Profiles window in the manual GUI Reference
Descriptions of converting application program log files in the JP1/Base User's Guide

To Page Top