Log-file trap startup definition file
- Organization of this page
Format
START_OPT=[<startup-LANG>]monitored-name:jevlogstart-command-options : START_OPT_CLS=[(cluster-ID)][<startup-LANG>]monitored-name:jevlogstart-command-options : |
File name
jevlog_start.conf
Storage destination directory
- In Windows:
-
installation-folder\conf\event\
- In UNIX:
-
/etc/opt/jp1base/conf/event/
Description
A log-file trap startup definition file specifies the log file traps to be started and stopped when any of the following occurs:
-
The log-file trap management service (daemon) is started
-
The jevlogstart command is executed (in a cluster environment)
-
The jevlogstop command is executed (in a cluster environment)
A log-file trap startup definition file is not provided by default. Users can create the file, or the file can be created as definition information (part of a profile) by IM configuration management.
For each log file trap started by a log-file trap startup definition file, a startup record (KAVA3661-I) and startup results (KAVA3662-I) are output to the log-file trap startup execution results log. If a parameter is specified incorrectly, a warning message is output and the parameter is ignored.
Log-file trap startup execution results log data is output to the following files:
- In Windows:
-
installation-folder\log\jevlog_start\jevlog_start{1|2|3}.log
- In UNIX:
-
/var/opt/jp1base/log/jevlog_start/jevlog_start{1|2|3}.log
Application of settings
The settings are applied when:
-
The log-file trap management service (daemon) starts
-
The jevlogstart command (cluster environment only) is executed.
When you execute the jevlogstop command (cluster environment only), the log-file trap management service (daemon) stops the log file traps based on the contents of the log-file trap startup definition file read by the jevlogstart command.
Definition details
The following conventions apply to the contents of the log-file trap startup definition file (jevlog_start.conf):
-
A hash mark (#) (code 0x23) at the start of a line indicates a comment.
-
Define one parameter per line.
-
Start writing from column 1.
-
Link parameters and their values with equal signs. You can enter spaces between the parameter and equal sign, but not between the equal sign and the value.
-
You cannot write a comment between a value (or the last of multiple values) and the subsequent linefeed character. Spaces are allowed.
- START_OPT=[<startup-LANG>]monitored-name:jevlogstart-command-options
-
Specify the log file traps to start when the log-file trap management service (daemon) starts, and the startup options for each log file trap.
You can specify this parameter and the START_OPT_CLS parameter a maximum of 200 times in total. If the START_OPT parameter and the START_OPT_CLS parameter appear more than 200 times in total, the 201st and subsequent occurrences are ignored.
The log-file trap management service (daemon) does not start or stop the log file traps specified in this parameter when you execute the jevlogstart (cluster environment only) or jevlogstop (cluster environment only) command.
- START_OPT_CLS=[(cluster-ID)][<startup-LANG>]monitored-name:jevlogstart-command-options
-
Specify the log file traps to start when you execute the jevlogstart (cluster system only) command and stop when you execute the jevlogstop (cluster system only) command, and the startup options for the log file traps. Specify this parameter to collectively start and stop log file traps in the event of a failover in an environment where log files are being monitored on a shared disk in a cluster environment.
You can specify this parameter and the START_OPT parameter a maximum of 200 times in total. If the START_OPT parameter and the START_OPT_CLS parameter appear more than 200 times in total, the 201st and subsequent occurrences are ignored.
The log-file trap management service (daemon) does not start or stop the log file traps specified in this parameter when it starts.
- <startup-LANG>
-
In UNIX, specify the value of the LANG environment variable at execution of the jevlogstart command in angle brackets (< >). For details on the values you can specify, see Table 3-3 Values specifiable in the LANG environment variable in 3.4.1 Setting the language (UNIX only).
If you omit this parameter, the value of LANG when the log file trap management daemon started is assumed.
In Windows, this parameter has no effect and will be ignored.
- monitored-name
-
Specify the monitor name of the log file trap. The character string preceding the colon (:) is interpreted as the monitor name.
Monitor names must be no more than 30 bytes long, and can contain alphanumeric characters, hyphens, and underscores. Names must start with an alphanumeric character, and are case sensitive.
Do not specify the same monitor name more than once.
- jevlogstart-command-options
-
Specify the options of the jevlogstart command. When the log-file management service (daemon) starts or the jevlogstart (cluster system only) command is executed, the system generates a jevlogstart command line from the contents of this parameter and monitored-name, and uses it to start the log file trap.
For details on the options you can specify, see jevlogstart in 15. Commands.
When JP1/Base is linked with IM configuration management, make sure that you specify the name of an action definition file for log file trapping (-f option) for jevlogstart-command-options.
The monitoring target of the log file trap will be the value specified in monitored-name of the START_OPT or START_OPT_CLS parameter, so the -a option is ignored if specified.
If you specify the -cluster option for the jevlogstart (cluster system only) command, the parameter is invalid and the definition is ignored.
The current directory of the jevlogstart command is as follows:
- In Windows:
-
installation-folder\COMMAND
- In UNIXL
-
/opt/jp1base/command
If you specify a relative path in a command option, it is interpreted relative to this location.
- (cluster-ID)
-
Specify the cluster ID in parentheses. The cluster ID is an ID number that identifies a cluster system. In an environment with multiple cluster systems, users can assign any number they choose in the range from 0 to 99.
As the cluster ID, specify a decimal value in the range from 0 to 99. The default is 0.
Defining log file trapping in an environment with multiple cluster systems
In environments with multiple cluster systems, choose a cluster ID for each logical host, and define the log file traps to be started and stopped on each of these hosts when a failover occurs.
The following figure shows how to configure log file trapping in an environment with multiple cluster systems.
|
In this example, the cluster ID of logical host 1 is 0. The log data output by logical host 1 is monitored by log file trap A and log file trap B. Thus, in the log-file trap startup definition file, define startup options for log file traps A and B for cluster ID 0.
Similarly, define startup options for log file traps C and D as the log file traps for cluster ID 1.
In the cluster software, register the following commands for execution at failover of logical host 1 and logical host 2:
- At failover of logical host 1:
-
-
jevlogstart -cluster 0
-
jevlogstop -cluster 0
-
- At failover of logical host 2:
-
-
jevlogstart -cluster 1
-
jevlogstop -cluster 1
-
With these commands registered in this manner, the system starts and ends log file traps A and B when logical host 1 fails over, and starts and ends log file traps C and D when logical host 2 fails over.
For details on the commands you can register with the cluster software, see jevlogstart (cluster environment only) and jevlogstop (cluster environment only) in 15. Commands.
Definition examples
#Specify log file traps to start when service (daemon) starts. START_OPT=<ja_JP.eucJP>KANSI1:-f /etc/~/jevlog.conf /fil/aaa.log : #Specify log file traps to start when jevlogstart -cluster [cluster-ID] is issued. #Specify log file traps to stop when jevlogstop -cluster [cluster-ID] is issued. START_OPT_CLS=(1)<ja_JP.eucJP>KANSI2:-f /etc/~/jevlog.conf /share/aaa.log :