cscmsgtk (Invoking the message tracking function)
- Organization of this page
Format
cscmsgtk [-h] -prf trace-based-performance-analysis -file-name [-date [read-start-date-and-time],[read-end-date-and-time]]
Function
Reads the trace based performance analysis for the specified condition and invokes the message tracking function. When the message tracking function starts, an interactive prompt exclusively used for message tracking appears. This prompt waits for you to enter a command (commands for the message tracking prompt) used in the message tracking function.
By setting up the default trace based performance analysis file name in the HCSC-Manager command definition file, you can omit the specification of the file name in this command.
For details on how to use this command, see 7.10 Error analysis using message tracking in the Service Platform Setup and Operation Guide.
Arguments
-h
Displays the usage of commands. When you specify this option, all other options are ignored even if specified.
-prf trace based-performance-analysis-file-name ~ ((1 to 200 bytes))
Specifies the name of the trace based performance analysis file (CSV format), which is read when the message tracking function is invoked, as an absolute or relative path. If the specified file does not exist, the command ends abnormally.
-date [read-start-date-and-time],[read-end-date-and-time] ~ <one-byte numeric characters>
Specifies the range of trace based performance analysis read when the message tracking function is invoked. Specify the read start date and time and read end date and time in one of the following formats. Also, make sure you specify an existing date and time.
Format 1: hhmmssMMddyyyy
Format 2: hhmmssMMdd
Format 3: hhmmss
-
hh: Hours (00
![[Figure]](GRAPHICS/ZUENGUX0.GIF)
hh 23)
-
mm: Minutes (00
mm 59)
-
ss: Seconds (00
ss 59)
-
MM: Month (01
MM 12)
-
dd: Date (01
dd 31)
-
yyyy: Year (1970
yyyy)
If only the Year is omitted (format 2), the year of command execution will be set up. If the Year, Month, and Date are omitted (format 3), the year, month, and date of command execution will be set up. If the read start date and time is omitted, the trace based performance analysis will be read from the oldest trace. If the read end date and time is omitted, the trace based performance analysis will be read until the most recent trace.
Commands used at the message tracking prompt
Error analysis command
- Format
prf IP-address-of-root-application-information/ process-ID-of-root-application-information/ communication-number-of-root-application-information [Communication-number]
- Description
-
Outputs the information about the trace based performance analysis that matches the specified root application information.
- IP-address-of-root-application-information/ process-ID-of-root-application-information/ communication-number-of-root-application-information
-
Outputs a set of trace contents for the specified root application information.
- Communication-number
-
Outputs detailed information for the specified trace based performance analysis.
List display command
- Format
ls [-e] [-t] [number-of-displayed-items]
- Description
-
Outputs the root application information in a list. The list is output in an ascending order of the output start date and time.
- -e
-
Outputs the root application information that contains an error. Only the root application information containing trace with a return code other than 0 is output.
- -t
-
Outputs the root application information with the longest elapsed time from the trace output first up to the trace output last, in the series of trace based performance analysis indicated by the root application information. The root application information will be output in an ascending order of the elapsed time.
- number-of-displayed-items
-
Outputs the root application information for the specified number of items. A specified number of items are output from the items with the latest output start date and time of the trace based performance analysis.
- Reference note
-
You can also specify the options in continuation such as -et.
(Example) If the number of items to be displayed is 3:
ls -et 3
Focus analysis command
- Format
focus [focus-date-and-time]
- Description
-
This command narrows down only the trace for the processing executed within the specified focus date and time for analysis.
- focus-date-and-time
-
Specify the focus date and time of the trace based performance analysis in one of the following formats. Also, make sure that you specify an existing date and time.
Format 1: hhmmssMMddyyyy
Format 2: hhmmssMMdd
Format 3: hhmmss
-
hh: Hours (00
hh 23)
-
mm: Minutes (00
mm 59)
-
ss: Seconds (00
ss 59)
-
MM: Month (01
MM 12)
-
dd: Date (01
dd 31)
-
yyyy: Year (1970
yyyy)
If only the Year is omitted (format 2), the year of command execution will be set up. If the Year, Month, and Date are omitted (format 3), the Year, Month, and Date of command execution will be set up.
If you want to return the trace to be analyzed to the range used when the message tracking function was invoked, execute the focus command without specifying the focus date and time.
-
Output mode switching command
- Format
mode {normal|detail}- Description
-
Switches the output mode of the trace based performance analysis.
-
normal
The trace based performance analysis will be output in the standard output mode. Only the trace based performance analysis collected at the trace points for the service platform is output.
-
detail
The trace based performance analysis will be output in the detailed output mode. The entire trace based performance analysis is output.
-
Command for displaying trace collection points
- Format
id {event-ID|list}- Description
-
Displays the collection points for the trace based performance analysis.
-
event-ID
Displays the trace collection points for the specified event ID.
-
list
Displays all the trace collection points for the service platform.
-
Examples of input
- (1) To read the entire trace
cscmsgtk -prf prf_trace.csv
- (2) To read the trace collected from 8hrs 45 mins 00 secs to 17 hrs 15 mins 00 secs on the command execution date
cscmsgtk -prf prf_trace.csv -date 084500,171500
- (3) To read the trace collected from March 23, 8 hrs 45 mins 00 secs to March 24, 17 hrs 15 mins 00 secs in the command execution year
cscmsgtk -prf prf_trace.csv -date 0845000323,1715000324
- (4) To read the trace collected from March 23, 2008, 8 hrs 45 mins 00 secs to March 24, 2008, 17 hrs 15 mins 00 secs
cscmsgtk -prf prf_trace.csv -date 08450003232008,17150003242008
- (5) To read the entire trace collected before 17 hrs 15 mins 00 secs on the command execution date
cscmsgtk -prf prf_trace.csv -date ,171500
- (6) To read the entire trace collected after 8 hrs 45 mins 00 secs on the command execution date
cscmsgtk -prf prf_trace.csv -date 084500,
Notes
-
An error occurs in the following cases:
-
When the syntax of the command argument is invalid
-
When an attempt to access the trace based performance analysis file fails
-
When the specified read start date and time or read end date and time is incorrect
-
-
The messages displayed when the cscmsgtk command is being executed or when the message tracking function is being invoked are not output to the log file.
-
During the execution of other commands, if the message tracking function is invoked by reading a trace based performance analysis file with a large file size, the throughput of the other commands might decrease.