xmpeek Command

Purpose

The xmpeek command allows you to query any host about the status of its xmtopas daemon.

Syntax

xmpeek [ -a | -l ] [ hostname ]

Description

The xmpeek command is used to list down the data consumers that currently have instruments (stat sets) defined with the xmtopas daemon, and list down all known data consumers by the xmtopas daemon . The xmpeek command is also used to print down all the available SPMI statistics for any given host.

Flags

Item Description
-a If this flag is specified, one line is listed for each data consumer known by the daemon. If this flag is not used, only data consumers that currently have instruments (stat sets) defined with the daemon are listed. This flag is optional.
-l This flag is explained in the Using the xmpeek Program to Print Available Statistics document. This flag is optional.
hostname If the hostname is specified, the daemon on the named host is asked. If no host name is specified, the daemon on the local host is asked.

Examples

The following is an example of the output from the xmpeek program:

Statistics for xmtopas daemon on *** birte ***
Instruments currently defined:    1
Instruments currently active:     1
Remote monitors currently known:  2
--Instruments--- Values  Packets
                                Internet Protocol
Defined Active  Active  Sent        Address      Port Hostname
------- ------- ------- ------- ---------------- ---- ----------
1       1       16      3,344   129.49.115.208   3885 xtra

Output from xmpeek can take two forms.

The first form is a line that informs you that the xmtopas daemon is not feeding any data-consumer programs. This form is used if no statsets are defined with the daemon and no command flags are supplied.

The second form includes at least as much as is shown in the preceding example, except that the single detail line for the data consumer on host xtra is shown only if either the -a flag is used or if the data consumer has at least one instrument (statset) defined with the daemon. Note that xmpeek itself appears as a data consumer because it uses the Remote Statistics Interface (RSI) API to contact the daemon. Therefore, the output always shows at least one known monitor.

In the fixed output, first the name of the host where the daemon is running is shown. Then follows three lines giving the totals for current status of the daemon. In the above example, you can see that only one instrument is defined and that it's active. You can also see that two data consumers are known by the daemon, but that only one of them has an instrument defined with the daemon in birte. Obviously, this output was produced without the -a flag.

An example of more activity is shown in the following sample output from xmpeek. The output is produced with the command:

xmpeek -a birte 

Notice that some detail lines show zero instruments defined. Such lines indicate that an are_you_there message was received from the data consumer but that no states were ever defined or that any previously defined states were erased.

Statistics for smeared daemon on *** birte ***
   Instruments currently defined:    16
   Instruments currently active:     14
   Remote monitors currently known:   6
--Instruments--- Values Packets   Internet Protocol
 Defined Active  Active  Sent         Address      Port  Hostname
   8       8       35    10,232    129.49.115.203  4184   birte
   6       4       28     8,322    129.49.246.14   3211   umbra
   0       0        0         0    129.49.115.208  3861   xtra
   1       1       16     3,332    129.49.246.14   3219   umbra
   0       0        0         0    129.49.115.203  4209   birte
   1       1       16       422    129.49.115.208  3874   xtra
------- ------- ------- ----------
  16      14       95    22,308

Notice that the same host name may appear more than once. This is because every running copy of xmperf and every other active data-consumer program is counted and treated as a separate data consumer, each identified by the port number used for UDP packets as shown in the xmpeek output.

The second detail shows that one particular monitor on host umbra has six instruments defined but only four active. This would happen if a remote xmperf console has been opened but is now closed. When you close an xmperf console, it stays in the Monitor menu of the xmperf main window and the definition of the instruments of that console remains in the tables of the data-supplier daemon but the instruments are not active.