OpenTP1 Version 7 System Definition

[Contents][Index][Back][Next]

Real-time statistics service definition

Format

set format

[set rts_trcput_interval=statistics-acquisition-interval]
[set rts_service_max=maximum-number-of-acquisition-target-services]
[set rts_item_max=maximum-number-of-acquisition-target-items]
[set rts_log_file=Y|N]
[set rts_log_file_name=RTS-log-file-name]
[set rts_log_file_size=RTS-log-file-size]
[set rts_log_file_count=number-of-RTS-log-files]
[set rts_log_file_backup=Y|N]
[set rts_swap_message=Y|N]

command format

[rtsput  -u{sys|srv|svc|obj}
        [-s server-name][-v service-name]
        [-o acquisition-target-name-1][-b acquisition-target-name-2]
        [-e item-ID[,item-ID]...]
        [-f file-name-of-the-real-time-statistics-acquisition-target-definition]]

Function

The real-time statistics service definition defines the execution environment in which the real-time statistics service acquires statistics.

Explanation

set format

rts_trcput_interval=statistics-acquisition-interval~<unsigned integer> ((10-86400)) <<600>> (units: seconds)

Specify in seconds the interval for acquiring and editing real-time statistics.

rts_service_max=maximum-number-of-acquisition-target-services~<unsigned integer> ((1-1000))<<64>>

Specify the maximum number of services for which statistics are to be acquired by the real-time statistics service.

rts_item_max=maximum-number-of-acquisition-target-items~<unsigned integer> ((1-1000))<<64>>

Specify the maximum number of events that the real-time statistics service can acquire from one target.

rts_log_file=Y|N~<<Y>>

Specify whether to output the statistics acquired in the shared memory for the RTS service to the RTS log file.

Y
The acquired statistics are output to the RTS log file.

N
The acquired statistics are not output to the RTS log file.

rts_log_file_name=RTS-log-file-name~<1-to-63-character path name> <<$DCDIR/spool/dcrtsinf/rtslog>>

Specify the absolute path name of the RTS log file to which statistics are to be output.

If the RTS log file specified in this operand already exists, the existing file is overwritten.

Do not create a file or directory that has the same name as the name of the RTS log file in the RTS log file destination directory. If you create such a file or directory, the system may operate incorrectly.

If you specify a user other than the OpenTP1 system administrator in the uid operand of the user service default definition, in the rts_log_file_name operand, specify a path that provides the specified user with the write authority.

The real-time statistics service always operates correctly as long as the user has the write authority for the directory that will contain the RTS log file, regardless of the user ID with which the service was started. If the user does not have the write authority, the service outputs the KFCA32734-W message and stops outputting log information to the RTS log file. Note that the uid and groups operands are not specified in the definition files created using the rtssetup command (RTSSUP and RTSSPP). For this reason, if these operands have been specified in the user service default definition, the real-time statistics service is started as the specified user and group.

rts_log_file_size=RTS-log-file-size~<unsigned integer> ((1024-1048576)) <<1024>> (units: kilobytes)

Specify the size of each RTS log file that contains statistics.

The maximum number of RTS log files is specified in the rts_log_file_count operand. That is, the disk must have at least as much space as the value calculated by multiplying the rts_log_file_size value by the rts_log_file_count value. If all RTS log files are full, the oldest file is overwritten with the new statistics. This means that statistics that are collected at a point of time will be lost after a certain period of time. By increasing the rts_log_file_size value, you can retain the collected trace information for a longer period.

Note that the value of the rts_log_file_size operand must be larger than the amount of real-time statistics output at one time. This amount can be calculated using the following formula:

Amount of real-time statistics output at one time

= (96 + (40 x rts_item_max value)) x number of real-time statistics acquisition targets#

#
The number of real-time statistics acquisition targets is the value specified in the rtsput definition command of the real-time statistics service definition.
However, when srv is specified in the -u option and a user server is specified as an argument of the -s option, the number of real-time statistics acquisition targets is the number of services specified in the service operand + 2. If you use the rtsstats command to change the number of acquisition targets, also take this increment into account.
More than one rtsput definition command can be specified for the same service or server. If multiple rtsput definition commands are specified for the same service or server, the real-time statistics service acquires the items that are specified in the separate commands and merges them with the duplicated items removed.
The statistics on the entire system are not included in the number of real-time statistics acquisition targets for reasons having to do with the operation of real-time statistics. However, the statistics on output of the RTS log files must be included in the number of acquisition targets. Therefore, when statistics on the entire system are being acquired, add 1 to the number of real-time statistics acquisition targets in the above formula.

rts_log_file_count=number-of-RTS-log-files~<unsigned integer> ((1-10)) <<3>>

Specify the maximum number of RTS log files for storing statistics.

rts_log_file_backup=Y|N ~<<Y>>

Specify whether to back up RTS log files when the real-time statistics service starts.

Y
RTS log files are backed up.
Backup files are given the same names as the RTS log files and suffixed with the extension .bk. The backup files are created in the RTS log file directory.

N
RTS log files are not backed up.

When Y is specified, the maximum amount of disk space required for the RTS log file directory is as follows:

rts_log_file_size value x rts_log_file_count value x 2 (kilobytes)

Before you specify Y, make sure that there is enough disk space for the RTS log file directory.

Also make sure that the RTS log file directory does not contain a file or directory whose name a backup file would duplicate. If such a file exists, it will be replaced by the backup file. If there is a directory whose name a backup file would duplicate, the backup file cannot be created.

rts_swap_message=Y|N~<<N>>

Specify whether to output the KFCA32740-I message when the current RTS log file used for output of the real-time statistics is swapped.

Y
The swap message for the RTS log file is output.

N
The swap message for the RTS log file is not output.

Cautions

command format

See the next page.