NAME

xstat_cm_test - Gathers data collections from the Cache Manager

SYNOPSIS

  use AFS::Monitor qw(xstat_cm_test);

  my $result = xstat_cm_test(
                             cmname => ["hostName1", "hostName2"],
                             collID => [0, 1, 2],
                            );

  foreach my $probe (@$result) {
    print "For host: $probe->{hostName}, ";
    print "Collection $probe->{collectionNumber}\n";
    if ($probe->{probeOK}) {
      print "probe successful\n";
    } else {
      print "probe failed\n";
    }
  }

DESCRIPTION

The xstat_cm_test function returns the data collections from libxstat_cm.a associated with the Cache Manager.

OPTIONS

cmname

String with one name or reference to an array with names of one or more machines from which to monitor the Cache Manager.

collID

Integer or reference to an array where each entry specifies a data collection to return, which defines the type and amount of data the command interpreter gathers about the Cache Manager. Data is returned in a predefined data structure.

There are three acceptable values:

0

Provides profiling information about the numbers of times different internal Cache Manager routines were called since the Cache Manager started.

1

Reports various internal performance statistics related to the Cache Manager (for example, statistics about how effectively the cache is being used and the quantity of intracell and intercell data access).

2

Reports all of the internal performance statistics provided by the 1 setting, plus some additional, detailed performance figures (for example, statistics about the number of RPCs sent by the Cache Manager and how long they take to complete, and statistics regarding authentication, access, and PAG information associated with data access).

OUTPUT

The returned value is a reference to an array. There is an entry in the array for each collection gathered for each cache manager. Each entry in the array is a reference to a hash, containing the following keys:

hostName

The name of the cache manager this data collection represents

collectionNumber

The data collection number

probeTime

The time the probe was initiated, measured in seconds since the Epoch (00:00:00 UTC, January 1, 1970).

probeOK

1 if the probe was successful, 0 if the probe failed.

data

If the probe was not successful, this key will not exist. Otherwise, this entry will contain a reference to a hash containing all of the data collected. For details on the contents of this hash, and an example of printing it in a readable format, refer to the xstat_cm_test script in the examples directory.

AUTHORS

The code and documentation for this class were contributed by Stanford Linear Accelerator Center, a department of Stanford University. This documentation was written by

Elizabeth Cassell <e_a_c@mailsnare.net> and

Alf Wachsmann <alfw@slac.stanford.edu>

COPYRIGHT AND DISCLAIMER

 Copyright 2004 Alf Wachsmann <alfw@slac.stanford.edu> and
                Elizabeth Cassell <e_a_c@mailsnare.net>
 All rights reserved.

 Most of the explanations in this document are taken from the original
 AFS documentation.

 AFS-3 Programmer's Reference:
 Volume Server/Volume Location Server Interface
 Edward R. Zayas
 (c) 1991 Transarc Corporation.
 All rights reserved.

 IBM AFS Administration Reference
 (c) IBM Corporation 2000.
 All rights reserved.

 This library is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.