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
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
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.
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 name | Field name | Value explanation | Number of fields (total) | |||
---|---|---|---|---|---|---|---|
PD_UPD (17) | PD_UPDB (34) | PI_UPI (23) | PI_UPIB (49) | ||||
1 | tt | Trans Type | Transaction type. This option is a required item.#1 Size: 1 to 19 bytes | 1 | 1 | 1 | 1 |
2 | ki | Trans Data Key | Numeric-type transaction key. Either ki or ks, or both, must be specified. Type: ulong Specifiable characters: Numeric values and a plus sign (+) | 1 | 1 | 1 | 1 |
3 | ks | Trans String Key | String-type transaction key. Either ki or ks, or both, must be specified.#1 Size: 1 to 19 bytes | 1 | 1 | 1 | 1 |
4 | f | User Float | Floating point number.#2 Type: double | 2 | 5 | 2 | 5 |
5 | fr#3 | User Float Roll | Floating point number for a cumulative value#2 Type: double | -- | -- | 2 | 5 |
6 | l | User Long | Signed long data. Type: long Specifiable characters: Numeric values and signs (+, -) | 2 | 5 | 2 | 5 |
7 | lr#3 | User Long Roll | Signed long data for a cumulative value. Type: long Specifiable characters: Numeric values and signs (+, -) | -- | -- | 2 | 5 |
8 | sl | User String(64) | Long string.#1 Size: 1 to 63 bytes + NULL | 1 | 5 | 1 | 5 |
9 | sm | User String(32) | Medium string.#1 Size: 1 to 31 bytes + NULL | 2 | 5 | 2 | 5 |
10 | ss | User String(16) | Short string.#1 Size: 1 to 15 bytes + NULL | 4 | 5 | 4 | 5 |
11 | t | User Time | Time 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. | 1 | 1 | 1 | 1 |
12 | u | User Unsigned Long | Unsigned long data. Type: ulong Specifiable characters: Numeric values and a plus sign (+) | 2 | 5 | 2 | 5 |
13 | ur#3 | User Unsigned Long Roll | Unsigned long data for a cumulative value. Type: ulong Specifiable characters: Numeric values and a plus sign (+) | -- | -- | 2 | 5 |
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:
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.