Hitachi

JP1 Version 12 for Windows Systems JP1/Performance Management - Agent Option for Platform Description, User's Guide and Reference


6.8.5 Checking the debug log to determine whether user-created data is correct

The debug log is used to check whether the user-created data is correct. If you want to output debug log information, specify the -debug 1 or -debug 2 option in the jpcuser command.

In the debug log, a check result code, such as OK (success), NG (failure), or WG (warning), is output for each data line in the user-created data. If NG or WG is output in the debug log, the user-created data might be invalid. If NG or WG has been output, check the user commands by which the user-created data was created, and make any necessary corrections for outputting the data in the correct format. For the correct format, see 6.8.4 Format of user-created data files.

The following shows the location and name of a debug log file:

installation-folder\agtt\agent\jpcuser\debug\jpcuser_dbg_{01|02|03|04|05}.log
environment-folder\jp1pc\agtt\agent\jpcuser\debug\jpcuser_dbg_{01|02|03|04|05}.log

The following describes the debug log file format.

Organization of this subsection

(1) Debug log file format

A debug log file consists of four sections:

A check result is output for each data line in the user-created data. A comma is used to separate items.

The following table explains the items that are output to a debug log file.

Table 6‒28: Items that are output to a debug log file

No.

Section

Item

Value

Explanation

1

Product information

Product name

Product Name=PFM-Agent for Platform (Windows)

The PFM - Agent product name.

2

Format version

FormVer=0001

The version of the user-created data format.

3

Execution time and process ID of the jpcuser command

Execution time

YYYY/MM/DD hh:mm:ss

YYYY: Year

MM: Month

DD: Day

hh: Hour

mm: Minute

ss: Second

4

Process ID

PID=xxxx

The process ID of the jpcuser command.

5

Header line

Header

Example (for the PD_UPD record):

LineNumber, Result, APITime, Recordtype, Transactiontype, t, ks, ki, L1, L2, UL1, UL2, F1, F2, SS1, SS2, SS3, SS4, SM1, SM2, SL1

The debug log header.

The header names correspond to the field options and field names specified on the option header line in a user-created data file. For the correspondence, see Table 5-28 Header line items in a debug log file and their corresponding field options and field names.

Note that the header items differ depending on the user-defined records that are to be stored.

6

Check result

User-created data file name

Example:

File=D:\Program Files (x86)\HITACHI\jp1pc\agtt\agent\jpcuser\UPIB_sample01.txt

The user-specified path name of a user-created data file that is read is output.

7

Error or warning message

KAVFxxxxx-x

If an error or other problem that the user should be made aware of occurs on a line in the user-created data, the applicable error and warning messages are output at the beginning of the line.

8

Line number

Numeric value

The number of a line in the user-created data.

9

Result code

OK

Success.

The line in the user-created data was free of problems and was converted successfully.

10

WG

Warning.

The line in the user-created data contained a problem but was converted nevertheless.

When WG is output, a warning message is also output.

11

NG

Failure.

The line in the user-created data contained a problem and was not converted.

When NG is output, a warning message or error message, depending on the cause of the problem, is also output. If a warning message is output, processing continues. If an error message is output, processing stops.

12

BL

Null line.

The line in the user-created data is empty and is ignored.

13

Data

Data

The contents of the line in the user-created data.

For an empty numeric field, 0 is output.

For an empty string field, two quotation marks ("") are output.

The following table lists the items output on the header line in a debug log file and their corresponding field options and field names specified on the option header line in a user-created data file.

Table 6‒29: Header line items in a debug log file and their corresponding field options and field names

No.

Item on the header line in a debug log file

Field option specified on the option header line in a user-created data file

Field name

(PFM - View name)

Explanation

1

Line Number

--

--

Number of the line on which the relevant data exists

2

Result

--

--

Check result of the relevant data

3

API Time

--

Collect Time

Time that the relevant data was converted

4

Record type

--

Record Type

Record type

5

Transaction type

tt

Trans Type

Transaction type

6

t

t

User Time 1

Time value

7

ks

ks

Trans String Key

String-type transaction key

8

ki

ki

Trans Data Key

Numeric-type transaction key

9

L1

l

User Long 1

Integer value of type long

10

L2

l

User Long 2

Integer value of type long

11

L3

l

User Long 3

Integer value of type long

12

L4

l

User Long 4

Integer value of type long

13

L5

l

User Long 5

Integer value of type long

14

L1R

lr

User Long Roll 1

Cumulative integer value of type long

15

L2R

lr

User Long Roll 2

Cumulative integer value of type long

16

L3R

lr

User Long Roll 3

Cumulative integer value of type long

17

L4R

lr

User Long Roll 4

Cumulative integer value of type long

18

L5R

lr

User Long Roll 5

Cumulative integer value of type long

19

UL1

