6.4.5 Format of user-created data files

This subsection describes the format of user-created data files. For user commands collecting performance data, output text according to this format.

Information output to a user-created data file consists of a product information section and a data section. Both of these sections must be present in each user-created data file. The following figure gives an example configuration of user-created data.

Figure 6-4 Example configuration of user-created data

[Figure]

Organization of this subsection
(1) Product information section
(2) Data section
(3) Notes

(1) Product information section

The product information section contains the constants that indicate the product name and the version of the user-created data file. The information set in this section is used only by internal functions and is not stored in records.

The following is an example of information set in this section:

Product Name=PFM-Agent for Platform (UNIX)
FormVer=0001

Note:
In the above specification method, an error will occur if there is a space before or after the equal sign (=). Note that the specified characters are case sensitive.

(2) Data section

This section sets performance data information. This information is specified below the product information section. The data section consists of the option header and a data part.

Option header

The first line is the option header line, which contains the specified field options. Each option must be separated by using one or more space characters or tabs. The field options correspond to user record fields.

tt ks ki l ...

The following table lists option names and corresponding record field names. Each of the columns for number of fields indicates the maximum number of options that can be specified. For example, if ss is specified multiple times for the field option in a PI_UPI record, note that the PI_UPI column (No. 10) indicates 4. Accordingly, you can specify ss a maximum of four times, such as ss ss ss ss, for the PI_UPI record.

Table 6-27 Options that can be specified in the data section and the corresponding fields

No.Option nameField nameValue explanationNumber of fields (total)
PD_UPD (17)PD_UPDB (34)PI_UPI (23)PI_UPIB (49)
1ttTrans TypeTransaction type. This option is a required item.#1
Size: 1 to 19 bytes
1111
2kiTrans Data KeyNumeric-type transaction key. Either ki or ks, or both, must be specified.
Type: ulong
Specifiable characters: Numeric values and a plus sign (+)
1111
3ksTrans String KeyString-type transaction key. Either ki or ks, or both, must be specified.#1
Size: 1 to 19 bytes
1111
4fUser FloatFloating point number.#2
Type: double
2525
5fr#3User Float RollFloating point number for a cumulative value#2
Type: double
----25
6lUser LongSigned long data.
Type: long
Specifiable characters: Numeric values and signs (+, -)
2525
7lr#3User Long RollSigned long data for a cumulative value.
Type: long
Specifiable characters: Numeric values and signs (+, -)
----25
8slUser String(64)Long string.#1
Size: 1 to 63 bytes + NULL
1515
9smUser String(32)Medium string.#1
Size: 1 to 31 bytes + NULL
2525
10ssUser String(16)Short string.#1
Size: 1 to 15 bytes + NULL
4545
11tUser TimeTime data (time_t type) in the following format:
YYYY/MM/DD,hh:mm:ss
The time must be the local time of the machine on which the jpcuser command is executed.
1111
12uUser Unsigned LongUnsigned long data.
Type: ulong
Specifiable characters: Numeric values and a plus sign (+)
2525
13ur#3User Unsigned Long RollUnsigned long data for a cumulative value.
Type: ulong
Specifiable characters: Numeric values and a plus sign (+)
----25
Legend:
--: Not specifiable.
#1
The characters that can be specified are uppercase and lowercase alphabetic characters, numeric characters, space characters, and the following symbols:
` ~ ! @ # $ % ^ & * ( ) _ + - = { } : ; < > , . ? / | \ [ ]
#2
The characters that can be specified are numeric values and the following symbols:
- + .
#3
When history data collected by specifying the fr, lr, or ur option is displayed in consolidation mode, the cumulative value is displayed. When a numeric-value option other than these options or the ki option is specified, the average value is displayed.

Note that if multiple field options are specified for user-created data, they are allocated sequentially to the target field of the user record.

For example, if lr is specified 3 times for the field option of the PI_UPIB record, this is specified as lr lr lr. In this case, each lr is allocated to its field as follows:

If sl lr sl lr lr is specified, it is allocated to the following fields:

Data

The second and subsequent lines are for data. Data lines specify the performance data, corresponding to the field options specified in the optional header. Each column is separated by 1 or more bytes of spaces or tabs.

Make sure that the order of the data matches the field option type.

For example, if tt ks lr lr ss ss is specified for the field option, an error will occur for all lines for the following data order:

TCP jp1host "ESTABLISHD COUNT=" 5 "LISTENING COUNT=" 2
TCP jp1host "ESTABLISHD COUNT=" 3 "LISTENING COUNT=" 1
TCP jp1host "ESTABLISHD COUNT=" 3 "LISTENING COUNT=" 2

The reason this error occurs is because the field options for the third and sixth columns do not match the data types.

(3) Notes