Hitachi

JP1 Version 12 JP1/Performance Management User's Guide


17.4.2 Details on log information

This section describes the log information output from Performance Management.

Organization of this subsection

(1) Common message logs and operation status logs

The following tables list (by OS) the services or controls that are the output sources, the log file names, and the amount of disk space used for common message logs and operation status logs. The wrap-around file method is used to write data to the operation status log.

Table 17‒9: File names of common message logs (in Windows)

Type of log information

Output source

File name

Disk space used#1 (KB)

Common message log

Performance Management

installation-folder\log\jpclog{01|02}#2

8,192 (× 2) (default)

installation-folder\log\jpclogw{01|02}#2

8,192 (× 2) (default)

Common message log (for logical host use)

Performance Management for logical host use

environment-directory#3\jp1pc\log\jpclog{01|02}#2

8,192 (× 2) (default)

environment-directory#3\jp1pc\log\jpclogw{01|02}#2

8,192 (× 2) (default)

#1

The value in parentheses is the number of log files that can be created for a single service. For example, 256 (× 2) indicates that up to two log files, each using 256 KB of disk space, can be created. In this case, a total of 512 KB of disk space will be used.

#2

The value 01 or 02 is appended to the file name of the common message log.

For the sequential file method (jpclog)

This method always writes the newest log information to the jpclog01 file (whose name ends with 01).

When the log file size reaches the specified value, the method renames the file from jpclog01 to jpclog02 and saves the file. Then the method creates another file named jpclog01 and writes the newest log information to it.

For the wrap-around file method (jpclogw)

When the log file size reaches the set value, the next log file contents are cleared, and the newest log information is written in the next log file. The file to be written to changes in the following manner: the file after jpclogw01 is jpclogw02 and the file after jpclogw02 is jpclogw01.

#3

The environment directory is a folder on the shared disk specified at the time the logical host is created.

Table 17‒10: File names of operation status logs (in Windows)

Type of log information

Output source

File name

Disk space used#1 (KB)

Operation status log

PFM - Web Console

installation-folder\log\jpcwtracelog-file-number#2.log

4,096 (× 10)

For the jpcrpt command (one-execution-per-log recording method)#3

installation-folder\log\jpcrpt_process-ID-of-executed-command_log-file-number#2.log

For the jpcrpt command (multiple-executions-per-log recording method)#3

installation-folder\log\jpcrpt_loglog-file-number#2.log

For the jpcrdef, jpcasrec, jpcaspsv or jpcprocdef command

installation-folder\log\command-name_sub-command-name_log-file-number#2.log

For the jpcmkkey command

installation-folder\log\jpcmkkey_log-file-number#2.log

For all other commands

installation-folder\log\command-name_log-file-number#2.log

4,096 (× 10 × 13 (number of PFM - Web Console commands)) + 8192

#1

The value in parentheses is the number of log files that can be created for a single service. For example, 256 (× 2) indicates that up to two log files, each using 256 KB of disk space, can be created. In this case, a total of 512 KB of disk space will be used.

#2

The log file number is the number of output log files, starting from 1.

Operation status log output

The output size of the operation status log (excluding the log for the jpcrpt command) can be set by using logFileSize × logFileNumber in the initialization file (config.xml).

#3

For details about the log output format of the jpcrpt command, see 17.4.2(1)(a) Log output format of the jpcrpt command.

Table 17‒11: File names of common message logs (in UNIX)

Type of log information

Output source

File name

Disk space used#1 (KB)

Common message log

Performance Management

/opt/jp1pc/log/jpclog{01|02}#2

8,192 (× 2) (default)

/opt/jp1pc/log/jpclogw{01|02}#2

8,192 (× 2) (default)

Common message log (for logical host use)

Performance Management for logical host use

environment-directory#3/jp1pc/log/jpclog{01|02}#2

8,192 (× 2) (default)

environment-directory#3/jp1pc/log/jpclogw{01|02}#2

8,192 (× 2) (default)

#1

The value in parentheses is the number of log files that can be created for a single service. For example, 256 (× 2) indicates that up to two log files, each using 256 KB of disk space, can be created. In this case, a total of 512 KB of disk space will be used.

#2

The value 01 or 02 is appended to the file name of the common message log.

For the sequential file method (jpclog)

This method always writes the newest log information to the jpclog01 file (whose name ends with 01).

When the log file size reaches the set value, the file is renamed from jpclog01 to jpclog02 and then saved. Another file named jpclog01 is created and the newest log information is written to this file.

For the wrap-around file method (jpclogw)

