jima_log

Organization of this page

Function

This tool is used to collect the documents (integrated agent host) required for fault investigation when a fault occurs in JP1/IM - Agent.

Collect the following documents related to JP1/IM - Agent:

Documentation in 12.3.2 Data about JP1/IM - Agent in the JP1/Integrated Management 3 - Manager Administration Guide
JP1/IM agent control base documentation

For Windows, since the collected data is not compressed, compress it with a compressor, etc. as required.

For Linux, the collected material is compressed with tar and gzip commands.

- For Windows

The following table shows the folder structure and contents of the documents stored directly under the data storage folder.

Table 1‒48: Configuration of Collection Materials for the Data Collection Tool (Physical Host)
Folder name	Stored data
`data-storage-folder\jp1_default\jp1ima`	Product information
`data-storage-folder\jp1_default\syslog`	System log information
`data-storage-folder\jp1_default\os`	OS data
`data-storage-folder\jp1_default\communication`	Communication status information
`data-storage-folder\jp1_default\process`	Process information
`data-storage-folder\jp1_default\scilence`	Silence Configuration Info^#
`data-storage-folder\jp1_default\list`	File list
`data-storage-folder\jp1_default\inst`	Installation documentation
`data-storage-folder\jp1_default\secret`	Secret key information
`data-storage-folder\jp1_default\service`	Service information
`data-storage-folder\jp1_default\jima_log_result.log`	Result of executing the data collection command

#: If the jpc_alertmanager service is hesitation, silence configuration is not retrieved.

Table 1‒49: Configuration of Collection Material for the Data Collection Tool (Logical Host)
Folder name	Stored data
`data-storage-folder\logical-hostname\jp1ima`	Product information
`data-storage-folder\logical hostname\scilence`	Silence Configuration Info^#
`data-storage-folder\logical hostname\list`	File list
`data-storage-folder\logical hostname\secret`	Secret key information

#: If the jpc_alertmanager service is hesitation, silence configuration is not retrieved.

Note that the following information is not collected by the data collection tool and must be collected manually.

Data to be collected	Collection object
Product information	If you have already set up the log extraction command for SAP system, collect the following files manually: Environment-parameter configuration file (any name.ini) RFC library allocated when the log extraction command for SAP system was built CRT library allocated when the log extraction command for SAP system was built The following files-stored in the path set in WORKDIR of configuration file environment parameter - Log file of SAP system log extraction command (any name) - SAP system log extraction command trace file (command name.log, command name.dat) - Trace file (dev_rfc*) output by RFC library If the directory where the above files are stored is changed in the environment parameter configuration file or the argument when the log extraction command of SAP system is executed, the changed directory must also be collected. `Destination when SAP system log extract command is installed\agtm` folders If sensitive information such as passwords is included, delete the corresponding definition from the definition file after collection.

Data to be collected

Collection object

Product information

If you have already set up the log extraction command for SAP system, collect the following files manually:

Environment-parameter configuration file (any name.ini)
RFC library allocated when the log extraction command for SAP system was built
CRT library allocated when the log extraction command for SAP system was built
The following files-stored in the path set in WORKDIR of configuration file environment parameter

- Log file of SAP system log extraction command (any name)

- SAP system log extraction command trace file (command name.log, command name.dat)

- Trace file (dev_rfc*) output by RFC library

If the directory where the above files are stored is changed in the environment parameter configuration file or the argument when the log extraction command of SAP system is executed, the changed directory must also be collected.
Destination when SAP system log extract command is installed\agtm folders

If sensitive information such as passwords is included, delete the corresponding definition from the definition file after collection.

- For Linux

The following is a compressed file of the data stored directly under the data-storage-directory.

Table 1‒50: Configuration of Collection Materials for the Data Collection Tool (Physical Host)
Directory name	Stored data
`data-storage-directory/jima_log.tar.gz`	Collected data

Table 1‒51: Configuration of Collection Material for the Data Collection Tool (Logical Host)
Directory name	Stored data
`data-storage-directory/logical host name.tar.gz`	Collected data

Note that the following information is not collected by the data collection tool and must be collected manually.

Data to be collected	Collection object
Product information	If you have already set up the log extraction command for SAP system, collect the following files manually: Environment-parameter configuration file (any name.ini) RFC library allocated when the log extraction command for SAP system was built CRT library allocated when the log extraction command for SAP system was built The following files-stored in the path set in WORKDIR of configuration file environment parameter - Log file of SAP system log extraction command (any name) - SAP system log extraction command trace file (command name.log, command name.dat) - Trace file (dev_rfc*) output by RFC library If the directory where the above files are stored is changed in the environment parameter configuration file or the argument when the log extraction command of SAP system is executed, the changed directory must also be collected. `/opt/jp1pc/agtm directory` If sensitive information such as passwords is included, delete the corresponding definition from the definition file after collection.

