xmscheck Command

Purpose

The xmscheck command is available to pre-parse a recording configuration file and to determine how the running xmtopas daemon is configured for recording.

Syntax

xmscheck [ file_name ]

Description

When the xmtopas command is started with the command line argument -v, its recording configuration file parser writes the result of the parsing to the log file. The output includes a copy of all lines in the recording configuration file, any error messages, and a map of the time scale with indication of when recording starts and stops.

Although this is useful to document what is read from the recording configuration file, it is not a useful tool for debugging of a new or modified recording configuration file. Therefore, the program xmscheck command is available to preparse a recording configuration file before you move it to the /etc/perf directory, where the xmtopas command looks for the recording configuration file.

When xmscheck command is started without any command line argument, it parses the file /etc/perf/xmservd.cf. This way, you can determine how the running daemon is configured for recording. If a file name is specified on the command line, that file is parsed.

Output from the xmscheck command goes to stdout. The parsing is done by the exact same module that does the parsing in the xmtopas command. That module is linked in as part of both programs. The parsing checks that all statistics specified are valid and prints the time scale for starting and stopping recording in the form of a “time table.”

In the time table, each minute has a numeric code. The meaning of codes is as follows:

Item Description
0 Recording is inactive. Neither a start nor a stop request was given for the minute.
1 Recording is active. Neither a start nor a stop request was given for the minute.
2 Recording is inactive. A stop request was given for the minute.
3 Recording is active. A start request was given for the minute.

Examples

The following example shows how the xmscheck command formats the time table. The table only displays part of Tuesday. The example shown in Hot Lines Recording Only section was used to produce this output.

Day 2, Hour 00: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 01: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 02: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 03: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 04: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 05: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 06: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 07: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 08: 000000000000000000000000000000311111111111111111111111111111
Day 2, Hour 09: 111111111111111111111111111111111111111111111111111111111111
Day 2, Hour 10: 111111111111111111111111111111111111111111111111111111111111
Day 2, Hour 11: 111111111111111111111111111111111111111111111111111111111111
Day 2, Hour 12: 200000000000000000000000000000000000000000000000000000000000
Day 2, Hour 13: 311111111111111111111111111111111111111111111111111111111111
Day 2, Hour 14: 111111111111111111111111111111111111111111111111111111111111
Day 2, Hour 15: 111111111111111111111111111111111111111111111111111111111111
Day 2, Hour 16: 111111111111111111111111111111111111111111111111111111111111
Day 2, Hour 17: 200000000000000000000000000000000000000000000000000000000000
Day 2, Hour 18: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 19: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 20: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 21: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 22: 000000000000000000000000000000000000000000000000000000000000
Day 2, Hour 23: 000000000000000000000000000000000000000000000000000000000000