OpenTP1 Version 7 System Definition

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

8.2 Examples of defining the real-time statistics items that are to be acquired

The objects for which statistics are to be acquired by the real-time statistics service and which statistical items are to be acquired can be changed by specifying the rtsput definition command.

This section shows an example of the real-time statistics service definition and the information acquired by using that definition. The section also shows how the acquired information varies depending on the specification of the rts_service_max operand (maximum number of acquisition targets) and the rts_item_max operand (maximum number of statistical items that can be acquired).

Organization of this section
(1) Example of the real-time statistics service definition
(2) How the acquired information varies depending on operand values

(1) Example of the real-time statistics service definition

#############################################################
# Real-time statistics service definition
# File name: rts
#
#############################################################
 
set rts_service_max = 7
set rts_item_max   = 6
 
rtsput -u sys -f File1                                 #1
rtsput -u srv -s supA -e item-4,item-5 -f File1          #2
rtsput -u srv -s sppA -f File1                         #3
rtsput -u svc -s sppA -v update -e item-4,item-5,item-6   #4
rtsput -u svc -s sppB -v refer -e item-4,item-5          #5
rtsput -u obj -o port-number -b IP-address -e item-6      #6
 
### End of Real-time statistics service definition ################
 
#############################################################
# Real-time acquisition item definition
# File name: File1
#
#############################################################
 
set item-1 = Y
set item-2 = Y
set item-3 = Y
 
### End of real-time acquisition item definition ########################
 
#############################################################
# User service definition 1
# File name: supA
#
#############################################################
 
set module = "supA"
set receive_from = none
 
###  End of user service definition 1########################
 
#############################################################
# User service definition 2
# File name: sppA
#
#############################################################
 
set service_group = "sppA_svg"
set module = "sppA"
set service = "refer=refer","update=update"
 
###  End of user service definition 2########################
 
#############################################################
# User service definition 3
# File name: sppB
#
#############################################################
 
set service_group = "sppB_svg"
set module = "sppB"
set service = "refer=refer","update=update"
 
###  End of user service definition 3########################

As shown above, when you specify the rtsput definition command, the value of the rts_service_max operand must be 7 or more and the value of the rts_item_max operand must be 6 or more.

The following table shows the targets for which statistics are to be acquired and the statistical items acquired when the real-time statistics service is started for the above definition example.

Table 8-1 Items that can be acquired in the definition example

No. Acquisition target Items acquired
1 _SYSTEM [Figure] item-1 item-2 item-3 -- -- --
2 supA [Figure] item-1 item-2 item-3 item-4 item-5 --
3 sppA [Figure] item-1 item-2 item-3 -- -- --
4 sppA **** item-1 item-2 item-3 -- -- --
5 sppA refer item-1 item-2 item-3 -- -- --
6 sppA update item-1 item-2 item-3 item-4 item-5 item-6
7 sppB refer item-4 item-5 -- -- -- --
8 Port number IP address item-6 -- -- -- -- --

Legend:
[Figure]: Real-time statistics acquired on a server basis
****: Real-time statistics acquired on a basis other than service
--: Not applicable

#1:
Regardless of the value specified in the rts_service_max operand, as shown in No. 1 in Table 8-1, overall system statistics are registered as acquisition targets.

#2:
When srv is specified in the -u option and the service operand is not specified in the user service definition, as shown in No. 2 in Table 8-1, overall system statistics are registered as acquisition targets.

#3:
When srv is specified in the -u option and the service operand is specified in the user service definition, statistics are registered as acquisition targets as shown in Nos. 3 to 6 in Table 8-1. That is, the statistics on a server basis and the statistics on any basis other than service are registered as acquisition targets. In addition, the service specified in the service operand is registered as a target for statistics acquisition.

#4:
If the rtsput definition command is used to define items that have already been registered as acquisition targets, duplication of defined items is eliminated, as shown in No. 6 in Table 8-1.

#5:
The combination of the server name specified in the -s option and the service name specified in the -v option is registered as a single acquisition target, as shown in No. 7 in Table 8-1.

#6:
The combination of the values specified as arguments of the -o and -b options is registered as a single acquisition item, as shown in No. 8 in Table 8-1.