When the log file size reaches the set value, the next log file contents are cleared, and the newest log information is written in the next log file. The file to be written to changes in the following manner: the file after jpclogw01 is jpclogw02 and the file after jpclogw02 is jpclogw01.

#3

The environment directory is a directory on the shared disk specified at the time the logical host is created.

Table 17‒12: File names of operation status logs (in UNIX)

Type of log information

Output source

File name

Disk space used#1 (KB)

Operation status log

PFM - Web Console

/opt/jp1pcwebcon/log/jpcwtracelog-file-number#2.log

4,096 (× 10)

For the jpcrpt command (one-execution-per-log recording method)#3

/opt/jp1pcwebcon/log/jpcrpt_process-ID-of-executed-command_log-file-number#2.log

For the jpcrpt command (multiple-executions-per-log recording method)#3

/opt/jp1pcwebcon/log/jpcrpt_loglog-file-number#2.log

For the jpcrdef, jpcasrec, jpcaspsv or jpcprocdef command

/opt/jp1pcwebcon/log/command-name_sub-command-name_log-file-number#2.log

For the jpcmkkey command

/opt/jp1pcwebcon/log/jpcmkkey_log-file-number#2.log

For all other commands

/opt/jp1pcwebcon/log/command-name_log-file-number#2.log

4,096 (× 10 × 13 (number of PFM - Web Console commands)) + 8192

#1

The value in parentheses is the number of log files that can be created for a single service. For example, 256 (× 2) indicates that up to two log files, each using 256 KB of disk space, can be created. In this case, a total of 512 KB of disk space will be used.

#2

The log file number is the number of output log files, starting from 1.

Operation status log output

The output size of the operation status log (excluding the log for the jpcrpt command) can be set by using logFileSize × logFileNumber in the initialization file (config.xml).

#3

For details about the log output format of the jpcrpt command, see 17.4.2(1)(a) Log output format of the jpcrpt command.

(a) Log output format of the jpcrpt command

As the log recording method for the jpcrpt command, you can choose either of the following:

  • One-execution-per-log recording method

  • Multiple-executions-per-log recording method

To change the log recording method, use outputMultiProcessForJpcrpt in the initialization file (config.xml).

When you change the log recording method, previous log information is not automatically deleted.

If you want to delete previous log information, do so manually.

The details on each log recording method are described below.

■ One-execution-per-log recording method

Each execution of the jpcrpt command is logged in one log file.

HNTRLib's trace function for single executions is used to log the executions of the jpcrpt command.

When you execute the jpcrpt command at least 1,500 times per month (average of 50 times per day) and you use this method to log the executions of the command, you need to specify a short retention period for log files to keep the size of used disk space within the limit as described in the above table.

The following shows an example setting:

  • If the command is executed 3,000 times per month (or on average 100 times per day)

    Limit the retention period of the log files to a maximum of 15 days.

  • If the command is executed 6,000 times per month (or on average 200 times per day)

    Limit the retention period of the log files to a maximum of seven days.

Note that the examples are only a guideline because the retention period for log files for the jpcrpt command that is logged using the one-execution-per-log recording method must satisfy the following condition.

If the total file size for the log files exceeds the value of logFileNumber × logFileSize specified in the initialization file (config.xml), the jpcrpt command deletes log files until the total file size is below the specified value.

In this case, only the files updated earlier than the number of days specified by logFileRetention in the initialization file (config.xml) are deleted.

Below are examples of how to calculate the retention period.

Example 1:

This example assumes that logFileRetention is set to 3 days (= 72 hours) and the following 6 files remain.

  jpcrpt_3509_log1.log   9 MB  100 hours before
  jpcrpt_3510_log1.log   9 MB   80 hours before
  ------<Reference time (= 72 hours before)>------
  jpcrpt_3511_log1.log   9 MB   60 hours before
  jpcrpt_3512_log1.log   9 MB   40 hours before
  jpcrpt_3513_log1.log   9 MB   20 hours before
  jpcrpt_3514_log1.log   9 MB     Several minutes before

When the jpcrpt command is executed in this situation, the files updated earlier than the reference time are deleted in chronological order until the total size of the log files is below 40 MB. This is because the current total size for the 6 log files is 54 MB, which is greater than 40 MB.

In this example, jpcrpt_3509_log1.log and jpcrpt_3510_log1.log would be deleted. The total file size becomes 36 MB and 4 files remain.

Example 2:

This example assumes that logFileRetention is set to 3 days (= 72 hours) and the following 6 files remain.

  jpcrpt_3509_log1.log   7 MB  100 hours before
  jpcrpt_3510_log1.log   7 MB   80 hours before
  ------<Reference time (= 72 hours before)>------
  jpcrpt_3511_log1.log   7 MB   60 hours before
  jpcrpt_3512_log1.log   7 MB   40 hours before
  jpcrpt_3513_log1.log   7 MB   20 hours before
  jpcrpt_3514_log1.log   7 MB   Several minutes before

