[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-for-defining-the-items-for-which-real-time-statistics- are-to-be-acquired]]

The real-time statistics service definition specifies the targets for which the real-time statistics service acquires statistics, and the statistics items to be acquired.

-u {sys|srv|svc|obj}

Specify the type of real-time statistics to be acquired.

sys

The statistics for the entire system are acquired.

When sys is specified, the value of the rts_service_max operand in the real-time statistics service definition is not reduced.

srv

The statistics for the specified server are acquired.

When a user server name is specified in the -s option, the following statistics are acquired:

• Statistics for the entire server
• Statistics for all services specified in the service operand of the user service definition for the specified user server
• Statistics for processing that is not related to services

That is, statistics are acquired from two more targets than the number of services specified in the service operand.

If the specified server is a server that does not have any services, such as a system server or SUP, only the statistics for the entire server are acquired.

svc

Statistics for each service of the specified user server are acquired.

obj

The object for which statistics are to be acquired is specified using the combination of the -o and -b options. For details, see the explanation of the -o and -b options.

-s server-name~<1-8 alphanumeric characters beginning with an alphabetic character>

Specify the name of the server for which you want to acquire statistics.

When srv or svc is specified in the -u option, always specify the -s option. When sys or obj is specified in the -u option, the -s option cannot be specified.

-v service-name~<1-to-31-character identifier>

Specify the name of the service for which you want to acquire statistics.

The statistics for the specified service on the server specified in the -s option are acquired.

When svc is specified in the -u option, always specify the -v option. When sys, srv, or obj is specified in the -u option, the -v option cannot be specified.

-o acquisition-target-name-1 ~<1-8 characters>

-b acquisition-target-name-2 ~<1-63 characters>

When obj is specified in the -u option, the arguments specified in these options determine the object for which real-time statistics are to be acquired.

The following table shows the arguments of the -o and -b options, and the object determined from the specified arguments. When obj is specified in the -u option, specify arguments in the -o and -b options according to the table.

Table 3-8 Options in the rtsput definition command and the acquisition-target object that can be specified

Argument of the -o option	Argument of the -b option	Acquisition-target object that can be specified
Port number#	IP address#	Node for which the specified service information is referenced
Logical terminal name	Specification omitted	Specified logical terminal
Specification omitted	Service group name	Specified service group

#: Specify the port number and IP address of a node specified in the all_node operand of the system common definition or in the domain definition file.

When sys, srv, or svc is specified in the -u option, the -o or -b option cannot be specified.

-e item-ID~<unsigned integer>((1000-9999))

Specify the ID of the item for which you want to acquire statistics.

For details about item IDs, see the manual OpenTP1 Operation.

-f file-for-defining-the-items-for-which-real-time-statistics-are-to-be-acquired~<1-to-8-character identifier>

Specify the file for defining the real-time statistics items to be acquired.

• When srv is specified in the -u option and a user server name is specified in the -s option, the service names are acquired by parsing the user service definition file on the specified server. If you specify a user server name in the -s option, always prepare a corresponding user service definition file.
• The number of statistics acquisition targets that can be specified in the rtsput definition command cannot exceed the value specified in the rts_service_max operand of the real-time statistics service definition. The maximum number of events that can be acquired from one target is the value specified in the rts_item_max operand of the real-time statistics service definition.
• When the -f and -e options are omitted, an area for acquiring statistics is secured. However, the acquired information is only the information about the user server execution time for a particular section.
• 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 duplicated items removed. Table 3-9 shows examples of specifying the rtsput definition command and the file for defining the real-time statistics items to be acquired. Table 3-10 shows the items that the real-time statistics service will acquire when the command is specified as shown in Table 3-9.
  For details about examples of specifying the rtsput definition command, see 8.2 Examples of defining the real-time statistics items that are to be acquired.
  

  Table 3-9 Examples of specifying the rtsput definition command and the file for defining the real-time statistics items to be acquired

  rtsput definition command specification	Items to be acquired specified in the definition file
  rtsput -u srv -s SERVER_A -f definition-file-1	item-A, item-C
  rtsput -u svc -s SERVER_A -v SERVICE_B -f definition-file-2	item-B
  rtsput -u svc -s SERVER_A -v SERVICE_C -f definition-file-3	item-A, item-D

  Table 3-10 Items to be acquired by the real-time statistics service

  Server name	Service name	Item A	Item B	Item C	Item D
  SRVER_A	All services	Y	N	Y	N
  	Processing not related to services	Y	N	Y	N
  	SRVICE_A	Y	N	Y	N
  	SRVICE_B	Y	Y	Y	N
  	SRVICE_C	Y	N	Y	Y

  Legend:

  Y: Acquired

  N: Not acquired

• When svc is specified in the -u option, the command does not check whether the server specified in the -s option and the service specified in the -v option exist. When obj is specified in the -u option, whether the values specified in the -o and -b options are valid is not checked. If unnecessary acquisition targets have been registered, execute the rtsls command to check their configuration, and delete them by executing the rtsstats command with the -d option specified.
• Any additions or deletions of services made to the user service definition after the real-time statistics service has started are not reflected in the settings for the real-time statistics acquisition items. This also holds true even when srv is specified for the -u option in the rtsput definition command. To change the settings for the real-time statistics acquisition items after the real-time statistics service has started, use the rtsstats command or restart the real-time statistics service (RTSSUP).
  Furthermore, any additions or deletions of services made by dynamic loading of service functions are not reflected to the settings for the real-time statistics acquisition items. In this case as well, use the rtsstats command or restart the real-time statistics service (RTSSUP) to change the settings for the real-time statistics acquisition items after the real-time statistics service has started.