1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
11 <!-- (C) IBM Corporation 2000. All Rights Reserved -->
12 <BODY bgcolor="ffffff">
13 <!-- End Header Records ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf058.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf060.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
18 <H2><A NAME="HDRAFSMONITOR" HREF="auarf002.htm#ToC_73">afsmonitor</A></H2>
19 <P><STRONG>Purpose</STRONG>
20 <P>Monitors File Servers and Cache Managers
21 <P><STRONG>Description</STRONG>
22 <PRE><B>afsmonitor</B> [<B>initcmd</B>] [<B>-config</B> <<VAR>configuration file</VAR>>]
23 [<B>-frequency</B> <<VAR>poll frequency, in seconds</VAR>>]
24 [<B>-output</B> <<VAR>storage file name</VAR>>] [<B>-detailed</B>]
25 [<B>-debug</B> <<VAR>turn debugging output on to the named file</VAR>>]
26 [<B>-fshosts</B> <<VAR>list of file servers to monitor</VAR>><SUP>+</SUP>]
27 [<B>-cmhosts</B> <<VAR>list of cache managers to monitor</VAR>><SUP>+</SUP>]
28 [<B>-buffers</B> <<VAR>number of buffer slots</VAR>>] [<B>-help</B>]
30 <B>afsmonitor</B> [<B>i</B>] [<B>-co</B> <<VAR>configuration file</VAR>>]
31 [<B>-fr</B> <<VAR>poll frequency, in seconds</VAR>>]
32 [<B>-o</B> <<VAR>storage file name</VAR>>] [<B>-det</B>]
33 [<B>-deb</B> <<VAR>turn debugging output on to the named file</VAR>>]
34 [<B>-fs</B> <<VAR>list of file servers to monitor</VAR>><SUP>+</SUP>]
35 [<B>-cm</B> <<VAR>list of cache managers to monitor</VAR>><SUP>+</SUP>]
36 [<B>-b</B> <<VAR>number of buffer slots</VAR>>] [<B>-h</B>]
38 <P><STRONG>Description</STRONG>
39 <P>The <B>afsmonitor</B> command initializes a program that gathers and
40 displays statistics about specified File Server and Cache Manager
41 operations. It allows the issuer to monitor, from a single location, a
42 wide range of File Server and Cache Manager operations on any number of
43 machines in both local and foreign cells.
44 <P>There are 271 available File Server statistics and 570 available Cache
45 Manager statistics, listed in the appendix about <B>afsmonitor</B>
46 statistics in the <I>IBM AFS Administration Guide</I>. By default,
47 the command displays all of the relevant statistics for the file server
48 machines named by the <B>-fshosts</B> argument and the client machines
49 named by the <B>-cmhosts</B> argument. To limit the display to only
50 the statistics of interest, list them in the configuration file specified by
51 the <B>-config</B> argument. In addition, use the configuration
52 file for the following purposes:
54 <P><LI>To set threshold values for any monitored statistic. When the value
55 of a statistic exceeds the threshold, the <B>afsmonitor</B> command
56 displays it in reverse video. There are no default threshold
58 <P><LI>To invoke a program or script automatically when a statistic exceeds its
59 threshold. The AFS distribution does not include any such
61 <P><LI>To list the file server and client machines to monitor, instead of using
62 the <B>-fshosts</B> and <B>-cmhosts</B> arguments.
64 <P>For a description of the configuration file, see the <B>afsmonitor
65 Configuration File</B> reference page
66 <P><STRONG>Cautions</STRONG>
67 <P>The following software must be accessible to a machine where the
68 <B>afsmonitor</B> program is running:
70 <P><LI>The AFS <B>xstat</B> libraries, which the <B>afsmonitor</B>
71 program uses to gather data
72 <P><LI>The <B>curses</B> graphics package, which most UNIX distributions
73 provide as a standard utility
75 <A NAME="IDX4198"></A>
76 <A NAME="IDX4199"></A>
77 <P>The <B>afsmonitor</B> screens format successfully both on so-called
78 dumb terminals and in windowing systems that emulate terminals. For the
79 output to looks its best, the display environment needs to support reverse
80 video and cursor addressing. Set the TERM environment variable to the
81 correct terminal type, or to a value that has characteristics similar to the
82 actual terminal type. The display window or terminal must be at least
83 80 columns wide and 12 lines long.
84 <A NAME="IDX4200"></A>
85 <A NAME="IDX4201"></A>
86 <A NAME="IDX4202"></A>
87 <P>The <B>afsmonitor</B> program must run in the foreground, and in its
88 own separate, dedicated window or terminal. The window or terminal is
89 unavailable for any other activity as long as the <B>afsmonitor</B>
90 program is running. Any number of instances of the
91 <B>afsmonitor</B> program can run on a single machine, as long as each
92 instance runs in its own dedicated window or terminal. Note that it can
93 take up to three minutes to start an additional instance.
94 <P><STRONG>Options</STRONG>
97 </B><DD>Accommodates the command's use of the AFS command parser, and is
100 </B><DD>Names the configuration file which lists the machines to monitor,
101 statistics to display, and threshold values, if any. A partial pathname
102 is interpreted relative to the current working directory. Provide this
103 argument if not providing the <B>-fshosts</B> argument,
104 <B>-cmhosts</B> argument, or neither. For instructions on creating
105 this file, see the preceding <B>Description</B> section, and the section
106 on the <B>afsmonitor</B> program in the <I>IBM AFS Administration
109 </B><DD>Specifies in seconds how often the <B>afsmonitor</B> program probes
110 the File Servers and Cache Managers. Valid values range from
111 <B>1</B> to <B>86400</B> (which is 24 hours); the default value
112 is <B>60</B>. This frequency applies to both File Servers and Cache
113 Managers, but the <B>afsmonitor</B> program initiates the two types of
114 probes, and processes their results, separately. The actual interval
115 between probes to a host is the probe frequency plus the time required for all
118 </B><DD>Names the file to which the <B>afsmonitor</B> program writes all of
119 the statistics that it collects. By default, no output file is
120 created. See the section on the <B>afsmonitor</B> command in the
121 <I>IBM AFS Administration Guide</I> for information on this file.
123 </B><DD>Formats the information in the output file named by <B>-output</B>
124 argument in a maximally readable format. Provide the <B>-output</B>
125 argument along with this one.
127 </B><DD>Names one or more machines from which to gather File Server
128 statistics. For each machine, provide either a fully qualified host
129 name, or an unambiguous abbreviation (the ability to resolve an abbreviation
130 depends on the state of the cell's name service at the time the command
131 is issued). This argument can be combined with the <B>-cmhosts</B>
132 argument, but not with the <B>-config</B> argument.
134 </B><DD>Names one or more machines from which to gather Cache Manager
135 statistics. For each machine, provide either a fully qualified host
136 name, or an unambiguous abbreviation (the ability to resolve an abbreviation
137 depends on the state of the cell's name service at the time the command
138 is issued). This argument can be combined with the <B>-fshosts</B>
139 argument, but not with the <B>-config</B> argument.
141 </B><DD>Is nonoperational and provided to accommodate potential future
142 enhancements to the program.
144 </B><DD>Prints the online help for this command. All other valid options
147 <P><STRONG>Output</STRONG>
148 <P>The <B>afsmonitor</B> program displays its data on three screens:
150 <P><LI><TT>System Overview</TT>: This screen appears automatically when
151 the <B>afsmonitor</B> program initializes. It summarizes separately
152 for File Servers and Cache Managers the number of machines being monitored and
153 how many of them have <I>alerts</I> (statistics that have exceeded their
154 thresholds). It then lists the hostname and number of alerts for each
155 machine being monitored, indicating if appropriate that a process failed to
156 respond to the last probe.
157 <P><LI><TT>File Server</TT>: This screen displays File Server statistics
158 for each file server machine being monitored. It highlights statistics
159 that have exceeded their thresholds, and identifies machines that failed to
160 respond to the last probe.
161 <P><LI><TT>Cache Managers</TT>: This screen displays Cache Manager
162 statistics for each client machine being monitored. It highlights
163 statistics that have exceeded their thresholds, and identifies machines that
164 failed to respond to the last probe.
166 <P>Fields at the corners of every screen display the following
169 <P><LI>In the top left corner, the program name and version number.
170 <P><LI>In the top right corner, the screen name, current and total page numbers,
171 and current and total column numbers. The page number (for example,
172 <TT>p. 1 of 3</TT>) indicates the index of the current page and the
173 total number of (vertical) pages over which data is displayed. The
174 column number (for example, <TT>c. 1 of 235</TT>) indicates the index
175 of the current leftmost column and the total number of columns in which data
176 appears. (The symbol <TT>>>></TT> indicates that there is additional
177 data to the right; the symbol <TT><<<</TT> indicates that
178 there is additional data to the left.)
179 <P><LI>In the bottom left corner, a list of the available commands. Enter
180 the first letter in the command name to run that command. Only the
181 currently possible options appear; for example, if there is only one page
182 of data, the <TT>next</TT> and <TT>prev</TT> commands, which scroll the
183 screen up and down respectively, do not appear. For descriptions of the
184 commands, see the following section about navigating the display
186 <P><LI>In the bottom right corner, the <TT>probes</TT> field reports how many
187 times the program has probed File Servers (<TT>fs</TT>), Cache Managers
188 (<TT>cm</TT>), or both. The counts for File Servers and Cache
189 Managers can differ. The <TT>freq</TT> field reports how often the
190 program sends probes.
192 <P><B>Navigating the afsmonitor Display Screens</B>
193 <P>As noted, the lower left hand corner of every display screen displays the
194 names of the commands currently available for moving to alternate screens,
195 which can either be a different type or display more statistics or machines of
196 the current type. To execute a command, press the lowercase version of
197 the first letter in its name. Some commands also have an uppercase
198 version that has a somewhat different effect, as indicated in the following
201 <P><DT><B><TT>cm</TT>
202 </B><DD>Switches to the <TT>Cache Managers</TT> screen. Available only on
203 the <TT>System Overview</TT> and <TT>File Servers</TT> screens.
204 <P><DT><B><TT>fs</TT>
205 </B><DD>Switches to the <TT>File Servers</TT> screen. Available only on
206 the <TT>System Overview</TT> and the <TT>Cache Managers</TT>
208 <P><DT><B><TT>left</TT>
209 </B><DD>Scrolls horizontally to the left, to access the data columns situated to
210 the left of the current set. Available when the <TT><<<</TT>
211 symbol appears at the top left of the screen. Press uppercase
212 <B>L</B> to scroll horizontally all the way to the left (to display the
213 first set of data columns).
214 <P><DT><B><TT>next</TT>
215 </B><DD>Scrolls down vertically to the next page of machine names.
216 Available when there are two or more pages of machines and the final page is
217 not currently displayed. Press uppercase <B>N</B> to scroll to the
219 <P><DT><B><TT>oview</TT>
220 </B><DD>Switches to the <TT>System Overview</TT> screen. Available only
221 on the <TT>Cache Managers</TT> and <TT>File Servers</TT> screens.
222 <P><DT><B><TT>prev</TT>
223 </B><DD>Scrolls up vertically to the previous page of machine names.
224 Available when there are two or more pages of machines and the first page is
225 not currently displayed. Press uppercase <B>N</B> to scroll to the
227 <P><DT><B><TT>right</TT>
228 </B><DD>Scrolls horizontally to the right, to access the data columns situated to
229 the right of the current set. This command is available when the
230 <TT>>>></TT> symbol appears at the upper right of the screen. Press
231 uppercase <B>R</B> to scroll horizontally all the way to the right (to
232 display the final set of data columns).
234 <P><B>The System Overview Screen</B>
235 <P>The <TT>System Overview</TT> screen appears automatically as the
236 <B>afsmonitor</B> program initializes. This screen displays the
237 status of as many File Server and Cache Manager processes as can fit in the
238 current window; scroll down to access additional information.
239 <P>The information on this screen is split into File Server information on the
240 left and Cache Manager information on the right. The header for each
241 grouping reports two pieces of information:
243 <P><LI>The number of machines on which the program is monitoring the indicated
245 <P><LI>The number of alerts and the number of machines affected by them (an
246 <I>alert</I>means that a statistic has exceeded its threshold or a process
247 failed to respond to the last probe)
249 <P>A list of the machines being monitored follows. If there are any
250 alerts on a machine, the number of them appears in square brackets to the left
251 of the hostname. If a process failed to respond to the last probe, the
252 letters <TT>PF</TT> (probe failure) appear in square brackets to the left of
254 <P><B>The File Servers Screen</B>
255 <P>The <TT>File Servers</TT> screen displays the values collected at the
256 most recent probe for File Server statistics.
257 <P>A summary line at the top of the screen (just below the standard program
258 version and screen title blocks) specifies the number of monitored File
259 Servers, the number of alerts, and the number of machines affected by the
261 <P>The first column always displays the hostnames of the machines running the
262 monitored File Servers.
263 <P>To the right of the hostname column appear as many columns of statistics as
264 can fit within the current width of the display screen or window; each
265 column requires space for 10 characters. The name of the statistic
266 appears at the top of each column. If the File Server on a machine did
267 not respond to the most recent probe, a pair of dashes (<TT>--</TT>) appears
268 in each column. If a value exceeds its configured threshold, it is
269 highlighted in reverse video. If a value is too large to fit into the
270 allotted column width, it overflows into the next row in the same
272 <P><B>The Cache Managers Screen</B>
273 <P>The <TT>Cache Managers</TT> screen displays the values collected at the
274 most recent probe for Cache Manager statistics.
275 <P>A summary line at the top of the screen (just below the standard program
276 version and screen title blocks) specifies the number of monitored Cache
277 Managers, the number of alerts, and the number of machines affected by the
279 <P>The first column always displays the hostnames of the machines running the
280 monitored Cache Managers.
281 <P>To the right of the hostname column appear as many columns of statistics as
282 can fit within the current width of the display screen or window; each
283 column requires space for 10 characters. The name of the statistic
284 appears at the top of each column. If the Cache Manager on a machine
285 did not respond to the most recent probe, a pair of dashes (<TT>--</TT>)
286 appears in each column. If a value exceeds its configured threshold, it
287 is highlighted in reverse video. If a value is too large to fit into
288 the allotted column width, it overflows into the next row in the same
290 <P><B>Writing to an Output File</B>
291 <P>Include the <B>-output</B> argument to name the file into which the
292 <B>afsmonitor</B> program writes all of the statistics it collects.
293 The output file can be useful for tracking performance over long periods of
294 time, and enables the administrator to apply post-processing techniques that
295 reveal system trends. The AFS distribution does not include any
296 post-processing programs.
297 <P>The output file is in ASCII format and records the same information as the
298 <TT>File Server</TT> and <TT>Cache Manager</TT> display screens.
299 Each line in the file uses the following format to record the time at which
300 the <B>afsmonitor</B> program gathered the indicated statistic from the
301 Cache Manager (<TT>CM</TT>) or File Server (<TT>FS</TT>) running on the
302 machine called <VAR>host_name</VAR>. If a probe failed, the error code
303 <TT>-1</TT> appears in the <VAR>statistic</VAR> field.
304 <PRE> <VAR>time</VAR> <VAR>host_name</VAR> CM|FS <VAR>statistic</VAR>
307 <P>If the administrator usually reviews the output file manually, rather than
308 using it as input to an automated analysis program or script, including the
309 <B>-detail</B> flag formats the data in a more easily readable
311 <P><STRONG>Examples</STRONG>
312 <P>For examples of commands, display screens, and configuration files, see the
313 section about the <B>afsmonitor</B> program in the <I>IBM AFS
314 Administration Guide</I>.
315 <P><STRONG>Privilege Required</STRONG>
317 <P><STRONG>Related Information</STRONG>
318 <P><A HREF="auarf052.htm#HDRAFSMONCONFIG">afsmonitor Configuration File</A>
319 <P><A HREF="auarf169.htm#HDRFSTRACE_INTRO">fstrace</A>
320 <P><A HREF="auarf233.htm#HDRSCOUT">scout</A>
322 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf058.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf060.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
323 <!-- Begin Footer Records ========================================== -->
325 <br>© <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
327 <!-- End Footer Records ============================================ -->
328 <A NAME="Bot_Of_Page"></A>
git://git.openafs.org / openafs.git / blob