When the jpcrpt command is executed in this situation, the files updated earlier than the reference time are deleted in chronological order until the total size of the log files is below 40 MB. This is because the current total size for the 6 log files is 42 MB, which is greater than 40 MB.

In this example, jpcrpt_3509_log1.log would be deleted. The total file size becomes 35 MB and 5 files remain including jpcrpt_3510_log1.log, which is updated earlier than the reference time.

Example 3:

This example assumes that logFileRetention is set to 3 days (= 72 hours) and the following 6 files remain.

  jpcrpt_3509_log1.log   1 MB  100 hours before
  jpcrpt_3510_log1.log   1 MB   80 hours before
  ------<Reference time (= 72 hours before)>------
  jpcrpt_3511_log1.log   1 MB   60 hours before
  jpcrpt_3512_log1.log   1 MB   40 hours before
  jpcrpt_3513_log1.log   1 MB   20 hours before
  jpcrpt_3514_log1.log   1 MB   Several minutes before

Even if the jpcrpt command is executed in this situation, none of the files are deleted, including those updated earlier than the reference time, because the total log file size is 6 MB, which is smaller than 40 MB.

Example 4:

This example assumes that logFileRetention is set to 30 days (= 720 hours) and the following 6 files remain.

  ------<Reference time (= 720 hours before)>------
  jpcrpt_3509_log1.log   9 MB  100 hours before
  jpcrpt_3510_log1.log   9 MB   80 hours before
  jpcrpt_3511_log1.log   9 MB   60 hours before
  jpcrpt_3512_log1.log   9 MB   40 hours before
  jpcrpt_3513_log1.log   9 MB   20 hours before
  jpcrpt_3514_log1.log   9 MB     Several minutes before

When the jpcrpt command is executed in this situation, the current total size for the 6 files would be 54 MB, which is greater than 40 MB. However, because none of the retention times for the files exceeds 30 days (= 72 hours) from the time they were saved, as set in logFileRetention, none of the files would be deleted.

■ Multiple-executions-per-log recording method

Multiple executions of the jpcrpt command are logged in a log file.

HNTRLib's trace function for multiple executions is used to log the executions of the jpcrpt command.

The number of log files and the maximum size of a log file can be specified separately from the settings for operation status logs (logFileSize, logFileNumber).

With the multiple-executions-per-log recording method, log information is written in wrap-around format. If the specified file size is exceeded, old data is overwritten automatically.

For this reason, you do not need to specify a short retention period for log files to keep the used disk space within the specified limits like you do for the one-execution-per-log recording method.

Also note that log files are not deleted when the multiple-executions-per-log recording method is used because the logFileRetention setting has no influence.

Note the following when you log the executions of the jpcrpt command using this method.

  • The executions of the jpcrpt command are not logged when locks are not obtained.

  • The size of the log files is fixed. The log data of one execution of the jpcrpt command ends with an EOF character.

  • In addition to the log files, a management file is created.

  • The executions of the jpcrpt command are logged in multiple log files in wrap-around fashion. This means that when all the log files become full, the first log file starts to be overwritten. Older executions of the jpcrpt command exist after each EOF character.

The following example describes how to calculate the approximate number of executions of the jpcrpt command each log file can contain when the multiple-executions-per-log recording method is used.

Example:

Number of executions of the jpcrpt command that can be recorded in a log file when the jpcrpt command outputs messages of the WARN log level to a report file

When the jpcrpt command outputs messages of the WARN log level to a report file, approximately 50 kilobytes of log data is recorded in a log file for each execution of the jpcrpt command.

Use the following formula to calculate the approximate number of executions of the jpcrpt command that can be recorded in a log file:

(logFileNumberMulti × logFileSizeMulti × 1,024 kilobytes) / 50 kilobytes

As a result, a log file can record 819 executions of the jpcrpt command (10 × 4 × 1,024 ÷ 50 = 819) with default settings when the multiple-executions-per-log recording method is used.

(2) Trace log

The following tables list (by OS) the services or controls that are the output sources and the installation directories for trace logs.

Table 17‒13: Installation folder names of trace logs (in Windows)

Type of log information

Output source

Folder name

Trace log

Action Handler

installation-folder\bin\action\log\

Agent Collector and Remote Monitor Collector

installation-folder\xxxx#1\agent\instance-name#2\log\

Agent Store and Remote Monitor Store

installation-folder\xxxx#1\store\instance-name#2\log\

Correlator