u

User Unsigned Long 1

Integer value of type unsigned long

20

UL2

u

User Unsigned Long 2

Integer value of type unsigned long

21

UL3

u

User Unsigned Long 3

Integer value of type unsigned long

22

UL4

u

User Unsigned Long 4

Integer value of type unsigned long

23

UL5

u

User Unsigned Long 5

Integer value of type unsigned long

24

UL1R

ur

User Unsigned Long Roll 1

Cumulative integer value of type unsigned long

25

UL2R

ur

User Unsigned Long Roll 2

Cumulative integer value of type unsigned long

26

UL3R

ur

User Unsigned Long Roll 3

Cumulative integer value of type unsigned long

27

UL4R

ur

User Unsigned Long Roll 4

Cumulative integer value of type unsigned long

28

UL5R

ur

User Unsigned Long Roll 5

Cumulative integer value of type unsigned long

29

F1

f

User Float 1

Floating point number value

30

F2

f

User Float 2

Floating point number value

31

F3

f

User Float 3

Floating point number value

32

F4

f

User Float 4

Floating point number value

33

F5

f

User Float 5

Floating point number value

34

F01 to F30

f

User Float 01 to User Float 30

Floating point number value

35

F1R

fr

User Float Roll 1

Cumulative floating point number value

36

F2R

fr

User Float Roll 2

Cumulative floating point number value

37

F3R

fr

User Float Roll 3

Cumulative floating point number value

38

F4R

fr

User Float Roll 4

Cumulative floating point number value

39

F5R

fr

User Float Roll 5

Cumulative floating point number value

40

F01A to F30A

fr

User Float Add 01 to User Float Add 30

Cumulative floating point number value

41

SS1

ss

User String 1

16-byte character string

42

SS2

ss

User String 2

16-byte character string

43

SS3

ss

User String 3

16-byte character string

44

SS4

ss

User String 4

16-byte character string

45

SS5

ss

User String 5

16-byte character string

46

SM1

sm

User String 5 (for the PD_UPD or PI_UPI record)

User String 6 (for the PD_UPDB or PI_UPIB record)

32-byte character string

47

SM2

sm

User String 6 (for the PD_UPD or PI_UPI record)

User String 7 for the (PD_UPDB or PI_UPIB record)

32-byte character string

48

SM3

sm

User String 8

32-byte character string

49

SM4

sm

User String 9

32-byte character string

50

SM5

sm

User String 10

32-byte character string

51

SL1

sl

User String 7 (for the PD_UPD or PI_UPI record)

User String 11 (for the PD_UPDB or PI_UPIB record)

User String 1 (PI_XUI1 to PI_XUI5 records)

64-byte character string

52

SL2

sl

User String 12 (for the PD_UPDB or PI_UPIB record)

User String 2 (PI_XUI1 to PI_XUI5 records)

64-byte character string

53

SL3

sl

User String 13

64-byte character string

54

SL4

sl

User String 14

64-byte character string

55

SL5

sl

User String 15

64-byte character string

56

SV1

sv

User String 3

128-byte character string

Legend:

--: Not applicable

(2) Example of information output to a debug log file

The following figure shows an example of information output to a debug log file.

Figure 6‒8: Example of information output to a debug log file

[Figure]

The following explanations are keyed to the numbers in parentheses in the figure.

  1. This line is the header line.

  2. The user-specified path name of a user-created data file loaded into the command is output.

  3. Output of the check result for the user-created data file begins with this line. The number (4) at the beginning of the line indicates the number of the line in the user-created data file. In a user-created data file, the first line contains product information, the second line contains version information, and the third line is the option header line. Therefore, checking normally begins with line 4. If the line contains no problems, OK is output for Result.

  4. The user-specified path name of another user-created data file that is read is output.

  5. This line warns the user of a problem on line 4 in the UPIB_sample02.txt file. Because the t value (2007/02/24,10:10:010) did not have the expected format, n/a has been output for the element corresponding to t (see (7) in the figure).

  6. This line also warns the user of a problem on line 4 in the UPIB_sample02.txt file. Because the specified ss value (abcdefghijklmnop) exceeded the predefined maximum of 15 bytes, a warning message has been output. and a truncated value (abcdefghijklmno) has been output for the element corresponding to SS1 (see (7) in the figure).

  7. Because the warnings indicated by (5) and (6) have been issued, the check result code WG has been output for Result for line 4.

  8. The check result code BL indicates that the line is a null line.

  9. This line warns the user of a problem on line 7. A warning message has been output because the specified ks value exceeded the predefined maximum of 19 bytes.

  10. Because the value of the ks unique key on line 7 in the user-created data file was incorrect, the value could not be used. Accordingly, NG has been output for Result. If the value of Transaction type, ks, or ki, which is a unique key, is incorrect, the line is not processed.