3.4.9 Estimating the size of job execution result log files and event job execution result log files
This section describes how to estimate the sizes of job execution result log files and event job execution result log files. This section also describes the environment setting parameters that are required to change the sizes.
- Organization of this subsection
(1) How to estimate the size of job execution result log files
Job execution result log files allow you to check the job execution status on the agent host in cases where the status of a job running on the manager host becomes unknown (because of a communication error, for example).
If approximately 30,000 jobs are run per day, the job execution result log files of the default size can hold approximately seven days' worth of messages.
Therefore, you do not need to estimate the size of job execution result log files if fewer than 30,000 jobs are to be run per day. This also applies if the job execution result log files are collected shortly after a failure occurs on the manager host. In these cases, you do not need to change the default size.
If more than 30,000 jobs are to be run, or if job execution result log files are collected at long intervals, we recommend that you estimate the size of job execution result log files.
The following shows the formula for estimating the size of job execution result log files:
Appropriate-job-execution-result-log-file-capacity (units: bytes) = 900# x number-of-jobs-run-per-day x number-of-days-to-save
#: Number of messages that are output per job
- Example:
-
If 100,000 jobs are run per day and log data needs to be saved for 10 days, the required file size is as follows:
900 x 100,000 x 10 = 900,000,000 byte (878,906 kilobytes)
When determining the size of job execution result log files, you also need to consider how many files are to be retained. Then define the values you have estimated using the jajs_config command.
Run the following command to configure the environment setting parameters that are described in (2) Environment setting parameters for the job execution result log file, and then restart JP1/AJS3:
jajs_config -k definition-key-name "environment-setting-parameter-name"=definition-contents["environment-setting-parameter-name-2"=definition-contents-2]
(2) Environment setting parameters for the job execution result log file
The following table lists the environment setting parameters for the job execution result log file.
|
No. |
Definition key |
Environment setting parameter |
Definition |
Target OS |
Target software products |
|---|---|---|---|---|---|
|
1 |
[{JP1_DEFAULT|logical-host-name}\JP1NBQAGENT\Log]# |
"JOBEXECRESULTLOG"= |
Type of message data to be output to the job execution result log file |
Windows UNIX |
M, A, ME |
|
2 |
"JOBEXECRESULTLOGPATH"= |
Name of the directory used to store the job execution result log file |
Windows UNIX |
M, A, ME |
|
|
3 |
"JOBEXECRESULTLOGSIZE"= |
The size of the job execution result log file |
Windows UNIX |
M, A, ME |
|
|
4 |
"JOBEXECRESULTLOGCOUNT"= |
Number of the job execution result log files |
Windows UNIX |
M, A, ME |
- Legend:
-
M: JP1/AJS3 - Manager
A: JP1/AJS3 - Agent
ME: JP1/AJS3 - Agent Minimal Edition
- #
-
In the portion {JP1_DEFAULT|logical-host-name}, specify JP1_DEFAULT for the physical host, or logical-host-name for a logical host.
(a) JOBEXECRESULTLOG
For this parameter, specify the type of message data to be output to the job execution result log file.
- Format
-
"JOBEXECRESULTLOG"=dword:type-of-message-data-to-be-output-to-the-job-execution-result-log-file
- Specifiable values
-
- 0
-
Outputs no message to job execution result log files.
- 1
-
Outputs a message that contains the following items to job execution result log files:
-
Unit full name#
-
Execution ID#
-
Manager host name
-
Job Number
-
Process ID
-
Return code
-
End statuses
#: If the job that was run is a submit job, the value of the JP1JobName environment setting variable is output.
-
- 2
-
Outputs a message that contains the following items, in addition to the items that are output when 1 is specified, to job execution result log files:
-
Execution file names (Script file names)#
-
Command sentence (Only UNIX)
-
Parameters
-
JP1 user names
-
Run-time OS user
#: If the job that was run is an action job, HTTP connection job, or passing-information setting job, the job type is output.
-
- Default value
-
0
During a new installation of JP1/AJS3, 2 is set.
- Recommended value
-
2
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
(b) JOBEXECRESULTLOGPATH
For this parameter, specify the full path name of the directory that stores job execution result log files. This parameter takes effect if 1 or 2 is specified for the JOBEXECRESULTLOG environment setting parameter.
- Format
-
"JOBEXECRESULTLOGPATH"="name-of-the-directory-used-to-store-the-job-execution-result-log-file"
- Specifiable values
-
A character string of no more than 210 bytes
- Default value
-
- In Windows, if the installation folder is the default installation folder or is in a folder protected by the system:
-
-
For a physical host:
%ALLUSERSPROFILE%\Hitachi\JP1\JP1_DEFAULT\JP1AJS2\log
The default %ALLUSERSPROFILE% value is system-drive\ProgramData.
A folder protected by the system is the path to a folder in any of the following:
- system-drive\Windows
- system-drive\Program Files
- system-drive\Program Files (x86)
-
For a logical host:
shared-folder\jp1ajs2\log
-
- In Windows, if the installation folder is other than the above:
-
-
For a physical host:
JP1/AJS3-Manager-installation-folder\log
-
For a logical host:
shared-folder\jp1ajs2\log
-
- In UNIX:
-
-
For a physical host:
/var/opt/jp1ajs2/log
-
For a logical host:
shared-directory/jp1ajs2/log
-
- Recommended value
-
Defaults
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
- Cautionary note
-
The jobexecresult folder is created under the folder specified by using this environment setting parameter. Job execution result log files are stored in the jobexecresult folder.
If you want to change the path, size, or number of job execution result log files, you must delete the log files and their management file before changing the value of the relevant environment setting parameter. If you do not delete these files, the new value is not applied.
The following shows the procedure for changing the path, size, or number of job execution result log files:
-
Stop the JP1/AJS3 service on the target physical or logical host.
-
If necessary, back up the job execution result log files (ajsjobexecresult{1|2|3|...|n}.log).
For details about the folder that stores the job execution result log files, see the description of the JOBEXECRESULTLOGPATH environment setting parameter.
-
Delete all job execution result log files.
-
Delete the management file of the job execution result log files (ajsjobexecresult.mm).
The management file of the job execution result log files is stored in the mmap folder under the folder that stores the job execution result log files.
-
Change the value of the environment setting parameter.
-
Restart the JP1/AJS3 service that you stopped in step 1.
-
(c) JOBEXECRESULTLOGSIZE
For this parameter, specify the size of job execution result log files. This parameter takes effect if 1 or 2 is specified for the JOBEXECRESULTLOG environment setting parameter.
- Format
-
"JOBEXECRESULTLOGSIZE"=dword:size-of-the-job-execution-result-log-file
- Specifiable values
-
A hexadecimal value (in kilobytes) from 00000400 to 00004000 (1,024 to 16,384 in decimal)
- Default value
-
dword:00004000 (16,384 in decimal)
- Recommended value
-
Set the value appropriate for the operating environment.
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
- Cautionary note
-
If you want to change the path, size, or number of job execution result log files, you must delete the log files and their management file before changing the value of the relevant environment setting parameter. If you do not delete these files, the new value is not applied.
For details, see Cautionary note in (b) JOBEXECRESULTLOGPATH.
(d) JOBEXECRESULTLOGCOUNT
For this parameter, specify the number of job execution result log files. This parameter takes effect if 1 or 2 is specified for the JOBEXECRESULTLOG environment setting parameter.
- Format
-
"JOBEXECRESULTLOGCOUNT"=dword:number-of-the-job-execution-result-log-files
- Specifiable values
-
A hexadecimal value from 00000001 to 00000040 (1 to 64 in decimal)
- Default value
-
dword:0000000C (12 in decimal)
- Recommended value
-
Set the value appropriate for the operating environment.
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
- Cautionary note
-
If you want to change the path, size, or number of job execution result log files, you must delete the log files and their management file before changing the value of the relevant environment setting parameter. If you do not delete these files, the new value is not applied.
For details, see Cautionary note in (b) JOBEXECRESULTLOGPATH.
(3) How to estimate the size of event job execution result log files
Event job execution result log files allow you to check the event job and the custom event job execution status on the agent host in cases where the status of an event job and a custom event job running on the manager host becomes unknown (because of a communication error, for example).
If approximately 24,000 jobs are run per day, the event job execution result log files of the default size can hold approximately seven days' worth of messages.
Therefore, you do not need to estimate the size of event job execution result log files if fewer than 24,000 jobs are to be run per day. This also applies if the event job execution result log files are collected shortly after a failure occurs on the manager host. In these cases, you do not need to change the default size.
If more than 24,000 jobs are to be run, or if event job execution result log files are collected at long intervals, we recommend that you estimate the size of event job execution result log files.
The following shows the formula for estimating the size of event job execution result log files:
Appropriate-event-job-execution-result-log-file-capacity (units: bytes) = 400# x number-of-event-jobs-and-custom-event-jobs-run-per-day x number-of-days-to-save
#: Number of messages that are output per job
- Example:
-
If 24,000 event jobs and custom event jobs are run per day and log data needs to be saved for 10 days, the required file size is as follows:
400 x 24,000 x 10 = 96,000,000 byte (93,750 kilobytes)
When determining the size of event job execution result log files, you also need to consider how many files are to be retained. Then define the values you have estimated using the jajs_config command.
Run the following command to configure the environment setting parameters that are described in (4) Environment setting parameters for the event job execution result log file, and then restart JP1/AJS3:
jajs_config -k definition-key-name "environment-setting-parameter-name"=definition-contents["environment-setting-parameter-name-2"=definition-contents-2]
(4) Environment setting parameters for the event job execution result log file
The following table lists the environment setting parameters for the event job execution result log file.
|
No. |
Definition key |
Environment setting parameter |
Definition |
Target OS |
Target software products |
|---|---|---|---|---|---|
|
1 |
[{JP1_DEFAULT|logical-host-name}\JP1NBQAGENT\Log]# |
"EVJOBEXECRESULTLOG"= |
Type of message data to be output to the event job execution result log file |
Windows UNIX |
M, A, ME |
|
2 |
"EVJOBEXECRESULTLOGPATH"= |
Name of the directory used to store the event job execution result log file |
Windows UNIX |
M, A, ME |
|
|
3 |
"EVJOBEXECRESULTLOGSIZE"= |
The size of the event job execution result log file |
Windows UNIX |
M, A, ME |
|
|
4 |
"EVJOBEXECRESULTLOGCOUNT"= |
Number of the event job execution result log files |
Windows UNIX |
M, A, ME |
- Legend:
-
M: JP1/AJS3 - Manager
A: JP1/AJS3 - Agent
ME: JP1/AJS3 - Agent Minimal Edition
- #
-
In the portion {JP1_DEFAULT|logical-host-name}, specify JP1_DEFAULT for the physical host, or logical-host-name for a logical host.
(a) EVJOBEXECRESULTLOG
For this parameter, specify the type of message data to be output to the event job execution result log file.
- Format
-
"EVJOBEXECRESULTLOG"=dword:type-of-message-data-to-be-output-to-the-event-job-execution-result-log-file
- Specifiable values
-
- 0
-
Outputs no message to event job execution result log files.
- 1
-
Outputs a message that contains the following items to event job execution result log files:
-
Scheduler service name
-
Unit ID
-
Execution ID
-
Manager host name
-
Return code
-
End statuses
-
- 2
-
Outputs a message that contains the following items, in addition to the items that are output when 1 is specified, to event job execution result log files:
-
Job types
-
- Default value
-
0
During a new installation of JP1/AJS3, 2 is set.
- Recommended value
-
2
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
(b) EVJOBEXECRESULTLOGPATH
For this parameter, specify the full path name of the directory that stores event job execution result log files. This parameter takes effect if 1 or 2 is specified for the EVJOBEXECRESULTLOG environment setting parameter.
- Format
-
"EVJOBEXECRESULTLOGPATH"="name-of-the-directory-used-to-store-the-event-job-execution-result-log-file"
- Specifiable values
-
A character string of no more than 210 bytes
- Default value
-
- In Windows, if the installation folder is the default installation folder or is in a folder protected by the system:
-
-
For a physical host:
%ALLUSERSPROFILE%\Hitachi\JP1\JP1_DEFAULT\JP1AJS2\log
The default %ALLUSERSPROFILE% value is system-drive\ProgramData.
A folder protected by the system is the path to a folder in any of the following:
- system-drive\Windows
- system-drive\Program Files
- system-drive\Program Files (x86)
-
For a logical host:
shared-folder\jp1ajs2\log
-
- In Windows, if the installation folder is other than the above:
-
-
For a physical host:
JP1/AJS3-Manager-installation-folder\log
-
For a logical host:
shared-folder\jp1ajs2\log
-
- In UNIX:
-
-
For a physical host:
/var/opt/jp1ajs2/log
-
For a logical host:
shared-directory/jp1ajs2/log
-
- Recommended value
-
Defaults
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
- Cautionary note
-
The evjobexecresult folder is created under the folder specified by using this environment setting parameter. Event job execution result log files are stored in the evjobexecresult folder.
If you want to change the path, size, or number of event job execution result log files, you must delete the log files and their management file before changing the value of the relevant environment setting parameter. If you do not delete these files, the new value is not applied.
The following shows the procedure for changing the path, size, or number of event job execution result log files:
-
Stop the JP1/AJS3 service on the target physical or logical host.
-
If necessary, back up the event job execution result log files (ajsevjobexecresult{1|2|3|...|n}.log).
For details about the folder that stores the event job execution result log files, see the description of the EVJOBEXECRESULTLOGPATH environment setting parameter.
-
Delete all event job execution result log files.
-
Delete the management file of the event job execution result log files (ajsevjobexecresult.mm).
The management file of the event job execution result log files is stored in the mmap folder under the folder that stores the event job execution result log files.
-
Change the value of the environment setting parameter.
-
Restart the JP1/AJS3 service that you stopped in step 1.
-
(c) EVJOBEXECRESULTLOGSIZE
For this parameter, specify the size of event job execution result log files. This parameter takes effect if 1 or 2 is specified for the EVJOBEXECRESULTLOG environment setting parameter.
- Format
-
"EVJOBEXECRESULTLOGSIZE"=dword:size-of-the-event-job-execution-result-log-file
- Specifiable values
-
A hexadecimal value (in kilobytes) from 00000400 to 00004000 (1,024 to 16,384 in decimal)
- Default value
-
dword:00004000 (16,384 in decimal)
- Recommended value
-
Set the value appropriate for the operating environment.
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
- Cautionary note
-
If you want to change the path, size, or number of event job execution result log files, you must delete the log files and their management file before changing the value of the relevant environment setting parameter. If you do not delete these files, the new value is not applied.
For details, see Cautionary note in (b) EVJOBEXECRESULTLOGPATH.
(d) EVJOBEXECRESULTLOGCOUNT
For this parameter, specify the number of event job execution result log files. This parameter takes effect if 1 or 2 is specified for the EVJOBEXECRESULTLOG environment setting parameter.
- Format
-
"JOBEXECRESULTLOGCOUNT"=dword:number-of-the-event-job-execution-result-log-files
- Specifiable values
-
A hexadecimal value from 00000001 to 00000040 (1 to 64 in decimal)
- Default value
-
dword:00000004 (4 in decimal)
- Recommended value
-
Set the value appropriate for the operating environment.
- When the setting takes effect
-
The next time the JP1/AJS3 service starts
- Cautionary note
-
If you want to change the path, size, or number of event job execution result log files, you must delete the log files and their management file before changing the value of the relevant environment setting parameter. If you do not delete these files, the new value is not applied.
For details, see Cautionary note in (b) EVJOBEXECRESULTLOGPATH.