installation-folder\mgr\clator\log\

Agent Collector (health check agent)

installation-folder\agt0\agent\log\

Agent Store (health check agent)

installation-folder\agt0\store\log\

Master Store

installation-folder\mgr\store\log\

Master Manager

installation-folder\mgr\manager\log\

Name Server

installation-folder\mgr\namesvr\log\

Performance Management command

installation-folder\tools\log\

Status Server

installation-folder\bin\statsvr\log\

Trap Generator

installation-folder\mgr\trapgen\log\

View Server

installation-folder\mgr\viewsvr\log\

Trace log (for logical host use)

Action Handler

environment-directory#3\jp1pc\bin\action\log\

Agent Collector and Remote Monitor Collector

environment-directory#3\jp1pc\xxxx#1\agent\instance-name#2\log\

Agent Store and Remote Monitor Store

environment-directory#3\jp1pc\xxxx#1\store\instance-name#2\log\

Correlator

environment-directory#3\jp1pc\mgr\clator\log\

Agent Collector (health check agent)

environment-directory#3\jp1pc\agt0\agent\log\

Agent Store (health check agent)

environment-directory#3\jp1pc\agt0\store\log\

Master Store

environment-directory#3\jp1pc\mgr\store\log\

Master Manager

environment-directory#3\jp1pc\mgr\manager\log\

Name Server

environment-directory#3\jp1pc\mgr\namesvr\log\

Performance Management command

environment-directory#3\jp1pc\tools\log\

Trap Generator

environment-directory#3\jp1pc\mgr\trapgen\log\

View Server

environment-directory#3\jp1pc\mgr\viewsvr\log\

#1

xxxx indicates the service key of each PFM - Agent or PFM - RM. For details on service keys of each PFM - Agent or PFM - RM, see the description of the naming rules in an appendix of the JP1/Performance Management Planning and Configuration Guide.

#2

For a PFM - Agent or PFM - RM monitoring an application program which can start multiple service sets on a single host, there is a folder for each instance.

#3

The environment directory is a folder on the shared disk specified at the time the logical host is created.

Table 17‒14: Installation directory names of trace logs (in UNIX)

Type of log information

Output source

Directory name

Trace log

Action Handler

/opt/jp1pc/bin/action/log/

Agent Collector and Remote Monitor Collector

/opt/jp1pc/xxxx#1/agent/instance-name#2/log/

Agent Store and Remote Monitor Store

/opt/jp1pc/xxxx#1/store/instance-name#2/log/

Correlator

/opt/jp1pc/mgr/clator/log/

Agent Collector (health check agent)

/opt/jp1pc/agt0/agent/log/

Agent Store (health check agent)

/opt/jp1pc/agt0/store/log/

Master Store

/opt/jp1pc/mgr/store/log/

Master Manager

/opt/jp1pc/mgr/manager/log/

Name Server

/opt/jp1pc/mgr/namesvr/log/

Performance Management command

/opt/jp1pc/tools/log/

Status Server

/opt/jp1pc/bin/statsvr/log/

Trap Generator

/opt/jp1pc/mgr/trapgen/log/

View Server

/opt/jp1pc/mgr/viewsvr/log/

Trace log (for logical host use)

Action Handler

environment-directory#3/jp1pc/bin/action/log/

Agent Collector and Remote Monitor Collector

environment-directory#3/jp1pc/xxxx#1/agent/instance name#2/log/

Agent Store and Remote Monitor Store

environment-directory#3/jp1pc/xxxx#1/store/instance name#2/log/

Correlator

environment-directory#3/jp1pc/mgr/clator/log/

Agent Collector (health check agent)

environment-directory#3/jp1pc/agt0/agent/log/

Agent Store (health check agent)

environment-directory#3/jp1pc/agt0/store/log/

Master Store

environment-directory#3/jp1pc/mgr/store/log/

Master Manager

environment-directory#3/jp1pc/mgr/manager/log/

Name Server

environment-directory#3/jp1pc/mgr/namesvr/log/

Performance Management command

environment-directory#3/jp1pc/tools/log/

Trap Generator

environment-directory#3/jp1pc/mgr/trapgen/log/

View Server

environment-directory#3/jp1pc/mgr/viewsvr/log/

#1

xxxx indicates the service key of each PFM - Agent or PFM - RM. For details on service keys of each PFM - Agent or PFM - RM, see the description of the naming rules in an appendix of the JP1/Performance Management Planning and Configuration Guide.

#2

For a PFM - Agent or PFM - RM monitoring an application program which can start multiple service sets on a single host, there is a directory for each instance.

#3

The environment directory is a directory on the shared disk specified at the time the logical host is created.