mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
32d823c52f
Recent versions of Pod::Simple complain if we use integers or other special characters in an =item list. We have a couple bulleted lists that happen to have integers or other special characters as the list values. Quote the items with C<> so that Pod::Simple can correctly parse them again. Change-Id: If456781fe219b73ae01feb9aef2fb2639e097534 Reviewed-on: http://gerrit.openafs.org/9838 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Jeffrey Altman <jaltman@your-file-system.com> Tested-by: Jeffrey Altman <jaltman@your-file-system.com>
121 lines
3.6 KiB
Plaintext
121 lines
3.6 KiB
Plaintext
=head1 NAME
|
|
|
|
xstat_fs_test - Displays data collections from the File Server process
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<xstat_fs_test> [I<initcmd>] S<<< B<-fsname> <I<file server name(s) to monitor>>+ >>>
|
|
S<<< B<-collID> <I<collection(s) to fetch>>+ >>> [B<-onceonly>]
|
|
S<<< [B<-frequency> <I<poll frequency, in seconds>>] >>>
|
|
S<<< [B<-period> <I<data collection time, in minutes>>] >>> [B<-debug>] [B<-help>]
|
|
|
|
B<xstat_fs_test> [B<initcmd>] S<<< B<-fs> <I<File Server name(s) to monitor>>+ >>>
|
|
S<<< B<-c> <I<Collection(s) to fetch>>+ >>> [B<-o>]
|
|
S<<< [B<-fr> <I<poll frequency, in seconds>>] >>>
|
|
S<<< [B<-p> <I<data collection time, in minutes>>] >>> [B<-d>] [B<-h>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<xstat_fs_test> command tests the routines in the F<libxstat_fs.a>
|
|
library and displays the data collections associated with the File Server
|
|
(the C<fs> process). The command executes in the foreground.
|
|
|
|
The command produces a large volume of output; to save it for later
|
|
analysis, direct it to a file.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item I<initcmd>
|
|
|
|
Accommodates the command's use of the AFS command parser, and is optional.
|
|
|
|
=item B<-fsname> <I<file server name to monitor>>+
|
|
|
|
Specifies the fully qualified hostname of each file server machine for
|
|
which to monitor the File Server process.
|
|
|
|
=item B<-collID> <I<collection to fetch>>+
|
|
|
|
Specifies each data collection to return, which defines the type and
|
|
amount of data the command interpreter gathers about the File Server.
|
|
Data is returned in a predefined data structure.
|
|
|
|
There are four acceptable values:
|
|
|
|
=over 4
|
|
|
|
=item C<0>
|
|
|
|
Provides profiling information about the numbers of times different
|
|
internal File Server routines were called since the File Server
|
|
started. This value is not currently implemented; it returns no data.
|
|
|
|
=item C<1>
|
|
|
|
Reports various internal performance statistics related to the File Server
|
|
(for example, vnode cache entries and Rx protocol activity).
|
|
|
|
=item C<2>
|
|
|
|
Reports all of the internal performance statistics provided by the C<1>
|
|
setting, plus some additional, detailed performance figures about the File
|
|
Server (for example, minimum, maximum, and cumulative statistics regarding
|
|
File Server RPCs, how long they take to complete, and how many succeed).
|
|
|
|
=item C<3>
|
|
|
|
Reports File Server callback processing statistics since the File Server
|
|
started, including the number of call of callbacks added (AddCallBack), the
|
|
number of callbacks broken (BreakCallBacks), and the number of callback
|
|
space reclaims (GetSomeSpaces).
|
|
|
|
=back
|
|
|
|
=item B<-onceonly>
|
|
|
|
Gathers statistics just one time. Omit this flag to have the command
|
|
continue to probe the Cache Manager for statistics at the frequency
|
|
specified by the B<-frequency> argument; in this case press Ctrl-C to stop
|
|
the probes.
|
|
|
|
=item B<-frequency> <I<poll frequency>>
|
|
|
|
Sets the frequency in seconds at which the program initiates probes to the
|
|
Cache Manager. The default is 30 seconds.
|
|
|
|
=item B<-period> <I<data collection time>>
|
|
|
|
Sets the number of minutes the program runs; at the end of this period of
|
|
time, the program exits. The default is 10 minutes.
|
|
|
|
=item B<-debug>
|
|
|
|
Displays a trace on the standard output stream as the command runs.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<xstat_cm_test(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
|