(2) How the acquired information varies depending on operand values

At most, the real-time statistics service can acquire statistics from one more target than the value of the rts_service_max operand (maximum number of services for which statistics can be acquired). For each target, a maximum of the number of items specified in the rts_item_max operand (maximum number of items that can be acquired) can be acquired.

If the number of targets or items specified by using the rtsput definition command exceeds the value of the rts_service_max or rts_item_max operand, the real-time statistics service registers as many targets or items as possible, and acquires statistics for them.

The following shows an example of the definition when more acquisition targets and items than the values specified in the rts_service_max and rts_item_max operands are specified in the rtsput definition command.

 
#############################################################
# Real-time statistics service definition
# File name: rts
#
#############################################################
 
set rts_service_max = 6
set rts_item_max   = 5
 
rtsput -u sys -f File1                                 #1
rtsput -u srv -s supA -e item-4,item-5 -f File1          #2
rtsput -u srv -s sppA -f File1                         #3
rtsput -u svc -s sppA -v update -e item-4,item-5,item-6   #4
rtsput -u svc -s sppB -v refer -e item-4,item-5          #5
rtsput -u obj -o port-number -b IP-address -e item-6      #6
 
### End of Real-time statistics service definition ################
 
#############################################################
# Real-time acquisition item definition
# File name: File1
#
#############################################################
 
set item-1 = Y
set item-2 = Y
set item-3 = Y
 
### End of real-time acquisition item definition ############
 
#############################################################
# User service definition 1
# File name: supA
#
#############################################################
 
set module = "supA"
set receive_from = none
 
###  End of user service definition 1#############################
 
#############################################################
# User service definition 2
# File name: sppA
#
#############################################################
 
set service_group = "sppA_svg"
set module = "sppA"
set service = "refer=refer","update=update"
 
###  End of user service definition 2########################
 
#############################################################
# User service definition 3
# File name: sppB
#
#############################################################
 
set service_group = "sppB_svg"
set module = "sppB"
set service = "refer=refer","update=update"
 
###  End of user service definition 3########################

Although rts_service_max was 7 and rts_item_max was 6 in the definition example shown in (1), rts_service_max is 6 and rts_item_max is 5 in the above definition example. As a result of the change in specified values, the acquisition targets and items change from those in (1) as shown in the following table.

Table 8-2 Acquisition targets and items that are valid when more targets and items than the maximum are specified

No. Acquisition target Items acquired
1 _SYSTEM [Figure] item-1 item-2 item-3 -- --
2 supA [Figure] item-1 item-2 item-3 item-4 item-5
3 sppA [Figure] item-1 item-2 item-3 -- --
4 sppA **** item-1 item-2 item-3 -- --
5 sppA refer item-1 item-2 item-3 -- --
6 sppA update item-1 item-2 item-3 item-4 item-5
7 sppB refer item-5 item-6 -- -- --

Legend:
[Figure]: Real-time statistics acquired on a server basis
****: Real-time statistics acquired on a basis other than service
--: Not applicable

#1:
Regardless of the value specified in the rts_service_max operand, as shown in No. 1 in Table 8-2, overall system statistics are registered as acquisition targets.

#2:
When srv is specified in the -u option and the service operand is not specified in the user service definition, as shown in No. 2 in Table 8-2, overall system statistics are registered as acquisition targets.

#3:
When srv is specified in the -u option and the service operand is specified in the user service definition, statistics are registered as acquisition targets as shown in Nos. 3 to 6 in Table 8-2. That is, the statistics on a server basis and the statistics on any basis other than service are registered as acquisition targets. In addition, the service specified in the service operand is registered as a target for statistics acquisition.

#4:
When two of the three acquisition items specified in the -e option are registered, the total number of registered acquisition items reaches the maximum. Accordingly, item-6 is not registered, as shown in No. 6 in Table 8-2.

#5:
The combination of the server name specified in the -s option and the service name specified in the -v option is registered as a single acquisition target, as shown in No. 7 in Table 8-2.

#6:
Registration is not performed because the number of registered acquisition items other than those in No. 1 in Table 8-2 has already reached the value of the rts_service_max operand.