Data to be collected

Collection object

Product information

If you have already set up the log extraction command for SAP system, collect the following files manually:

Environment-parameter configuration file (any name.ini)
RFC library allocated when the log extraction command for SAP system was built
CRT library allocated when the log extraction command for SAP system was built
The following files-stored in the path set in WORKDIR of configuration file environment parameter

- Log file of SAP system log extraction command (any name)

- SAP system log extraction command trace file (command name.log, command name.dat)

- Trace file (dev_rfc*) output by RFC library

If the directory where the above files are stored is changed in the environment parameter configuration file or the argument when the log extraction command of SAP system is executed, the changed directory must also be collected.
/opt/jp1pc/agtm directory

If sensitive information such as passwords is included, delete the corresponding definition from the definition file after collection.

To Page Top

Format

For Windows

jima_log.bat -f data-storage-folder
          [-l logical-host-environment-shared-folder]
          [-q]

For Linux

jima_log.sh -f data-storage-directory
          [-l logical-host-environment-shared-directory]
          [-q]

To Page Top

Execution authority

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In Linux: Superuser permissions

To Page Top

Storage destination directory

For Windows: Agent-path\tools\
For Linux: /opt/jp1ima/tools/

To Page Top

Argument

-f data-storage-directory

For Windows

Specifies the name of the folder to which the collected data is to be output, expressed as a full path or a path relative to the location where the command is executed. If the path contains a space, enclose the entire path in double-quotation marks ("). This option is mandatory.

A folder with the name "jp1_default" is created under the specified folder, and the collected materials are stored. If necessary, compress the collected data with a compression tool.
If jp1_default folder already exists under the specified folder, ask whether to re-create the folder. When you re-create the folder, jp1_default folder is deleted and then the folder is created. If you do not re-create it, the operation is aborted.
If you specify a folder that does not exist, a new folder is created with that name.
You cannot specify a path under JP1/IM - Agent installation folder, or under the shared-folder of the logical host environment.

For Linux

Specify the name of the directory to output the collected data in full path. This option is mandatory.

A compressed file of the collected material is created under the name "jima_log.tar.gz" in the specified directory.
If a "jima_log.tar.gz" or "jima_log.tar" file already exists in the specified directory, ask whether to overwrite it. If you overwrite, the file is overwritten. If you do not overwrite it, the operation is aborted.
If you specify a directory that does not exist, a new directory is created with that name.
You cannot specify a device name.
You cannot specify a path under JP1/IM - Agent installation directory, or under the shared-directory of the logical host environment.
If the specified directory is one of the following, an error occurs.

- Have no write permission

- Fail to create a directory

- A file with the same name as the specified directory exists

-l logical-host-environment-shared-directory

Specify the full path shared directory of the logical host environment to be collected when executing on the active host of the cluster system. Do not specify this option if executing on the standby host or not using a cluster system. When this option is specified, both the physical host documentation and integrated agent documentation in shared-directory for the specified logical host environment are collected. If you omit this option, integrated agent data in shared-directory for the specified logical host environment is not collected.

If a directory that does not exist is specified, an error results.

If the acquisition of the logical host name fails, some information is not collected.

-q

Specifies that the command is to be executed without user confirmation. For details about the user verification items to be omitted, refer to the explanation of "-f data-storage-directory".

To Page Top

Notes

Do not run this tool at the same time. Documents may be overwritten or may not be collected.
There is a certain amount of overload (e.g., disc I/O) when running a tool to collect data. In addition, if a large number of Windows events are displayed, it may take longer to execute the command depending on the conditions.
If you send the documentation to Support Services without using this tool, or if you exclude the documentation and send it, you may not be able to perform an accurate survey.

To Page Top

Return value

`0`	Normal completion
`8`	Abnormal termination

To Page Top

Log Output

The log output destination is shown below.

For Windows: Log file "jima_log_result.log" to be stored in the folder specified in the data-storage-directory
For Linux: Log file "jima_log_result.log" included in the compressed file "jima_log.tar.gz" stored in the directory specified in the data-storage-directory

To Page Top

Examples of use

For Windows

jima_log.bat -f C:\tmp\jima

For Linux

jima_log.sh -f /tmp/jima -l /shdisk1/imagent -q

To Page Top