xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminGuide / c18360.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >Monitoring and Auditing AFS Performance</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
9 REL="HOME"
10 TITLE="AFS Administration Guide"
11 HREF="book1.html"><LINK
12 REL="UP"
13 TITLE="Managing File Server Machines"
14 HREF="p3023.html"><LINK
15 REL="PREVIOUS"
16 TITLE="Backing Up and Restoring AFS Data"
17 HREF="c15383.html"><LINK
18 REL="NEXT"
19 TITLE="Managing Server Encryption Keys"
20 HREF="c20494.html"></HEAD
21 ><BODY
22 CLASS="chapter"
23 BGCOLOR="#FFFFFF"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >AFS Administration Guide: Version 3.6</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="c15383.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 ></TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="c20494.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><DIV
72 CLASS="chapter"
73 ><H1
74 ><A
75 NAME="HDRWQ323"
76 ></A
77 >Chapter 8. Monitoring and Auditing AFS Performance</H1
78 ><P
79 >AFS comes with three main monitoring tools: <UL
80 ><LI
81 ><P
82 >The <SPAN
83 CLASS="bold"
84 ><B
85 CLASS="emphasis"
86 >scout</B
87 ></SPAN
88 > program, which monitors and gathers statistics on File Server
89         performance.</P
90 ></LI
91 ><LI
92 ><P
93 >The <SPAN
94 CLASS="bold"
95 ><B
96 CLASS="emphasis"
97 >fstrace</B
98 ></SPAN
99 > command suite, which traces Cache Manager operations in detail.</P
100 ></LI
101 ><LI
102 ><P
103 >The <SPAN
104 CLASS="bold"
105 ><B
106 CLASS="emphasis"
107 >afsmonitor</B
108 ></SPAN
109 > program, which monitors and gathers statistics on both the File Server
110         and the Cache Manager.</P
111 ></LI
112 ></UL
113 ></P
114 ><P
115 >AFS also provides a tool for auditing AFS events on file server machines running AIX.</P
116 ><DIV
117 CLASS="sect1"
118 ><H1
119 CLASS="sect1"
120 ><A
121 NAME="HDRWQ324"
122 >Summary of Instructions</A
123 ></H1
124 ><P
125 >This chapter explains how to perform the following tasks by using the indicated commands:</P
126 ><DIV
127 CLASS="informaltable"
128 ><A
129 NAME="AEN18400"
130 ></A
131 ><TABLE
132 BORDER="0"
133 FRAME="void"
134 CLASS="CALSTABLE"
135 ><COL
136 WIDTH="70*"><COL
137 WIDTH="30*"><TBODY
138 ><TR
139 ><TD
140 >Initialize the <SPAN
141 CLASS="bold"
142 ><B
143 CLASS="emphasis"
144 >scout</B
145 ></SPAN
146 > program</TD
147 ><TD
148 ><SPAN
149 CLASS="bold"
150 ><B
151 CLASS="emphasis"
152 >scout</B
153 ></SPAN
154 ></TD
155 ></TR
156 ><TR
157 ><TD
158 >Display information about a trace log</TD
159 ><TD
160 ><SPAN
161 CLASS="bold"
162 ><B
163 CLASS="emphasis"
164 >fstrace lslog</B
165 ></SPAN
166 ></TD
167 ></TR
168 ><TR
169 ><TD
170 >Display information about an event set</TD
171 ><TD
172 ><SPAN
173 CLASS="bold"
174 ><B
175 CLASS="emphasis"
176 >fstrace lsset</B
177 ></SPAN
178 ></TD
179 ></TR
180 ><TR
181 ><TD
182 >Change the size of a trace log</TD
183 ><TD
184 ><SPAN
185 CLASS="bold"
186 ><B
187 CLASS="emphasis"
188 >fstrace setlog</B
189 ></SPAN
190 ></TD
191 ></TR
192 ><TR
193 ><TD
194 >Set the state of an event set</TD
195 ><TD
196 ><SPAN
197 CLASS="bold"
198 ><B
199 CLASS="emphasis"
200 >fstrace setset</B
201 ></SPAN
202 ></TD
203 ></TR
204 ><TR
205 ><TD
206 >Dump contents of a trace log</TD
207 ><TD
208 ><SPAN
209 CLASS="bold"
210 ><B
211 CLASS="emphasis"
212 >fstrace dump</B
213 ></SPAN
214 ></TD
215 ></TR
216 ><TR
217 ><TD
218 >Clear a trace log</TD
219 ><TD
220 ><SPAN
221 CLASS="bold"
222 ><B
223 CLASS="emphasis"
224 >fstrace clear</B
225 ></SPAN
226 ></TD
227 ></TR
228 ><TR
229 ><TD
230 >Initialize the <SPAN
231 CLASS="bold"
232 ><B
233 CLASS="emphasis"
234 >afsmonitor</B
235 ></SPAN
236 > program</TD
237 ><TD
238 ><SPAN
239 CLASS="bold"
240 ><B
241 CLASS="emphasis"
242 >afsmonitor</B
243 ></SPAN
244 ></TD
245 ></TR
246 ></TBODY
247 ></TABLE
248 ></DIV
249 ></DIV
250 ><DIV
251 CLASS="sect1"
252 ><H1
253 CLASS="sect1"
254 ><A
255 NAME="HDRWQ326"
256 >Using the scout Program</A
257 ></H1
258 ><P
259 >The <SPAN
260 CLASS="bold"
261 ><B
262 CLASS="emphasis"
263 >scout</B
264 ></SPAN
265 > program monitors the status of the File Server process running on file server
266     machines. It periodically collects statistics from a specified set of File Server processes, displays them in a graphical
267     format, and alerts you if any of the statistics exceed a configurable threshold.</P
268 ><P
269 >More specifically, the <SPAN
270 CLASS="bold"
271 ><B
272 CLASS="emphasis"
273 >scout</B
274 ></SPAN
275 > program includes the following features. <UL
276 ><LI
277 ><P
278 >You can monitor, from a single location, the File Server process on any number of server machines from the local and
279           foreign cells. The number is limited only by the size of the display window, which must be large enough to display the
280           statistics.</P
281 ></LI
282 ><LI
283 ><P
284 >You can set a threshold for many of the statistics. When the value of a statistic exceeds the threshold, the
285           <SPAN
286 CLASS="bold"
287 ><B
288 CLASS="emphasis"
289 >scout</B
290 ></SPAN
291 > program highlights it (displays it in reverse video) to draw your attention to it.
292           If the value goes back under the threshold, the highlighting is deactivated. You control the thresholds, so highlighting
293           reflects what you consider to be a noteworthy situation. See <A
294 HREF="c18360.html#HDRWQ332"
295 >Highlighting Significant
296           Statistics</A
297 >.</P
298 ></LI
299 ><LI
300 ><P
301 >The <SPAN
302 CLASS="bold"
303 ><B
304 CLASS="emphasis"
305 >scout</B
306 ></SPAN
307 > program alerts you to File Server process, machine, and network outages
308           by highlighting the name of each machine that does not respond to its probe, enabling you to respond more quickly.</P
309 ></LI
310 ><LI
311 ><P
312 >You can set how often the <SPAN
313 CLASS="bold"
314 ><B
315 CLASS="emphasis"
316 >scout</B
317 ></SPAN
318 > program collects statistics from the File Server
319           processes.</P
320 ></LI
321 ></UL
322 ></P
323 ><DIV
324 CLASS="sect2"
325 ><H2
326 CLASS="sect2"
327 ><A
328 NAME="HDRWQ327"
329 >System Requirements</A
330 ></H2
331 ><P
332 >The <SPAN
333 CLASS="bold"
334 ><B
335 CLASS="emphasis"
336 >scout</B
337 ></SPAN
338 > program runs on any AFS client machine that has access to the <SPAN
339 CLASS="bold"
340 ><B
341 CLASS="emphasis"
342 >curses</B
343 ></SPAN
344 > graphics package, which most UNIX distributions include as a standard utility. It can run on
345       both dumb terminals and under windowing systems that emulate terminals, but the output looks best on machines that support
346       reverse video and cursor addressing. For best results, set the TERM environment variable to the correct terminal type, or one
347       with characteristics similar to the actual ones. For machines running AIX, the recommended TERM setting is <SPAN
348 CLASS="bold"
349 ><B
350 CLASS="emphasis"
351 >vt100</B
352 ></SPAN
353 >, assuming the terminal is similar to that. For other operating systems, the wider range of
354       acceptable values includes <SPAN
355 CLASS="bold"
356 ><B
357 CLASS="emphasis"
358 >xterm</B
359 ></SPAN
360 >, <SPAN
361 CLASS="bold"
362 ><B
363 CLASS="emphasis"
364 >xterms</B
365 ></SPAN
366 >, <SPAN
367 CLASS="bold"
368 ><B
369 CLASS="emphasis"
370 >vt100</B
371 ></SPAN
372 >, <SPAN
373 CLASS="bold"
374 ><B
375 CLASS="emphasis"
376 >vt200</B
377 ></SPAN
378 >, and <SPAN
379 CLASS="bold"
380 ><B
381 CLASS="emphasis"
382 >wyse85</B
383 ></SPAN
384 >.</P
385 ><P
386 >No privilege is required to run the <SPAN
387 CLASS="bold"
388 ><B
389 CLASS="emphasis"
390 >scout</B
391 ></SPAN
392 > program, so any user who can access the
393       directory where its binary resides (the <SPAN
394 CLASS="bold"
395 ><B
396 CLASS="emphasis"
397 >/usr/afsws/bin</B
398 ></SPAN
399 > directory in the conventional
400       configuration) can use it. The program's probes for collecting statistics do not impose a significant burden on the File
401       Server process, but you can restrict its use by placing the binary file in a directory with a more restrictive access control
402       list (ACL).</P
403 ><P
404 >Multiple instances of the <SPAN
405 CLASS="bold"
406 ><B
407 CLASS="emphasis"
408 >scout</B
409 ></SPAN
410 > program can run on a single client machine, each over
411       its own dedicated connection (in its own window). It must run in the foreground, so the window in which it runs does not
412       accept further input except for an interrupt signal.</P
413 ><P
414 >You can also run the <SPAN
415 CLASS="bold"
416 ><B
417 CLASS="emphasis"
418 >scout</B
419 ></SPAN
420 > program on several machines and view its output on a single
421       machine, by opening telnet connections to the other machines from the central one and initializing the program in each remote
422       window. In this case, you can include the <SPAN
423 CLASS="bold"
424 ><B
425 CLASS="emphasis"
426 >-host</B
427 ></SPAN
428 > flag to the <SPAN
429 CLASS="bold"
430 ><B
431 CLASS="emphasis"
432 >scout</B
433 ></SPAN
434 > command to make the name of each remote machine appear in the <SPAN
435 CLASS="emphasis"
436 ><I
437 CLASS="emphasis"
438 >banner line</I
439 ></SPAN
440 > at
441       the top of the window displaying its output. See <A
442 HREF="c18360.html#HDRWQ330"
443 >The Banner Line</A
444 >.</P
445 ></DIV
446 ><DIV
447 CLASS="sect2"
448 ><H2
449 CLASS="sect2"
450 ><A
451 NAME="HDRWQ328"
452 >Using the -basename argument to Specify a Domain Name</A
453 ></H2
454 ><P
455 >As previously mentioned, the <SPAN
456 CLASS="bold"
457 ><B
458 CLASS="emphasis"
459 >scout</B
460 ></SPAN
461 > program can monitor the File Server process on any
462       number of file server machines. If all of the machines belong to the same cell, then their hostnames probably all have the
463       same domain name suffix, such as <SPAN
464 CLASS="bold"
465 ><B
466 CLASS="emphasis"
467 >abc.com</B
468 ></SPAN
469 > in the ABC Corporation cell. In this case, you can
470       use the <SPAN
471 CLASS="bold"
472 ><B
473 CLASS="emphasis"
474 >-basename</B
475 ></SPAN
476 > argument to the <SPAN
477 CLASS="bold"
478 ><B
479 CLASS="emphasis"
480 >scout</B
481 ></SPAN
482 > command, which has
483       several advantages: <UL
484 ><LI
485 ><P
486 >You can omit the domain name suffix as you enter each file server machine's name on the command line. The
487             <SPAN
488 CLASS="bold"
489 ><B
490 CLASS="emphasis"
491 >scout</B
492 ></SPAN
493 > program automatically appends the domain name to each machine's name, resulting
494             in a fully-qualified hostname. You can omit the domain name suffix even when you don't include the <SPAN
495 CLASS="bold"
496 ><B
497 CLASS="emphasis"
498 >-basename</B
499 ></SPAN
500 > argument, but in that case correct resolution of the name depends on the state of your
501             cell's naming service at the time of connection.</P
502 ></LI
503 ><LI
504 ><P
505 >The machine names are more likely to fit in the appropriate column of the display without having to be truncated
506             (for more on truncating names in the display column, see <A
507 HREF="c18360.html#HDRWQ331"
508 >The Statistics Display
509             Region</A
510 >).</P
511 ></LI
512 ><LI
513 ><P
514 >The domain name appears in the banner line at the top of the display window to indicate the name of the cell you
515             are monitoring.</P
516 ></LI
517 ></UL
518 ></P
519 ></DIV
520 ><DIV
521 CLASS="sect2"
522 ><H2
523 CLASS="sect2"
524 ><A
525 NAME="HDRWQ329"
526 >The Layout of the scout Display</A
527 ></H2
528 ><P
529 >The <SPAN
530 CLASS="bold"
531 ><B
532 CLASS="emphasis"
533 >scout</B
534 ></SPAN
535 > program can display statistics either in a dedicated window or on a plain
536       screen if a windowing environment is not available. For best results, use a window or screen that can print in reverse video
537       and do cursor addressing.</P
538 ><P
539 >The <SPAN
540 CLASS="bold"
541 ><B
542 CLASS="emphasis"
543 >scout</B
544 ></SPAN
545 > program screen has three main regions: the <SPAN
546 CLASS="emphasis"
547 ><I
548 CLASS="emphasis"
549 >banner line</I
550 ></SPAN
551 >,
552       the <SPAN
553 CLASS="emphasis"
554 ><I
555 CLASS="emphasis"
556 >statistics display region</I
557 ></SPAN
558 > and the <SPAN
559 CLASS="emphasis"
560 ><I
561 CLASS="emphasis"
562 >probe/message</I
563 ></SPAN
564 > line. This section describes
565       their contents, and graphic examples appear in <A
566 HREF="c18360.html#HDRWQ336"
567 >Example Commands and Displays</A
568 >.</P
569 ><DIV
570 CLASS="sect3"
571 ><H3
572 CLASS="sect3"
573 ><A
574 NAME="HDRWQ330"
575 >The Banner Line</A
576 ></H3
577 ><P
578 >By default, the string <SAMP
579 CLASS="computeroutput"
580 >scout</SAMP
581 > appears in the banner line at the top of the window or
582         screen, to indicate that the <SPAN
583 CLASS="bold"
584 ><B
585 CLASS="emphasis"
586 >scout</B
587 ></SPAN
588 > program is running. You can display two additional types
589         of information by include the appropriate option on the command line: <UL
590 ><LI
591 ><P
592 >Include the <SPAN
593 CLASS="bold"
594 ><B
595 CLASS="emphasis"
596 >-host</B
597 ></SPAN
598 > flag to display the local machine's name in the banner line.
599               This is particularly useful when you are running the <SPAN
600 CLASS="bold"
601 ><B
602 CLASS="emphasis"
603 >scout</B
604 ></SPAN
605 > program on several
606               machines but displaying the results on a single machine.</P
607 ><P
608 >For example, the following banner line appears when you run the <SPAN
609 CLASS="bold"
610 ><B
611 CLASS="emphasis"
612 >scout</B
613 ></SPAN
614 > program
615               on the machine <SPAN
616 CLASS="bold"
617 ><B
618 CLASS="emphasis"
619 >client1.abc.com</B
620 ></SPAN
621 > and use the<SPAN
622 CLASS="bold"
623 ><B
624 CLASS="emphasis"
625 >-host</B
626 ></SPAN
627 >
628               flag:</P
629 ><PRE
630 CLASS="programlisting"
631 >&#13;   [client1.abc.com] scout
632 </PRE
633 ></LI
634 ><LI
635 ><P
636 >Include the <SPAN
637 CLASS="bold"
638 ><B
639 CLASS="emphasis"
640 >-basename</B
641 ></SPAN
642 > argument to display the specified cell domain name in the
643               banner line. For further discussion, see <A
644 HREF="c18360.html#HDRWQ328"
645 >Using the -basename argument to Specify a Domain
646               Name</A
647 >.</P
648 ><P
649 >For example, if you specify a value of <SPAN
650 CLASS="bold"
651 ><B
652 CLASS="emphasis"
653 >abc.com</B
654 ></SPAN
655 > for the <SPAN
656 CLASS="bold"
657 ><B
658 CLASS="emphasis"
659 >-basename</B
660 ></SPAN
661 > argument, the banner line reads:</P
662 ><PRE
663 CLASS="programlisting"
664 >&#13;   scout for abc.com
665 </PRE
666 ></LI
667 ></UL
668 ></P
669 ></DIV
670 ><DIV
671 CLASS="sect3"
672 ><H3
673 CLASS="sect3"
674 ><A
675 NAME="HDRWQ331"
676 >The Statistics Display Region</A
677 ></H3
678 ><P
679 >The statistics display region occupies most of the window and is divided into six columns. The following list
680         describes them as they appear from left to right in the window. <DIV
681 CLASS="variablelist"
682 ><DL
683 ><DT
684 ><SAMP
685 CLASS="computeroutput"
686 >Conn</SAMP
687 ></DT
688 ><DD
689 ><P
690 >Displays the number of RPC connections open between the File Server process and client machines. This number
691                 normally equals or exceeds the number in the fourth <SAMP
692 CLASS="computeroutput"
693 >Ws</SAMP
694 > column. It can exceed the
695                 number in that column because each user on the machine can have more than one connection open at once, and one
696                 client machine can handle several users.</P
697 ></DD
698 ><DT
699 ><SAMP
700 CLASS="computeroutput"
701 >Fetch</SAMP
702 ></DT
703 ><DD
704 ><P
705 >Displays the number of fetch-type RPCs (fetch data, fetch access list, and fetch status) that the File Server
706                 process has received from client machines since it started. It resets to zero when the File Server process
707                 restarts.</P
708 ></DD
709 ><DT
710 ><SAMP
711 CLASS="computeroutput"
712 >Store</SAMP
713 ></DT
714 ><DD
715 ><P
716 >Displays the number of store-type RPCs (store data, store access list, and store status) that the File Server
717                 process has received from client machines since it started. It resets to zero when the File Server process
718                 restarts.</P
719 ></DD
720 ><DT
721 ><SAMP
722 CLASS="computeroutput"
723 >Ws</SAMP
724 ></DT
725 ><DD
726 ><P
727 >Displays the number of client machines (workstations) that have communicated with the File Server process
728                 within the last 15 minutes (such machines are termed <SPAN
729 CLASS="emphasis"
730 ><I
731 CLASS="emphasis"
732 >active</I
733 ></SPAN
734 >). This number is likely to be
735                 smaller than the number in the <SAMP
736 CLASS="computeroutput"
737 >Conn</SAMP
738 >) column because a single client machine can
739                 have several connections open to one File Server process.</P
740 ></DD
741 ><DT
742 ><SPAN
743 CLASS="bold"
744 ><B
745 CLASS="emphasis"
746 >[Unlabeled column]</B
747 ></SPAN
748 ></DT
749 ><DD
750 ><P
751 >Displays the name of the file server machine on which the File Server process is running. It is 12 characters
752                 wide. Longer names are truncated and an asterisk (<SAMP
753 CLASS="computeroutput"
754 >*</SAMP
755 >) appears as the last character
756                 in the name. If all machines have the same domain name suffix, you can use the <SPAN
757 CLASS="bold"
758 ><B
759 CLASS="emphasis"
760 >-basename</B
761 ></SPAN
762 > argument to decrease the need for truncation; see <A
763 HREF="c18360.html#HDRWQ328"
764 >Using
765                 the -basename argument to Specify a Domain Name</A
766 >.</P
767 ></DD
768 ><DT
769 ><SAMP
770 CLASS="computeroutput"
771 >Disk attn</SAMP
772 ></DT
773 ><DD
774 ><P
775 >Displays the number of kilobyte blocks available on up to 26 of the file server machine's AFS server
776                 (<SPAN
777 CLASS="bold"
778 ><B
779 CLASS="emphasis"
780 >/vicep</B
781 ></SPAN
782 >) partitions. The display for each partition has the following format:
783                 <PRE
784 CLASS="programlisting"
785 >&#13;   partition_letter:free_blocks
786 </PRE
787 ></P
788 ><P
789 >For example, <SAMP
790 CLASS="computeroutput"
791 >a:8949</SAMP
792 > indicates that partition <SPAN
793 CLASS="bold"
794 ><B
795 CLASS="emphasis"
796 >/vicepa</B
797 ></SPAN
798 > has 8,949 KB free. If the window is not wide enough for all partition entries to
799                 appear on a single line, the <SPAN
800 CLASS="bold"
801 ><B
802 CLASS="emphasis"
803 >scout</B
804 ></SPAN
805 > program automatically stacks the partition
806                 entries into subcolumns within the sixth column.</P
807 ><P
808 >The label on the <SAMP
809 CLASS="computeroutput"
810 >Disk attn</SAMP
811 > column indicates the threshold value at which
812                 entries in the column become highlighted. By default, the <SPAN
813 CLASS="bold"
814 ><B
815 CLASS="emphasis"
816 >scout</B
817 ></SPAN
818 > program highlights
819                 a partition that is over 95% full, in which case the label is as follows:</P
820 ><PRE
821 CLASS="programlisting"
822 >&#13;   Disk attn: &#62; 95% used
823 </PRE
824 ><P
825 >For more on this threshold and its effect on highlighting, see <A
826 HREF="c18360.html#HDRWQ332"
827 >Highlighting
828                 Significant Statistics</A
829 >.</P
830 ></DD
831 ></DL
832 ></DIV
833 ></P
834 ><P
835 >For all columns except the fifth (file server machine name), you can use the <SPAN
836 CLASS="bold"
837 ><B
838 CLASS="emphasis"
839 >-attention</B
840 ></SPAN
841 > argument to set a threshold value above which the <SPAN
842 CLASS="bold"
843 ><B
844 CLASS="emphasis"
845 >scout</B
846 ></SPAN
847 >
848         program highlights the statistic. By default, only values in the fifth and sixth columns ever become highlighted. For
849         instructions on using the <SPAN
850 CLASS="bold"
851 ><B
852 CLASS="emphasis"
853 >-attention</B
854 ></SPAN
855 > argument, see <A
856 HREF="c18360.html#HDRWQ332"
857 >Highlighting
858         Significant Statistics</A
859 >.</P
860 ></DIV
861 ><DIV
862 CLASS="sect3"
863 ><H3
864 CLASS="sect3"
865 ><A
866 NAME="Header_368"
867 >The Probe Reporting Line</A
868 ></H3
869 ><P
870 >The bottom line of the display indicates how many times the <SPAN
871 CLASS="bold"
872 ><B
873 CLASS="emphasis"
874 >scout</B
875 ></SPAN
876 > program has probed
877         the File Server processes for statistics. The statistics gathered in the latest probe appear in the statistics display
878         region. By default, the <SPAN
879 CLASS="bold"
880 ><B
881 CLASS="emphasis"
882 >scout</B
883 ></SPAN
884 > program probes the File Servers every 60 seconds, but you can
885         use the <SPAN
886 CLASS="bold"
887 ><B
888 CLASS="emphasis"
889 >-frequency</B
890 ></SPAN
891 > argument to specify a different probe frequency.</P
892 ></DIV
893 ></DIV
894 ><DIV
895 CLASS="sect2"
896 ><H2
897 CLASS="sect2"
898 ><A
899 NAME="HDRWQ332"
900 >Highlighting Significant Statistics</A
901 ></H2
902 ><P
903 >To draw your attention to a statistic that currently exceed a threshold value, the <SPAN
904 CLASS="bold"
905 ><B
906 CLASS="emphasis"
907 >scout</B
908 ></SPAN
909 > program displays it in reverse video (highlights it). You can set the threshold value for most
910       statistics, and so determine which values are worthy of special attention and which are normal.</P
911 ><DIV
912 CLASS="sect3"
913 ><H3
914 CLASS="sect3"
915 ><A
916 NAME="HDRWQ333"
917 >Highlighting Server Outages</A
918 ></H3
919 ><P
920 >The only column in which you cannot control highlighting is the fifth, which identifies the file server machine for
921         which statistics are displayed in the other columns. The <SPAN
922 CLASS="bold"
923 ><B
924 CLASS="emphasis"
925 >scout</B
926 ></SPAN
927 > program uses highlighting in
928         this column to indicate that the File Server process on a machine fails to respond to its probe, and automatically blanks
929         out the other columns. Failure to respond to the probe can indicate a File Server process, file server machine, or network
930         outage, so the highlighting draws your attention to a situation that is probably interrupting service to users.</P
931 ><P
932 >When the File Server process once again responds to the probes, its name appears normally and statistics reappear in
933         the other columns. If all machine names become highlighted at once, a possible network outage has disrupted the connection
934         between the file server machines and the client machine running the <SPAN
935 CLASS="bold"
936 ><B
937 CLASS="emphasis"
938 >scout</B
939 ></SPAN
940 > program.</P
941 ></DIV
942 ><DIV
943 CLASS="sect3"
944 ><H3
945 CLASS="sect3"
946 ><A
947 NAME="Header_371"
948 >Highlighting for Extreme Statistic Values</A
949 ></H3
950 ><P
951 >To set the threshold value for one or more of the five statistics-displaying columns, use the <SPAN
952 CLASS="bold"
953 ><B
954 CLASS="emphasis"
955 >-attention</B
956 ></SPAN
957 > argument. The threshold value applies to all File Server processes you are monitoring (you
958         cannot set different thresholds for different machines). For details, see the syntax description in <A
959 HREF="c18360.html#HDRWQ335"
960 >To start the scout program</A
961 >.</P
962 ><P
963 >It is not possible to change the threshold values for a running <SPAN
964 CLASS="bold"
965 ><B
966 CLASS="emphasis"
967 >scout</B
968 ></SPAN
969 > program. Stop
970         the current program and start a new one. Also, the <SPAN
971 CLASS="bold"
972 ><B
973 CLASS="emphasis"
974 >scout</B
975 ></SPAN
976 > program does not retain threshold
977         values across restarts, so you must specify all thresholds every time you start the program.</P
978 ></DIV
979 ></DIV
980 ><DIV
981 CLASS="sect2"
982 ><H2
983 CLASS="sect2"
984 ><A
985 NAME="HDRWQ334"
986 >Resizing the scout Display</A
987 ></H2
988 ><P
989 >Do not resize the display window while the <SPAN
990 CLASS="bold"
991 ><B
992 CLASS="emphasis"
993 >scout</B
994 ></SPAN
995 > program is running. Increasing the
996       size does no harm, but the <SPAN
997 CLASS="bold"
998 ><B
999 CLASS="emphasis"
1000 >scout</B
1001 ></SPAN
1002 > program does not necessarily adjust to the new dimensions.
1003       Decreasing the display's width can disturb column alignment, making the display harder to read. With any type of resizing, the
1004       <SPAN
1005 CLASS="bold"
1006 ><B
1007 CLASS="emphasis"
1008 >scout</B
1009 ></SPAN
1010 > program does not adjust the display in any way until it displays the results of the
1011       next probe.</P
1012 ><P
1013 >To resize the display effectively, stop the <SPAN
1014 CLASS="bold"
1015 ><B
1016 CLASS="emphasis"
1017 >scout</B
1018 ></SPAN
1019 > program, resize the window and then
1020       restart the program. Even in this case, the <SPAN
1021 CLASS="bold"
1022 ><B
1023 CLASS="emphasis"
1024 >scout</B
1025 ></SPAN
1026 > program's response depends on the accuracy
1027       of the information it receives from the display environment. Testing during development has shown that the display environment
1028       does not reliably provide information about window resizing. If you use the X windowing system, issuing the following sequence
1029       of commands before starting the <SPAN
1030 CLASS="bold"
1031 ><B
1032 CLASS="emphasis"
1033 >scout</B
1034 ></SPAN
1035 > program (or placing them in the shell initialization
1036       file) sometimes makes it adjust properly to resizing.</P
1037 ><PRE
1038 CLASS="programlisting"
1039 >&#13;   % <SPAN
1040 CLASS="bold"
1041 ><B
1042 CLASS="emphasis"
1043 >set noglob</B
1044 ></SPAN
1045 >
1046    % <SPAN
1047 CLASS="bold"
1048 ><B
1049 CLASS="emphasis"
1050 >eval '/usr/bin/X11/resize'</B
1051 ></SPAN
1052
1053    % <SPAN
1054 CLASS="bold"
1055 ><B
1056 CLASS="emphasis"
1057 >unset noglob</B
1058 ></SPAN
1059 >
1060 </PRE
1061 ></DIV
1062 ><DIV
1063 CLASS="sect2"
1064 ><H2
1065 CLASS="sect2"
1066 ><A
1067 NAME="HDRWQ335"
1068 >To start the scout program</A
1069 ></H2
1070 ><OL
1071 TYPE="1"
1072 ><LI
1073 ><P
1074 >Open a dedicated command shell. If necessary, adjust it to the appropriate size.</P
1075 ></LI
1076 ><LI
1077 ><P
1078 >Issue the <SPAN
1079 CLASS="bold"
1080 ><B
1081 CLASS="emphasis"
1082 >scout</B
1083 ></SPAN
1084 > command to start the program. <PRE
1085 CLASS="programlisting"
1086 >&#13;   % <SPAN
1087 CLASS="bold"
1088 ><B
1089 CLASS="emphasis"
1090 >scout</B
1091 ></SPAN
1092 >  [<SPAN
1093 CLASS="bold"
1094 ><B
1095 CLASS="emphasis"
1096 >initcmd</B
1097 ></SPAN
1098 >]  <SPAN
1099 CLASS="bold"
1100 ><B
1101 CLASS="emphasis"
1102 >-server</B
1103 ></SPAN
1104 > &#60;<VAR
1105 CLASS="replaceable"
1106 >FileServer name(s) to monitor</VAR
1107 >&#62;+  \
1108             [<SPAN
1109 CLASS="bold"
1110 ><B
1111 CLASS="emphasis"
1112 >-basename</B
1113 ></SPAN
1114 > &#60;<VAR
1115 CLASS="replaceable"
1116 >base server name</VAR
1117 >&#62;]  \
1118             [<SPAN
1119 CLASS="bold"
1120 ><B
1121 CLASS="emphasis"
1122 >-frequency</B
1123 ></SPAN
1124 > &#60;<VAR
1125 CLASS="replaceable"
1126 >poll frequency, in seconds</VAR
1127 >&#62;] [<SPAN
1128 CLASS="bold"
1129 ><B
1130 CLASS="emphasis"
1131 >-host</B
1132 ></SPAN
1133 >]  \
1134             [<SPAN
1135 CLASS="bold"
1136 ><B
1137 CLASS="emphasis"
1138 >-attention</B
1139 ></SPAN
1140 > &#60;<VAR
1141 CLASS="replaceable"
1142 >specify attention (highlighting) level</VAR
1143 >&#62;+]  \
1144             [<SPAN
1145 CLASS="bold"
1146 ><B
1147 CLASS="emphasis"
1148 >-debug</B
1149 ></SPAN
1150 > &#60;<VAR
1151 CLASS="replaceable"
1152 >turn debugging output on to the named file</VAR
1153 >&#62;]
1154 </PRE
1155 ></P
1156 ><P
1157 >where <DIV
1158 CLASS="variablelist"
1159 ><DL
1160 ><DT
1161 ><SPAN
1162 CLASS="bold"
1163 ><B
1164 CLASS="emphasis"
1165 >initcmd</B
1166 ></SPAN
1167 ></DT
1168 ><DD
1169 ><P
1170 >Is an optional string that accommodates the command's use of the AFS command parser. It can be omitted and
1171                   ignored.</P
1172 ></DD
1173 ><DT
1174 ><SPAN
1175 CLASS="bold"
1176 ><B
1177 CLASS="emphasis"
1178 >-server</B
1179 ></SPAN
1180 ></DT
1181 ><DD
1182 ><P
1183 >Identifies each File Server process to monitor, by naming the file server machine it is running on. Provide
1184                   fully-qualified hostnames unless the <SPAN
1185 CLASS="bold"
1186 ><B
1187 CLASS="emphasis"
1188 >-basename</B
1189 ></SPAN
1190 > argument is used. In that case,
1191                   specify only the initial part of each machine name, omitting the domain name suffix common to all the machine
1192                   names.</P
1193 ></DD
1194 ><DT
1195 ><SPAN
1196 CLASS="bold"
1197 ><B
1198 CLASS="emphasis"
1199 >-basename</B
1200 ></SPAN
1201 ></DT
1202 ><DD
1203 ><P
1204 >Specifies the domain name suffix common to all of the file server machines named by the <SPAN
1205 CLASS="bold"
1206 ><B
1207 CLASS="emphasis"
1208 >-server</B
1209 ></SPAN
1210 > argument. For discussion of this argument's effects, see <A
1211 HREF="c18360.html#HDRWQ328"
1212 >Using the -basename argument to Specify a Domain Name</A
1213 >.</P
1214 ><P
1215 >Do not include the period that separates the domain suffix from the initial part of the machine name, but do
1216                   include any periods that occur within the suffix itself. (For example, in the ABC Corporation cell, the proper
1217                   value is <SPAN
1218 CLASS="bold"
1219 ><B
1220 CLASS="emphasis"
1221 >abc.com</B
1222 ></SPAN
1223 >, not <SPAN
1224 CLASS="bold"
1225 ><B
1226 CLASS="emphasis"
1227 >.abc.com</B
1228 ></SPAN
1229 >.)</P
1230 ></DD
1231 ><DT
1232 ><SPAN
1233 CLASS="bold"
1234 ><B
1235 CLASS="emphasis"
1236 >-frequency</B
1237 ></SPAN
1238 ></DT
1239 ><DD
1240 ><P
1241 >Sets the frequency, in seconds, of the <SPAN
1242 CLASS="bold"
1243 ><B
1244 CLASS="emphasis"
1245 >scout</B
1246 ></SPAN
1247 > program's probes to File
1248                   Server processes. Specify an integer greater than 0 (zero). The default is 60 seconds.</P
1249 ></DD
1250 ><DT
1251 ><SPAN
1252 CLASS="bold"
1253 ><B
1254 CLASS="emphasis"
1255 >-host</B
1256 ></SPAN
1257 ></DT
1258 ><DD
1259 ><P
1260 >Displays the name of the machine that is running the <SPAN
1261 CLASS="bold"
1262 ><B
1263 CLASS="emphasis"
1264 >scout</B
1265 ></SPAN
1266 > program in the
1267                   display window's banner line. By default, no machine name is displayed.</P
1268 ></DD
1269 ><DT
1270 ><SPAN
1271 CLASS="bold"
1272 ><B
1273 CLASS="emphasis"
1274 >-attention</B
1275 ></SPAN
1276 ></DT
1277 ><DD
1278 ><P
1279 >Defines the threshold value at which to highlight one or more statistics. You can provide the pairs of
1280                   statistic and threshold in any order, separating each pair and the parts of each pair with one or more spaces. The
1281                   following list defines the syntax for each statistic.<DIV
1282 CLASS="variablelist"
1283 ><DL
1284 ><DT
1285 ><SPAN
1286 CLASS="bold"
1287 ><B
1288 CLASS="emphasis"
1289 >conn connections</B
1290 ></SPAN
1291 ></DT
1292 ><DD
1293 ><P
1294 >Highlights the value in the <SAMP
1295 CLASS="computeroutput"
1296 >Conn</SAMP
1297 > (first) column when the number of
1298                           connections that the File Server has open to client machines exceeds the connections value. The
1299                           highlighting deactivates when the value goes back below the threshold. There is no default
1300                           threshold.</P
1301 ></DD
1302 ><DT
1303 ><SPAN
1304 CLASS="bold"
1305 ><B
1306 CLASS="emphasis"
1307 >fetch fetch_RPCs</B
1308 ></SPAN
1309 ></DT
1310 ><DD
1311 ><P
1312 >Highlights the value in the <SAMP
1313 CLASS="computeroutput"
1314 >Fetch</SAMP
1315 > (second) column when the number
1316                           of fetch RPCs that clients have made to the File Server process exceeds the fetch_RPCs value. The
1317                           highlighting deactivates only when the File Server process restarts, at which time the value returns to
1318                           zero. There is no default threshold.</P
1319 ></DD
1320 ><DT
1321 ><SPAN
1322 CLASS="bold"
1323 ><B
1324 CLASS="emphasis"
1325 >store store_RPCs</B
1326 ></SPAN
1327 ></DT
1328 ><DD
1329 ><P
1330 >Highlights the value in the <SAMP
1331 CLASS="computeroutput"
1332 >Store</SAMP
1333 > (third) column when the number of
1334                           store RPCs that clients have made to the File Server process exceeds the store_RPCs value. The
1335                           highlighting deactivates only when the File Server process restarts, at which time the value returns to
1336                           zero. There is no default threshold.</P
1337 ></DD
1338 ><DT
1339 ><SPAN
1340 CLASS="bold"
1341 ><B
1342 CLASS="emphasis"
1343 >ws active_clients</B
1344 ></SPAN
1345 ></DT
1346 ><DD
1347 ><P
1348 >Highlights the value in the <SAMP
1349 CLASS="computeroutput"
1350 >Ws</SAMP
1351 > (fourth) column when the number of
1352                           active client machines (those that have contacted the File Server in the last 15 minutes) exceeds the
1353                           active_clients value. The highlighting deactivates when the value goes back below the threshold. There is
1354                           no default threshold.</P
1355 ></DD
1356 ><DT
1357 ><SPAN
1358 CLASS="bold"
1359 ><B
1360 CLASS="emphasis"
1361 >disk percent_full % or disk min_blocks</B
1362 ></SPAN
1363 ></DT
1364 ><DD
1365 ><P
1366 >Highlights the value for a partition in the <SAMP
1367 CLASS="computeroutput"
1368 >Disk attn</SAMP
1369 > (sixth)
1370                           column when either the amount of disk space used exceeds the percentage indicated by thepercent_full
1371                           value, or the number of free KB blocks is less than the min_blocks value. The highlighting deactivates
1372                           when the value goes back below the percent_full threshold or above the min_blocks threshold.</P
1373 ><P
1374 >The value you specify appears in the header of the sixth column following the string
1375                           <SAMP
1376 CLASS="computeroutput"
1377 >Disk attn</SAMP
1378 >. The default threshold is 95% full.</P
1379 ><P
1380 >Acceptable values for percent_full are the integers from the range <SPAN
1381 CLASS="bold"
1382 ><B
1383 CLASS="emphasis"
1384 >0</B
1385 ></SPAN
1386 > (zero) to <SPAN
1387 CLASS="bold"
1388 ><B
1389 CLASS="emphasis"
1390 >99</B
1391 ></SPAN
1392 >, and you must include the percent
1393                           sign to distinguish this statistic from a min_blocks value..</P
1394 ></DD
1395 ></DL
1396 ></DIV
1397 ></P
1398 ><P
1399 >The following example sets the threshold for the <SAMP
1400 CLASS="computeroutput"
1401 >Conn</SAMP
1402 > column to 100, for
1403                   the <SAMP
1404 CLASS="computeroutput"
1405 >Ws</SAMP
1406 > column to 50, and for the <SAMP
1407 CLASS="computeroutput"
1408 >Disk attn</SAMP
1409 >
1410                   column to 75%. There is no threshold for the <SAMP
1411 CLASS="computeroutput"
1412 >Fetch</SAMP
1413 > and
1414                   <SAMP
1415 CLASS="computeroutput"
1416 >Store</SAMP
1417 > columns.</P
1418 ><P
1419 ><SPAN
1420 CLASS="bold"
1421 ><B
1422 CLASS="emphasis"
1423 >-attention conn 100 ws 50 disk 75%</B
1424 ></SPAN
1425 ></P
1426 ><P
1427 >The following example has the same affect as the previous one except that it sets the threshold for the Disk
1428                   attn column to 5000 free KB blocks:</P
1429 ><P
1430 ><SPAN
1431 CLASS="bold"
1432 ><B
1433 CLASS="emphasis"
1434 >-attention disk 5000 ws 50 conn 100</B
1435 ></SPAN
1436 ></P
1437 ></DD
1438 ><DT
1439 ><SPAN
1440 CLASS="bold"
1441 ><B
1442 CLASS="emphasis"
1443 >-debug</B
1444 ></SPAN
1445 ></DT
1446 ><DD
1447 ><P
1448 >Enables debugging output and directs it into the specified file. Partial pathnames are interpreted relative
1449                   to the current working directory. By default, no debugging output is produced.</P
1450 ></DD
1451 ></DL
1452 ></DIV
1453 ></P
1454 ></LI
1455 ></OL
1456 ></DIV
1457 ><DIV
1458 CLASS="sect2"
1459 ><H2
1460 CLASS="sect2"
1461 ><A
1462 NAME="Header_374"
1463 >To stop the scout program</A
1464 ></H2
1465 ><OL
1466 TYPE="1"
1467 ><LI
1468 ><P
1469 >Enter <SPAN
1470 CLASS="bold"
1471 ><B
1472 CLASS="emphasis"
1473 >Ctrl-c</B
1474 ></SPAN
1475 > in the display window. This is the proper interrupt signal even if the
1476           general interrupt signal in your environment is different.</P
1477 ></LI
1478 ></OL
1479 ></DIV
1480 ><DIV
1481 CLASS="sect2"
1482 ><H2
1483 CLASS="sect2"
1484 ><A
1485 NAME="HDRWQ336"
1486 >Example Commands and Displays</A
1487 ></H2
1488 ><P
1489 >This section presents examples of the <SPAN
1490 CLASS="bold"
1491 ><B
1492 CLASS="emphasis"
1493 >scout</B
1494 ></SPAN
1495 > program, combining different arguments and
1496       illustrating the screen displays that result.</P
1497 ><P
1498 >In the first example, an administrator in the ABC Corporation issues the <SPAN
1499 CLASS="bold"
1500 ><B
1501 CLASS="emphasis"
1502 >scout</B
1503 ></SPAN
1504 > command
1505       without providing any optional arguments or flags. She includes the <SPAN
1506 CLASS="bold"
1507 ><B
1508 CLASS="emphasis"
1509 >-server</B
1510 ></SPAN
1511 > argument because
1512       she is providing multiple machine names. She chooses to specify on the initial part of each machine's name even though she has
1513       not used the <SPAN
1514 CLASS="bold"
1515 ><B
1516 CLASS="emphasis"
1517 >-basename</B
1518 ></SPAN
1519 > argument, relying on the cell's name service to obtain the
1520       fully-qualified name that the <SPAN
1521 CLASS="bold"
1522 ><B
1523 CLASS="emphasis"
1524 >scout</B
1525 ></SPAN
1526 > program requires for establishing a connection.</P
1527 ><PRE
1528 CLASS="programlisting"
1529 >&#13;   % <SPAN
1530 CLASS="bold"
1531 ><B
1532 CLASS="emphasis"
1533 >scout -server fs1 fs2</B
1534 ></SPAN
1535
1536 </PRE
1537 ><P
1538 ><A
1539 HREF="c18360.html#FIGWQ337"
1540 >Figure 2</A
1541 > depicts the resulting display. Notice first that the machine names in the fifth
1542       (unlabeled) column appear in the format the administrator used on the command line. Now consider the second line in the
1543       display region, where the machine name <SAMP
1544 CLASS="computeroutput"
1545 >fs2</SAMP
1546 > appears in the fifth column. The
1547       <SAMP
1548 CLASS="computeroutput"
1549 >Conn</SAMP
1550 > and <SAMP
1551 CLASS="computeroutput"
1552 >Ws</SAMP
1553 > columns together show that machine <SPAN
1554 CLASS="bold"
1555 ><B
1556 CLASS="emphasis"
1557 >fs2</B
1558 ></SPAN
1559 > has 144 RPC connections open to 44 client machines, demonstrating that multiple connections per
1560       client machine are possible. The <SAMP
1561 CLASS="computeroutput"
1562 >Fetch</SAMP
1563 > column shows that client machines have made 2,734,278
1564       fetch RPCs to machine <SPAN
1565 CLASS="bold"
1566 ><B
1567 CLASS="emphasis"
1568 >fs2</B
1569 ></SPAN
1570 > since the File Server process last started and the
1571       <SAMP
1572 CLASS="computeroutput"
1573 >Store</SAMP
1574 > column shows that they have made 34,066 store RPCs.</P
1575 ><P
1576 >Six partition entries appear in the <SAMP
1577 CLASS="computeroutput"
1578 >Disk attn</SAMP
1579 > column, marked
1580       <SAMP
1581 CLASS="computeroutput"
1582 >a</SAMP
1583 > through <SAMP
1584 CLASS="computeroutput"
1585 >f</SAMP
1586 > (for <SPAN
1587 CLASS="bold"
1588 ><B
1589 CLASS="emphasis"
1590 >/vicepa</B
1591 ></SPAN
1592 >
1593       through <SPAN
1594 CLASS="bold"
1595 ><B
1596 CLASS="emphasis"
1597 >/vicepf</B
1598 ></SPAN
1599 >). They appear on three lines in two subcolumns because of the width of the
1600       window; if the window is wider, there are more subcolumns. Four of the partition entries (<SAMP
1601 CLASS="computeroutput"
1602 >a</SAMP
1603 >,
1604       <SAMP
1605 CLASS="computeroutput"
1606 >c</SAMP
1607 >, <SAMP
1608 CLASS="computeroutput"
1609 >d</SAMP
1610 >, and <SAMP
1611 CLASS="computeroutput"
1612 >e</SAMP
1613 >) appear in
1614       reverse video to indicate that they are more than 95% full (the threshold value that appears in the <SAMP
1615 CLASS="computeroutput"
1616 >Disk
1617       attn</SAMP
1618 > header).</P
1619 ><DIV
1620 CLASS="figure"
1621 ><A
1622 NAME="FIGWQ337"
1623 ></A
1624 ><DIV
1625 CLASS="mediaobject"
1626 ><P
1627 ><IMG
1628 SRC="scout1.png"></P
1629 ></DIV
1630 ><P
1631 ><B
1632 >Figure 2. First example scout display</B
1633 ></P
1634 ></DIV
1635 ><P
1636 ><SPAN
1637 CLASS="bold"
1638 ><B
1639 CLASS="emphasis"
1640 > </B
1641 ></SPAN
1642 ></P
1643 ><P
1644 >In the second example, the administrator uses more of the <SPAN
1645 CLASS="bold"
1646 ><B
1647 CLASS="emphasis"
1648 >scout</B
1649 ></SPAN
1650 > program's optional
1651       arguments. <UL
1652 ><LI
1653 ><P
1654 >She provides the machine names in the same form as in Example 1, but this time she also uses the <SPAN
1655 CLASS="bold"
1656 ><B
1657 CLASS="emphasis"
1658 >-basename</B
1659 ></SPAN
1660 > argument to specify their domain name suffix, <SPAN
1661 CLASS="bold"
1662 ><B
1663 CLASS="emphasis"
1664 >abc.com</B
1665 ></SPAN
1666 >.
1667             This implies that the <SPAN
1668 CLASS="bold"
1669 ><B
1670 CLASS="emphasis"
1671 >scout</B
1672 ></SPAN
1673 > program does not need the name service to expand the names
1674             to fully-qualified hostnames, but the name service still converts the hostnames to IP addresses.</P
1675 ></LI
1676 ><LI
1677 ><P
1678 >She uses the <SPAN
1679 CLASS="bold"
1680 ><B
1681 CLASS="emphasis"
1682 >-host</B
1683 ></SPAN
1684 > flag to display in the banner line the name of the client
1685             machine where the <SPAN
1686 CLASS="bold"
1687 ><B
1688 CLASS="emphasis"
1689 >scout</B
1690 ></SPAN
1691 > program is running.</P
1692 ></LI
1693 ><LI
1694 ><P
1695 >She uses the <SPAN
1696 CLASS="bold"
1697 ><B
1698 CLASS="emphasis"
1699 >-frequency</B
1700 ></SPAN
1701 > argument to changes the probing frequency from its
1702             default of once per minute to once every five seconds.</P
1703 ></LI
1704 ><LI
1705 ><P
1706 >She uses the <SPAN
1707 CLASS="bold"
1708 ><B
1709 CLASS="emphasis"
1710 >-attention</B
1711 ></SPAN
1712 > argument to changes the highlighting threshold for
1713             partitions to a 5000 KB minimum rather than the default of 95% full.</P
1714 ></LI
1715 ></UL
1716 ></P
1717 ><PRE
1718 CLASS="programlisting"
1719 >&#13;   % <SPAN
1720 CLASS="bold"
1721 ><B
1722 CLASS="emphasis"
1723 >scout -server fs1 fs2 -basename abc.com -host -frequency 5 -attention disk 5000</B
1724 ></SPAN
1725
1726 </PRE
1727 ><P
1728 >The use of optional arguments results in several differences between <A
1729 HREF="c18360.html#FIGWQ338"
1730 >Figure 3</A
1731 > and <A
1732 HREF="c18360.html#FIGWQ337"
1733 >Figure 2</A
1734 >. First, because the <SPAN
1735 CLASS="bold"
1736 ><B
1737 CLASS="emphasis"
1738 >-host</B
1739 ></SPAN
1740 > flag is included, the banner
1741       line displays the name of the machine running the <SPAN
1742 CLASS="bold"
1743 ><B
1744 CLASS="emphasis"
1745 >scout</B
1746 ></SPAN
1747 > process as
1748       <SAMP
1749 CLASS="computeroutput"
1750 >[client52]</SAMP
1751 > along with the basename <SAMP
1752 CLASS="computeroutput"
1753 >abc.com</SAMP
1754 > specified with
1755       the <SPAN
1756 CLASS="bold"
1757 ><B
1758 CLASS="emphasis"
1759 >-basename</B
1760 ></SPAN
1761 > argument.</P
1762 ><P
1763 >Another difference is that two rather than four of machine <SPAN
1764 CLASS="bold"
1765 ><B
1766 CLASS="emphasis"
1767 >fs2</B
1768 ></SPAN
1769 >'s partitions appear in
1770       reverse video, even though their values are almost the same as in <A
1771 HREF="c18360.html#FIGWQ337"
1772 >Figure 2</A
1773 >. This is because
1774       the administrator changed the highlight threshold to a 5000 block minimum, as also reflected in the <SAMP
1775 CLASS="computeroutput"
1776 >Disk
1777       attn</SAMP
1778 > column's header. And while machine <SPAN
1779 CLASS="bold"
1780 ><B
1781 CLASS="emphasis"
1782 >fs2</B
1783 ></SPAN
1784 >'s partitions <SPAN
1785 CLASS="bold"
1786 ><B
1787 CLASS="emphasis"
1788 >/vicepa</B
1789 ></SPAN
1790 > and <SPAN
1791 CLASS="bold"
1792 ><B
1793 CLASS="emphasis"
1794 >/vicepd</B
1795 ></SPAN
1796 > are still 95% full, they have more than 5000 free
1797       blocks left; partitions <SPAN
1798 CLASS="bold"
1799 ><B
1800 CLASS="emphasis"
1801 >/vicepc</B
1802 ></SPAN
1803 > and <SPAN
1804 CLASS="bold"
1805 ><B
1806 CLASS="emphasis"
1807 >/vicepe</B
1808 ></SPAN
1809 > are highlighted
1810       because they have fewer than 5000 blocks free.</P
1811 ><P
1812 >Note also the result of changing the probe frequency, reflected in the probe reporting line at the bottom left corner of
1813       the display. Both this example and the previous one represent a time lapse of one minute after the administrator issues the
1814       <SPAN
1815 CLASS="bold"
1816 ><B
1817 CLASS="emphasis"
1818 >scout</B
1819 ></SPAN
1820 > command. In this example, however, the <SPAN
1821 CLASS="bold"
1822 ><B
1823 CLASS="emphasis"
1824 >scout</B
1825 ></SPAN
1826 > program
1827       has probed the File Server processes 12 times as opposed to once</P
1828 ><DIV
1829 CLASS="figure"
1830 ><A
1831 NAME="FIGWQ338"
1832 ></A
1833 ><DIV
1834 CLASS="mediaobject"
1835 ><P
1836 ><IMG
1837 SRC="scout2.png"></P
1838 ></DIV
1839 ><P
1840 ><B
1841 >Figure 3. Second example scout display</B
1842 ></P
1843 ></DIV
1844 ><P
1845 ><SPAN
1846 CLASS="bold"
1847 ><B
1848 CLASS="emphasis"
1849 > </B
1850 ></SPAN
1851 ></P
1852 ><P
1853 >In <A
1854 HREF="c18360.html#FIGWQ339"
1855 >Figure 4</A
1856 >, an administrator in the State University cell monitors three of that cell's
1857       file server machines. He uses the <SPAN
1858 CLASS="bold"
1859 ><B
1860 CLASS="emphasis"
1861 >-basename</B
1862 ></SPAN
1863 > argument to specify the <SPAN
1864 CLASS="bold"
1865 ><B
1866 CLASS="emphasis"
1867 >stateu.edu</B
1868 ></SPAN
1869 > domain name.</P
1870 ><PRE
1871 CLASS="programlisting"
1872 >&#13;   % <SPAN
1873 CLASS="bold"
1874 ><B
1875 CLASS="emphasis"
1876 >scout -server server2 server3 server4 -basename stateu.edu</B
1877 ></SPAN
1878
1879 </PRE
1880 ><DIV
1881 CLASS="figure"
1882 ><A
1883 NAME="FIGWQ339"
1884 ></A
1885 ><DIV
1886 CLASS="mediaobject"
1887 ><P
1888 ><IMG
1889 SRC="scout3.png"></P
1890 ></DIV
1891 ><P
1892 ><B
1893 >Figure 4. Third example scout display</B
1894 ></P
1895 ></DIV
1896 ><P
1897 ><SPAN
1898 CLASS="bold"
1899 ><B
1900 CLASS="emphasis"
1901 > </B
1902 ></SPAN
1903 ></P
1904 ><P
1905 ><A
1906 HREF="c18360.html#FIGWQ340"
1907 >Figure 5</A
1908 > illustrates three of the <SPAN
1909 CLASS="bold"
1910 ><B
1911 CLASS="emphasis"
1912 >scout</B
1913 ></SPAN
1914 > program's
1915       features. First, you can monitor file server machines from different cells in a single display: <SPAN
1916 CLASS="bold"
1917 ><B
1918 CLASS="emphasis"
1919 >fs1.abc.com</B
1920 ></SPAN
1921 >, <SPAN
1922 CLASS="bold"
1923 ><B
1924 CLASS="emphasis"
1925 >server3.stateu.edu</B
1926 ></SPAN
1927 >, and <SPAN
1928 CLASS="bold"
1929 ><B
1930 CLASS="emphasis"
1931 >sv7.def.com</B
1932 ></SPAN
1933 >. Because the machines belong to different cells, it is not possible to provide the
1934       <SPAN
1935 CLASS="bold"
1936 ><B
1937 CLASS="emphasis"
1938 >-basename</B
1939 ></SPAN
1940 > argument.</P
1941 ><P
1942 >Second, it illustrates how the display must truncate machine names that do not fit in the fifth column, using an
1943       asterisk at the end of the name to show that it is shortened.</P
1944 ><P
1945 >Third, it illustrates what happens when the <SPAN
1946 CLASS="bold"
1947 ><B
1948 CLASS="emphasis"
1949 >scout</B
1950 ></SPAN
1951 > process cannot reach a File Server
1952       process, in this case the one on the machine <SPAN
1953 CLASS="bold"
1954 ><B
1955 CLASS="emphasis"
1956 >sv7.def.com</B
1957 ></SPAN
1958 >: it highlights the machine name and
1959       blanks out the values in the other columns.</P
1960 ><DIV
1961 CLASS="figure"
1962 ><A
1963 NAME="FIGWQ340"
1964 ></A
1965 ><DIV
1966 CLASS="mediaobject"
1967 ><P
1968 ><IMG
1969 SRC="scout4.png"></P
1970 ></DIV
1971 ><P
1972 ><B
1973 >Figure 5. Fourth example scout display</B
1974 ></P
1975 ></DIV
1976 ></DIV
1977 ></DIV
1978 ><DIV
1979 CLASS="sect1"
1980 ><H1
1981 CLASS="sect1"
1982 ><A
1983 NAME="HDRWQ341"
1984 >Using the fstrace Command Suite</A
1985 ></H1
1986 ><P
1987 >This section describes the <SPAN
1988 CLASS="bold"
1989 ><B
1990 CLASS="emphasis"
1991 >fstrace</B
1992 ></SPAN
1993 > commands that system administrators employ to trace
1994     Cache Manager activity for debugging purposes. It assumes the reader is familiar with the Cache Manager concepts described in
1995     <A
1996 HREF="c21473.html"
1997 >Administering Client Machines and the Cache Manager</A
1998 >.</P
1999 ><P
2000 >The <SPAN
2001 CLASS="bold"
2002 ><B
2003 CLASS="emphasis"
2004 >fstrace</B
2005 ></SPAN
2006 > command suite monitors the internal activity of the Cache Manager and enables
2007     you to record, or trace, its operations in detail. The operations, which are termed <SPAN
2008 CLASS="emphasis"
2009 ><I
2010 CLASS="emphasis"
2011 >events</I
2012 ></SPAN
2013 >, comprise the
2014     <SPAN
2015 CLASS="bold"
2016 ><B
2017 CLASS="emphasis"
2018 >cm</B
2019 ></SPAN
2020 > <SPAN
2021 CLASS="emphasis"
2022 ><I
2023 CLASS="emphasis"
2024 >event set</I
2025 ></SPAN
2026 >. Examples of <SPAN
2027 CLASS="bold"
2028 ><B
2029 CLASS="emphasis"
2030 >cm</B
2031 ></SPAN
2032 > events are
2033     fetching files and looking up information for a listing of files and subdirectories using the UNIX <SPAN
2034 CLASS="bold"
2035 ><B
2036 CLASS="emphasis"
2037 >ls</B
2038 ></SPAN
2039 > command.</P
2040 ><P
2041 >Following are the <SPAN
2042 CLASS="bold"
2043 ><B
2044 CLASS="emphasis"
2045 >fstrace</B
2046 ></SPAN
2047 > commands and their respective functions: <UL
2048 ><LI
2049 ><P
2050 >The <SPAN
2051 CLASS="bold"
2052 ><B
2053 CLASS="emphasis"
2054 >fstrace apropos</B
2055 ></SPAN
2056 > command provides a short description of commands.</P
2057 ></LI
2058 ><LI
2059 ><P
2060 >The <SPAN
2061 CLASS="bold"
2062 ><B
2063 CLASS="emphasis"
2064 >fstrace clear</B
2065 ></SPAN
2066 > command clears the trace log.</P
2067 ></LI
2068 ><LI
2069 ><P
2070 >The <SPAN
2071 CLASS="bold"
2072 ><B
2073 CLASS="emphasis"
2074 >fstrace dump</B
2075 ></SPAN
2076 > command dumps the contents of the trace log.</P
2077 ></LI
2078 ><LI
2079 ><P
2080 >The <SPAN
2081 CLASS="bold"
2082 ><B
2083 CLASS="emphasis"
2084 >fstrace help</B
2085 ></SPAN
2086 > command provides a description and syntax for commands.</P
2087 ></LI
2088 ><LI
2089 ><P
2090 >The <SPAN
2091 CLASS="bold"
2092 ><B
2093 CLASS="emphasis"
2094 >fstrace lslog</B
2095 ></SPAN
2096 > command lists information about the trace log.</P
2097 ></LI
2098 ><LI
2099 ><P
2100 >The <SPAN
2101 CLASS="bold"
2102 ><B
2103 CLASS="emphasis"
2104 >fstrace lsset</B
2105 ></SPAN
2106 > command lists information about the event set.</P
2107 ></LI
2108 ><LI
2109 ><P
2110 >The <SPAN
2111 CLASS="bold"
2112 ><B
2113 CLASS="emphasis"
2114 >fstrace setlog</B
2115 ></SPAN
2116 > command changes the size of the trace log.</P
2117 ></LI
2118 ><LI
2119 ><P
2120 >The <SPAN
2121 CLASS="bold"
2122 ><B
2123 CLASS="emphasis"
2124 >fstrace setset</B
2125 ></SPAN
2126 > command sets the state of the event set.</P
2127 ></LI
2128 ></UL
2129 ></P
2130 ><DIV
2131 CLASS="sect2"
2132 ><H2
2133 CLASS="sect2"
2134 ><A
2135 NAME="HDRWQ342"
2136 >About the fstrace Command Suite</A
2137 ></H2
2138 ><P
2139 >The <SPAN
2140 CLASS="bold"
2141 ><B
2142 CLASS="emphasis"
2143 >fstrace</B
2144 ></SPAN
2145 > command suite replaces and greatly expands the functionality formerly
2146       provided by the <SPAN
2147 CLASS="bold"
2148 ><B
2149 CLASS="emphasis"
2150 >fs debug</B
2151 ></SPAN
2152 > command. Its intended use is to aid in diagnosis of specific Cache
2153       Manager problems, such as client machine hangs, cache consistency problems, clock synchronization errors, and failures to
2154       access a volume or AFS file. Therefore, it is best not to keep <SPAN
2155 CLASS="bold"
2156 ><B
2157 CLASS="emphasis"
2158 >fstrace</B
2159 ></SPAN
2160 > logging enabled at all
2161       times, unlike the logging for AFS server processes.</P
2162 ><P
2163 >Most of the messages in the trace log correspond to low-level Cache Manager operations. It is likely that only personnel
2164       familiar with the AFS source code can interpret them. If you have an AFS source license, you can attempt to interpret the
2165       trace yourself, or work with the AFS Product Support group to resolve the underlying problems. If you do not have an AFS
2166       source license, it is probably more efficient to contact the AFS Product Support group immediately in case of problems. They
2167       can instruct you to activate <SPAN
2168 CLASS="bold"
2169 ><B
2170 CLASS="emphasis"
2171 >fstrace</B
2172 ></SPAN
2173 > tracing if appropriate.</P
2174 ><P
2175 >The log can grow in size very quickly; this can use valuable disk space if you are writing to a file in the local file
2176       space. Additionally, if the size of the log becomes too large, it can become difficult to parse the results for pertinent
2177       information.</P
2178 ><P
2179 >When AFS tracing is enabled, each time a <SPAN
2180 CLASS="bold"
2181 ><B
2182 CLASS="emphasis"
2183 >cm</B
2184 ></SPAN
2185 > event occurs, a message is written to the
2186       trace log, <SPAN
2187 CLASS="bold"
2188 ><B
2189 CLASS="emphasis"
2190 >cmfx</B
2191 ></SPAN
2192 >. To diagnose a problem, read the output of the trace log and analyze the
2193       operations executed by the Cache Manager. The default size of the trace log is 60 KB, but you can increase or decrease
2194       it.</P
2195 ><P
2196 >To use the <SPAN
2197 CLASS="bold"
2198 ><B
2199 CLASS="emphasis"
2200 >fstrace</B
2201 ></SPAN
2202 > command suite, you must first enable tracing and reserve, or
2203       allocate, space for the trace log with the <SPAN
2204 CLASS="bold"
2205 ><B
2206 CLASS="emphasis"
2207 >fstrace setset</B
2208 ></SPAN
2209 > command. With this command, you can
2210       set the <SPAN
2211 CLASS="bold"
2212 ><B
2213 CLASS="emphasis"
2214 >cm</B
2215 ></SPAN
2216 > event set to one of three states to enable or disable tracing for the event set
2217       and to allocate or deallocate space for the trace log in the kernel: <DIV
2218 CLASS="variablelist"
2219 ><DL
2220 ><DT
2221 ><SAMP
2222 CLASS="computeroutput"
2223 >active</SAMP
2224 ></DT
2225 ><DD
2226 ><P
2227 >Enables tracing for the event set and allocates space for the trace log.</P
2228 ></DD
2229 ><DT
2230 ><SAMP
2231 CLASS="computeroutput"
2232 >inactive</SAMP
2233 ></DT
2234 ><DD
2235 ><P
2236 >Temporarily disables tracing for the event set; however, the event set continues to allocate space occupied by
2237               the log to which it sends data.</P
2238 ></DD
2239 ><DT
2240 ><SAMP
2241 CLASS="computeroutput"
2242 >dormant</SAMP
2243 ></DT
2244 ><DD
2245 ><P
2246 >Disables tracing for the event set; furthermore, the event set releases the space occupied by the log to which
2247               it sends data. When the <SPAN
2248 CLASS="bold"
2249 ><B
2250 CLASS="emphasis"
2251 >cm</B
2252 ></SPAN
2253 > event set that sends data to the <SPAN
2254 CLASS="bold"
2255 ><B
2256 CLASS="emphasis"
2257 >cmfx</B
2258 ></SPAN
2259 > trace log is in this state, the space allocated for that log is freed or
2260               deallocated.</P
2261 ></DD
2262 ></DL
2263 ></DIV
2264 ></P
2265 ><P
2266 >Both event sets and trace logs can be designated as <SPAN
2267 CLASS="emphasis"
2268 ><I
2269 CLASS="emphasis"
2270 >persistent</I
2271 ></SPAN
2272 >, which prevents accidental resetting
2273       of an event set's state or clearing of a trace log. The designation is made as the kernel is compiled and cannot be
2274       changed.</P
2275 ><P
2276 >If an event set such as <SPAN
2277 CLASS="bold"
2278 ><B
2279 CLASS="emphasis"
2280 >cm</B
2281 ></SPAN
2282 > is persistent, you can change its state only by including
2283       the <SPAN
2284 CLASS="bold"
2285 ><B
2286 CLASS="emphasis"
2287 >-set</B
2288 ></SPAN
2289 > argument to the <SPAN
2290 CLASS="bold"
2291 ><B
2292 CLASS="emphasis"
2293 >fstrace setset</B
2294 ></SPAN
2295 > command. (That is,
2296       you cannot change its state along with the state of all other event sets by issuing the <SPAN
2297 CLASS="bold"
2298 ><B
2299 CLASS="emphasis"
2300 >fstrace
2301       setset</B
2302 ></SPAN
2303 > command with no arguments.) Similarly, if a trace log such as <SPAN
2304 CLASS="bold"
2305 ><B
2306 CLASS="emphasis"
2307 >cmfx</B
2308 ></SPAN
2309 > is
2310       persistent, you can clear it only by including either the <SPAN
2311 CLASS="bold"
2312 ><B
2313 CLASS="emphasis"
2314 >-set</B
2315 ></SPAN
2316 > or <SPAN
2317 CLASS="bold"
2318 ><B
2319 CLASS="emphasis"
2320 >-log</B
2321 ></SPAN
2322 > argument to the <SPAN
2323 CLASS="bold"
2324 ><B
2325 CLASS="emphasis"
2326 >fstrace clear</B
2327 ></SPAN
2328 > command (you cannot clear it along
2329       with all other trace logs by issuing the <SPAN
2330 CLASS="bold"
2331 ><B
2332 CLASS="emphasis"
2333 >fstrace clear</B
2334 ></SPAN
2335 > command with no arguments.)</P
2336 ><P
2337 >When a problem occurs, set the <SPAN
2338 CLASS="bold"
2339 ><B
2340 CLASS="emphasis"
2341 >cm</B
2342 ></SPAN
2343 > event set to active using the <SPAN
2344 CLASS="bold"
2345 ><B
2346 CLASS="emphasis"
2347 >fstrace setset</B
2348 ></SPAN
2349 > command. When tracing is enabled on a busy AFS client, the volume of events being
2350       recorded is significant; therefore, when you are diagnosing problems, restrict AFS activity as much as possible to minimize
2351       the amount of extraneous tracing in the log. Because tracing can have a negative impact on system performance, leave <SPAN
2352 CLASS="bold"
2353 ><B
2354 CLASS="emphasis"
2355 >cm</B
2356 ></SPAN
2357 > tracing in the dormant state when you are not diagnosing problems.</P
2358 ><P
2359 >If a problem is reproducible, clear the <SPAN
2360 CLASS="bold"
2361 ><B
2362 CLASS="emphasis"
2363 >cmfx</B
2364 ></SPAN
2365 > trace log with the <SPAN
2366 CLASS="bold"
2367 ><B
2368 CLASS="emphasis"
2369 >fstrace clear</B
2370 ></SPAN
2371 > command and reproduce the problem. If the problem is not easily reproduced, keep the
2372       state of the event set active until the problem recurs.</P
2373 ><P
2374 >To view the contents of the trace log and analyze the <SPAN
2375 CLASS="bold"
2376 ><B
2377 CLASS="emphasis"
2378 >cm</B
2379 ></SPAN
2380 > events, use the <SPAN
2381 CLASS="bold"
2382 ><B
2383 CLASS="emphasis"
2384 >fstrace dump</B
2385 ></SPAN
2386 > command to copy the content lines of the trace log to standard output (stdout) or to a
2387       file.</P
2388 ><DIV
2389 CLASS="note"
2390 ><BLOCKQUOTE
2391 CLASS="note"
2392 ><P
2393 ><B
2394 >Note: </B
2395 >If a particular command or process is causing problems, determine its process id (PID). Search the output of the
2396         <SPAN
2397 CLASS="bold"
2398 ><B
2399 CLASS="emphasis"
2400 >fstrace dump</B
2401 ></SPAN
2402 > command for the PID to find only those lines associated with the
2403         problem.</P
2404 ></BLOCKQUOTE
2405 ></DIV
2406 ></DIV
2407 ><DIV
2408 CLASS="sect2"
2409 ><H2
2410 CLASS="sect2"
2411 ><A
2412 NAME="HDRWQ343"
2413 >Requirements for Using the fstrace Command Suite</A
2414 ></H2
2415 ><P
2416 >Except for the <SPAN
2417 CLASS="bold"
2418 ><B
2419 CLASS="emphasis"
2420 >fstrace help</B
2421 ></SPAN
2422 > and <SPAN
2423 CLASS="bold"
2424 ><B
2425 CLASS="emphasis"
2426 >fstrace apropos</B
2427 ></SPAN
2428 >
2429       commands, which require no privilege, issuing the <SPAN
2430 CLASS="bold"
2431 ><B
2432 CLASS="emphasis"
2433 >fstrace</B
2434 ></SPAN
2435 > commands requires that the issuer
2436       be logged in as the local superuser <SPAN
2437 CLASS="bold"
2438 ><B
2439 CLASS="emphasis"
2440 >root</B
2441 ></SPAN
2442 > on the local client machine. Before issuing an
2443       <SPAN
2444 CLASS="bold"
2445 ><B
2446 CLASS="emphasis"
2447 >fstrace</B
2448 ></SPAN
2449 > command, verify that you have the necessary privilege.</P
2450 ><P
2451 >The Cache Manager catalog must be in place so that logging can occur. The <SPAN
2452 CLASS="bold"
2453 ><B
2454 CLASS="emphasis"
2455 >fstrace</B
2456 ></SPAN
2457 >
2458       command suite uses the standard UNIX catalog utilities. The default location is <SPAN
2459 CLASS="bold"
2460 ><B
2461 CLASS="emphasis"
2462 >/usr/vice/etc/C/afszcm.cat</B
2463 ></SPAN
2464 >. It can be placed in another directory by placing the file elsewhere and
2465       using the proper NLSPATH and LANG environment variables.</P
2466 ></DIV
2467 ><DIV
2468 CLASS="sect2"
2469 ><H2
2470 CLASS="sect2"
2471 ><A
2472 NAME="Header_379"
2473 >Using fstrace Commands Effectively</A
2474 ></H2
2475 ><P
2476 >To use <SPAN
2477 CLASS="bold"
2478 ><B
2479 CLASS="emphasis"
2480 >fstrace</B
2481 ></SPAN
2482 > commands most effectively, configure them as indicated: <UL
2483 ><LI
2484 ><P
2485 >Store the <SPAN
2486 CLASS="bold"
2487 ><B
2488 CLASS="emphasis"
2489 >fstrace</B
2490 ></SPAN
2491 > binary in a local disk directory.</P
2492 ></LI
2493 ><LI
2494 ><P
2495 >When you dump the <SPAN
2496 CLASS="bold"
2497 ><B
2498 CLASS="emphasis"
2499 >fstrace</B
2500 ></SPAN
2501 > log to a file, direct it to one on the local
2502             disk.</P
2503 ></LI
2504 ><LI
2505 ><P
2506 >The trace can grow large in just a few minutes. Before attempting to dump the log to a local file, verify that you
2507             have enough room. Be particularly careful if you are using disk quotas on partitions in the local file system.</P
2508 ></LI
2509 ><LI
2510 ><P
2511 >Attempt to limit Cache Manager activity on the AFS client machine other than the problem operation. This reduces
2512             the amount of extraneous data in the trace.</P
2513 ></LI
2514 ><LI
2515 ><P
2516 >Activate the <SPAN
2517 CLASS="bold"
2518 ><B
2519 CLASS="emphasis"
2520 >fstrace</B
2521 ></SPAN
2522 > log for the shortest possibly period of time. If possible
2523             activate the trace immediately before performing the problem operation, deactivate it as soon as the operation
2524             completes, and dump the trace log to a file immediately.</P
2525 ></LI
2526 ><LI
2527 ><P
2528 >If possible, obtain UNIX process ID (PID) of the command or program that initiates the problematic operation. This
2529             enables the person analyzing the trace log to search it for messages associated with the PID.</P
2530 ></LI
2531 ></UL
2532 ></P
2533 ></DIV
2534 ><DIV
2535 CLASS="sect2"
2536 ><H2
2537 CLASS="sect2"
2538 ><A
2539 NAME="HDRWQ344"
2540 >Activating the Trace Log</A
2541 ></H2
2542 ><P
2543 >To start Cache Manager tracing on an AFS client machine, you must first configure <UL
2544 ><LI
2545 ><P
2546 >The <SPAN
2547 CLASS="bold"
2548 ><B
2549 CLASS="emphasis"
2550 >cmfx</B
2551 ></SPAN
2552 > kernel trace log using the <SPAN
2553 CLASS="bold"
2554 ><B
2555 CLASS="emphasis"
2556 >fstrace
2557             setlog</B
2558 ></SPAN
2559 > command</P
2560 ></LI
2561 ><LI
2562 ><P
2563 >The <SPAN
2564 CLASS="bold"
2565 ><B
2566 CLASS="emphasis"
2567 >cm</B
2568 ></SPAN
2569 > event set using the <SPAN
2570 CLASS="bold"
2571 ><B
2572 CLASS="emphasis"
2573 >fstrace setset</B
2574 ></SPAN
2575 >
2576             command</P
2577 ></LI
2578 ></UL
2579 ></P
2580 ><P
2581 >The <SPAN
2582 CLASS="bold"
2583 ><B
2584 CLASS="emphasis"
2585 >fstrace setlog</B
2586 ></SPAN
2587 > command sets the size of the <SPAN
2588 CLASS="bold"
2589 ><B
2590 CLASS="emphasis"
2591 >cmfx</B
2592 ></SPAN
2593 >
2594       kernel trace log in kilobytes. The trace log occupies 60 kilobytes of kernel by default. If the trace log already exists, it
2595       is cleared when this command is issued and a new log of the given size is created. Otherwise, a new log of the desired size is
2596       created.</P
2597 ><P
2598 >The <SPAN
2599 CLASS="bold"
2600 ><B
2601 CLASS="emphasis"
2602 >fstrace setset</B
2603 ></SPAN
2604 > command sets the state of the <SPAN
2605 CLASS="bold"
2606 ><B
2607 CLASS="emphasis"
2608 >cm</B
2609 ></SPAN
2610 >
2611       kernel event set. The state of the <SPAN
2612 CLASS="bold"
2613 ><B
2614 CLASS="emphasis"
2615 >cm</B
2616 ></SPAN
2617 > event set determines whether information on the events
2618       in that event set is logged.</P
2619 ><P
2620 >After establishing kernel tracing on the AFS client machine, you can check the state of the event set and the size of
2621       the kernel buffer allocated for the trace log. To display information about the state of the <SPAN
2622 CLASS="bold"
2623 ><B
2624 CLASS="emphasis"
2625 >cm</B
2626 ></SPAN
2627 > event set, issue the <SPAN
2628 CLASS="bold"
2629 ><B
2630 CLASS="emphasis"
2631 >fstrace lsset</B
2632 ></SPAN
2633 > command. To display information
2634       about the <SPAN
2635 CLASS="bold"
2636 ><B
2637 CLASS="emphasis"
2638 >cmfx</B
2639 ></SPAN
2640 > trace log, use the <SPAN
2641 CLASS="bold"
2642 ><B
2643 CLASS="emphasis"
2644 >fstrace lslog</B
2645 ></SPAN
2646 > command. See
2647       the instructions in <A
2648 HREF="c18360.html#HDRWQ346"
2649 >Displaying the State of a Trace Log or Event Set</A
2650 >.</P
2651 ></DIV
2652 ><DIV
2653 CLASS="sect2"
2654 ><H2
2655 CLASS="sect2"
2656 ><A
2657 NAME="Header_381"
2658 >To configure the trace log</A
2659 ></H2
2660 ><OL
2661 TYPE="1"
2662 ><LI
2663 ><P
2664 >Become the local superuser <SPAN
2665 CLASS="bold"
2666 ><B
2667 CLASS="emphasis"
2668 >root</B
2669 ></SPAN
2670 > on the machine, if you are not already, by issuing
2671           the <SPAN
2672 CLASS="bold"
2673 ><B
2674 CLASS="emphasis"
2675 >su</B
2676 ></SPAN
2677 > command. <PRE
2678 CLASS="programlisting"
2679 >&#13;   % <SPAN
2680 CLASS="bold"
2681 ><B
2682 CLASS="emphasis"
2683 >su root</B
2684 ></SPAN
2685 >
2686    Password: &#60;<VAR
2687 CLASS="replaceable"
2688 >root_password</VAR
2689 >&#62;
2690 </PRE
2691 ></P
2692 ></LI
2693 ><LI
2694 ><P
2695 >Issue the <SPAN
2696 CLASS="bold"
2697 ><B
2698 CLASS="emphasis"
2699 >fstrace setlog</B
2700 ></SPAN
2701 > command to set the size of the <SPAN
2702 CLASS="bold"
2703 ><B
2704 CLASS="emphasis"
2705 >cmfx</B
2706 ></SPAN
2707 > kernel trace log. <PRE
2708 CLASS="programlisting"
2709 >&#13;   # <SPAN
2710 CLASS="bold"
2711 ><B
2712 CLASS="emphasis"
2713 >fstrace setlog</B
2714 ></SPAN
2715 >  [<SPAN
2716 CLASS="bold"
2717 ><B
2718 CLASS="emphasis"
2719 >-log</B
2720 ></SPAN
2721 > &#60;<VAR
2722 CLASS="replaceable"
2723 >log_name</VAR
2724 >&#62;+]  <SPAN
2725 CLASS="bold"
2726 ><B
2727 CLASS="emphasis"
2728 >-buffersize</B
2729 ></SPAN
2730 > &#60;<VAR
2731 CLASS="replaceable"
2732 >1-kilobyte_units</VAR
2733 >&#62;
2734 </PRE
2735 ></P
2736 ></LI
2737 ></OL
2738 ><P
2739 >The following example sets the size of the <SPAN
2740 CLASS="bold"
2741 ><B
2742 CLASS="emphasis"
2743 >cmfx</B
2744 ></SPAN
2745 > trace log to 80 KB.</P
2746 ><PRE
2747 CLASS="programlisting"
2748 >&#13;   # <SPAN
2749 CLASS="bold"
2750 ><B
2751 CLASS="emphasis"
2752 >fstrace setlog cmfx 80</B
2753 ></SPAN
2754
2755 </PRE
2756 ></DIV
2757 ><DIV
2758 CLASS="sect2"
2759 ><H2
2760 CLASS="sect2"
2761 ><A
2762 NAME="HDRWQ345"
2763 >To set the event set</A
2764 ></H2
2765 ><OL
2766 TYPE="1"
2767 ><LI
2768 ><P
2769 >Become the local superuser <SPAN
2770 CLASS="bold"
2771 ><B
2772 CLASS="emphasis"
2773 >root</B
2774 ></SPAN
2775 > on the machine, if you are not already, by issuing
2776           the <SPAN
2777 CLASS="bold"
2778 ><B
2779 CLASS="emphasis"
2780 >su</B
2781 ></SPAN
2782 > command. <PRE
2783 CLASS="programlisting"
2784 >&#13;   % <SPAN
2785 CLASS="bold"
2786 ><B
2787 CLASS="emphasis"
2788 >su root</B
2789 ></SPAN
2790 >
2791    Password: &#60;<VAR
2792 CLASS="replaceable"
2793 >root_password</VAR
2794 >&#62;
2795 </PRE
2796 ></P
2797 ></LI
2798 ><LI
2799 ><P
2800 >Issue the <SPAN
2801 CLASS="bold"
2802 ><B
2803 CLASS="emphasis"
2804 >fstrace setset</B
2805 ></SPAN
2806 > command to set the state of event sets. <PRE
2807 CLASS="programlisting"
2808 >&#13;   % <SPAN
2809 CLASS="bold"
2810 ><B
2811 CLASS="emphasis"
2812 >fstrace setset</B
2813 ></SPAN
2814 > [<SPAN
2815 CLASS="bold"
2816 ><B
2817 CLASS="emphasis"
2818 >-set</B
2819 ></SPAN
2820 > &#60;<VAR
2821 CLASS="replaceable"
2822 >set_name</VAR
2823 >&#62;+] [<SPAN
2824 CLASS="bold"
2825 ><B
2826 CLASS="emphasis"
2827 >-active</B
2828 ></SPAN
2829 >] [<SPAN
2830 CLASS="bold"
2831 ><B
2832 CLASS="emphasis"
2833 >-inactive</B
2834 ></SPAN
2835 >]  \
2836                     [<SPAN
2837 CLASS="bold"
2838 ><B
2839 CLASS="emphasis"
2840 >-dormant</B
2841 ></SPAN
2842 >] 
2843 </PRE
2844 ></P
2845 ></LI
2846 ></OL
2847 ><P
2848 >The following example activates the <SPAN
2849 CLASS="bold"
2850 ><B
2851 CLASS="emphasis"
2852 >cm</B
2853 ></SPAN
2854 > event set.</P
2855 ><PRE
2856 CLASS="programlisting"
2857 >&#13;   # <SPAN
2858 CLASS="bold"
2859 ><B
2860 CLASS="emphasis"
2861 >fstrace setset cm -active</B
2862 ></SPAN
2863 >
2864 </PRE
2865 ></DIV
2866 ><DIV
2867 CLASS="sect2"
2868 ><H2
2869 CLASS="sect2"
2870 ><A
2871 NAME="HDRWQ346"
2872 >Displaying the State of a Trace Log or Event Set</A
2873 ></H2
2874 ><P
2875 >An event set must be in the <SPAN
2876 CLASS="emphasis"
2877 ><I
2878 CLASS="emphasis"
2879 >active state</I
2880 ></SPAN
2881 > to be included in the trace log. To display an event set's
2882       state, use the <SPAN
2883 CLASS="bold"
2884 ><B
2885 CLASS="emphasis"
2886 >fstrace lsset</B
2887 ></SPAN
2888 > command. To set its state, issue the <SPAN
2889 CLASS="bold"
2890 ><B
2891 CLASS="emphasis"
2892 >fstrace setset</B
2893 ></SPAN
2894 > command as described in <A
2895 HREF="c18360.html#HDRWQ345"
2896 >To set the event set</A
2897 >.</P
2898 ><P
2899 >To display size and allocation information for the trace log, issue the <SPAN
2900 CLASS="bold"
2901 ><B
2902 CLASS="emphasis"
2903 >fstrace
2904       lslog</B
2905 ></SPAN
2906 >command with the <SPAN
2907 CLASS="bold"
2908 ><B
2909 CLASS="emphasis"
2910 >-long</B
2911 ></SPAN
2912 > argument.</P
2913 ></DIV
2914 ><DIV
2915 CLASS="sect2"
2916 ><H2
2917 CLASS="sect2"
2918 ><A
2919 NAME="Header_384"
2920 >To display the state of an event set</A
2921 ></H2
2922 ><OL
2923 TYPE="1"
2924 ><LI
2925 ><P
2926 >Become the local superuser <SPAN
2927 CLASS="bold"
2928 ><B
2929 CLASS="emphasis"
2930 >root</B
2931 ></SPAN
2932 > on the machine, if you are not already, by issuing
2933           the <SPAN
2934 CLASS="bold"
2935 ><B
2936 CLASS="emphasis"
2937 >su</B
2938 ></SPAN
2939 > command. <PRE
2940 CLASS="programlisting"
2941 >&#13;   % <SPAN
2942 CLASS="bold"
2943 ><B
2944 CLASS="emphasis"
2945 >su root</B
2946 ></SPAN
2947 >
2948    Password: &#60;<VAR
2949 CLASS="replaceable"
2950 >root_password</VAR
2951 >&#62;
2952 </PRE
2953 ></P
2954 ></LI
2955 ><LI
2956 ><P
2957 >Issue the <SPAN
2958 CLASS="bold"
2959 ><B
2960 CLASS="emphasis"
2961 >fstrace lsset</B
2962 ></SPAN
2963 > command to display the available event set and its state.
2964           <PRE
2965 CLASS="programlisting"
2966 >&#13;   # <SPAN
2967 CLASS="bold"
2968 ><B
2969 CLASS="emphasis"
2970 >fstrace lsset</B
2971 ></SPAN
2972 >  [<SPAN
2973 CLASS="bold"
2974 ><B
2975 CLASS="emphasis"
2976 >-set</B
2977 ></SPAN
2978 > &#60;<VAR
2979 CLASS="replaceable"
2980 >set_name</VAR
2981 >&#62;+]
2982 </PRE
2983 ></P
2984 ></LI
2985 ></OL
2986 ><P
2987 >The following example displays the event set and its state on the local machine.</P
2988 ><PRE
2989 CLASS="programlisting"
2990 >&#13;   # <SPAN
2991 CLASS="bold"
2992 ><B
2993 CLASS="emphasis"
2994 >fstrace lsset cm</B
2995 ></SPAN
2996 >
2997    Available sets:
2998    cm active
2999 </PRE
3000 ><P
3001 >The output from this command lists the event set and its states. The three event states for the <SPAN
3002 CLASS="bold"
3003 ><B
3004 CLASS="emphasis"
3005 >cm</B
3006 ></SPAN
3007 > event set are: <DIV
3008 CLASS="variablelist"
3009 ><DL
3010 ><DT
3011 ><SPAN
3012 CLASS="bold"
3013 ><B
3014 CLASS="emphasis"
3015 >active</B
3016 ></SPAN
3017 ></DT
3018 ><DD
3019 ><P
3020 >Tracing is enabled.</P
3021 ></DD
3022 ><DT
3023 ><SPAN
3024 CLASS="bold"
3025 ><B
3026 CLASS="emphasis"
3027 >inactive</B
3028 ></SPAN
3029 ></DT
3030 ><DD
3031 ><P
3032 >Tracing is disabled, but space is still allocated for the corresponding trace log (<SPAN
3033 CLASS="bold"
3034 ><B
3035 CLASS="emphasis"
3036 >cmfx</B
3037 ></SPAN
3038 >).</P
3039 ></DD
3040 ><DT
3041 ><SPAN
3042 CLASS="bold"
3043 ><B
3044 CLASS="emphasis"
3045 >dormant</B
3046 ></SPAN
3047 ></DT
3048 ><DD
3049 ><P
3050 >Tracing is disabled, and space is no longer allocated for the corresponding trace log (<SPAN
3051 CLASS="bold"
3052 ><B
3053 CLASS="emphasis"
3054 >cmfx</B
3055 ></SPAN
3056 >).Disables tracing for the event set.</P
3057 ></DD
3058 ></DL
3059 ></DIV
3060 ></P
3061 ></DIV
3062 ><DIV
3063 CLASS="sect2"
3064 ><H2
3065 CLASS="sect2"
3066 ><A
3067 NAME="Header_385"
3068 >To display the log size</A
3069 ></H2
3070 ><OL
3071 TYPE="1"
3072 ><LI
3073 ><P
3074 >Become the local superuser <SPAN
3075 CLASS="bold"
3076 ><B
3077 CLASS="emphasis"
3078 >root</B
3079 ></SPAN
3080 > on the machine, if you are not already, by issuing
3081           the <SPAN
3082 CLASS="bold"
3083 ><B
3084 CLASS="emphasis"
3085 >su</B
3086 ></SPAN
3087 > command. <PRE
3088 CLASS="programlisting"
3089 >&#13;   % <SPAN
3090 CLASS="bold"
3091 ><B
3092 CLASS="emphasis"
3093 >su root</B
3094 ></SPAN
3095 >
3096    Password: &#60;<VAR
3097 CLASS="replaceable"
3098 >root_password</VAR
3099 >&#62;
3100 </PRE
3101 ></P
3102 ></LI
3103 ><LI
3104 ><P
3105 >Issue the <SPAN
3106 CLASS="bold"
3107 ><B
3108 CLASS="emphasis"
3109 >fstrace lslog</B
3110 ></SPAN
3111 > command to display information about the kernel trace log.
3112           <PRE
3113 CLASS="programlisting"
3114 >&#13;   # <SPAN
3115 CLASS="bold"
3116 ><B
3117 CLASS="emphasis"
3118 >fstrace lslog</B
3119 ></SPAN
3120 >  [<SPAN
3121 CLASS="bold"
3122 ><B
3123 CLASS="emphasis"
3124 >-set</B
3125 ></SPAN
3126 > &#60;<VAR
3127 CLASS="replaceable"
3128 >set_name</VAR
3129 >&#62;+]  [<SPAN
3130 CLASS="bold"
3131 ><B
3132 CLASS="emphasis"
3133 >-log</B
3134 ></SPAN
3135 > &#60;<VAR
3136 CLASS="replaceable"
3137 >log_name</VAR
3138 >&#62;]  [<SPAN
3139 CLASS="bold"
3140 ><B
3141 CLASS="emphasis"
3142 >-long</B
3143 ></SPAN
3144 >] 
3145 </PRE
3146 ></P
3147 ></LI
3148 ></OL
3149 ><P
3150 >The following example uses the <SPAN
3151 CLASS="bold"
3152 ><B
3153 CLASS="emphasis"
3154 >-long</B
3155 ></SPAN
3156 > flag to display additional information about the
3157       <SPAN
3158 CLASS="bold"
3159 ><B
3160 CLASS="emphasis"
3161 >cmfx</B
3162 ></SPAN
3163 > trace log.</P
3164 ><PRE
3165 CLASS="programlisting"
3166 >&#13;   # <SPAN
3167 CLASS="bold"
3168 ><B
3169 CLASS="emphasis"
3170 >fstrace lslog cmfx -long</B
3171 ></SPAN
3172 >
3173    Available logs:
3174    cmfx : 60 kbytes (allocated)
3175 </PRE
3176 ><P
3177 >The output from this command lists information on the trace log. When issued without the <SPAN
3178 CLASS="bold"
3179 ><B
3180 CLASS="emphasis"
3181 >-long</B
3182 ></SPAN
3183 > flag, the <SPAN
3184 CLASS="bold"
3185 ><B
3186 CLASS="emphasis"
3187 >fstrace lslog</B
3188 ></SPAN
3189 > command lists only the name of the log.
3190       When issued with the <SPAN
3191 CLASS="bold"
3192 ><B
3193 CLASS="emphasis"
3194 >-long</B
3195 ></SPAN
3196 > flag, the <SPAN
3197 CLASS="bold"
3198 ><B
3199 CLASS="emphasis"
3200 >fstrace lslog</B
3201 ></SPAN
3202 > command
3203       lists the log, the size of the log in kilobytes, and the allocation state of the log.</P
3204 ><P
3205 >There are two allocation states for the kernel trace log: <DIV
3206 CLASS="variablelist"
3207 ><DL
3208 ><DT
3209 ><SAMP
3210 CLASS="computeroutput"
3211 >allocated</SAMP
3212 ></DT
3213 ><DD
3214 ><P
3215 >Space is reserved for the log in the kernel. This indicates that the event set that writes to this log is either
3216               <SPAN
3217 CLASS="emphasis"
3218 ><I
3219 CLASS="emphasis"
3220 >active</I
3221 ></SPAN
3222 > (tracing is enabled for the event set) or <SPAN
3223 CLASS="emphasis"
3224 ><I
3225 CLASS="emphasis"
3226 >inactive</I
3227 ></SPAN
3228 > (tracing is
3229               temporarily disabled for the event set); however, the event set continues to reserve space occupied by the log to
3230               which it sends data.</P
3231 ></DD
3232 ><DT
3233 ><SAMP
3234 CLASS="computeroutput"
3235 >unallocated</SAMP
3236 ></DT
3237 ><DD
3238 ><P
3239 >Space is not reserved for the log in the kernel. This indicates that the event set that writes to this log is
3240               <SPAN
3241 CLASS="emphasis"
3242 ><I
3243 CLASS="emphasis"
3244 >dormant</I
3245 ></SPAN
3246 > (tracing is disabled for the event set); furthermore, the event set releases the space
3247               occupied by the log to which it sends data.</P
3248 ></DD
3249 ></DL
3250 ></DIV
3251 ></P
3252 ></DIV
3253 ><DIV
3254 CLASS="sect2"
3255 ><H2
3256 CLASS="sect2"
3257 ><A
3258 NAME="HDRWQ347"
3259 >Dumping and Clearing the Trace Log</A
3260 ></H2
3261 ><P
3262 >After the Cache Manager operation you want to trace is complete, use the <SPAN
3263 CLASS="bold"
3264 ><B
3265 CLASS="emphasis"
3266 >fstrace dump</B
3267 ></SPAN
3268 >
3269       command to dump the trace log to the standard output stream or to the file named by the <SPAN
3270 CLASS="bold"
3271 ><B
3272 CLASS="emphasis"
3273 >-file</B
3274 ></SPAN
3275 >
3276       argument. Or, to dump the trace log continuously, use the <SPAN
3277 CLASS="bold"
3278 ><B
3279 CLASS="emphasis"
3280 >-follow</B
3281 ></SPAN
3282 > argument (combine it with
3283       the <SPAN
3284 CLASS="bold"
3285 ><B
3286 CLASS="emphasis"
3287 >-file</B
3288 ></SPAN
3289 > argument if desired). To halt continuous dumping, press an interrupt signal such as
3290       &#60;<SPAN
3291 CLASS="bold"
3292 ><B
3293 CLASS="emphasis"
3294 >Ctrl-c</B
3295 ></SPAN
3296 >&#62;.</P
3297 ><P
3298 >To clear a trace log when you no longer need the data in it, issue the <SPAN
3299 CLASS="bold"
3300 ><B
3301 CLASS="emphasis"
3302 >fstrace clear</B
3303 ></SPAN
3304 >
3305       command. (The <SPAN
3306 CLASS="bold"
3307 ><B
3308 CLASS="emphasis"
3309 >fstrace setlog</B
3310 ></SPAN
3311 > command also clears an existing trace log automatically when you
3312       use it to change the log's size.)</P
3313 ></DIV
3314 ><DIV
3315 CLASS="sect2"
3316 ><H2
3317 CLASS="sect2"
3318 ><A
3319 NAME="Header_387"
3320 >To dump the contents of a trace log</A
3321 ></H2
3322 ><OL
3323 TYPE="1"
3324 ><LI
3325 ><P
3326 >Become the local superuser <SPAN
3327 CLASS="bold"
3328 ><B
3329 CLASS="emphasis"
3330 >root</B
3331 ></SPAN
3332 > on the machine, if you are not already, by issuing
3333           the <SPAN
3334 CLASS="bold"
3335 ><B
3336 CLASS="emphasis"
3337 >su</B
3338 ></SPAN
3339 > command. <PRE
3340 CLASS="programlisting"
3341 >&#13;   % <SPAN
3342 CLASS="bold"
3343 ><B
3344 CLASS="emphasis"
3345 >su root</B
3346 ></SPAN
3347 >
3348    Password: &#60;<VAR
3349 CLASS="replaceable"
3350 >root_password</VAR
3351 >&#62;
3352 </PRE
3353 ></P
3354 ></LI
3355 ><LI
3356 ><P
3357 >Issue the <SPAN
3358 CLASS="bold"
3359 ><B
3360 CLASS="emphasis"
3361 >fstrace dump</B
3362 ></SPAN
3363 > command to dump trace logs. <PRE
3364 CLASS="programlisting"
3365 >&#13;   # <SPAN
3366 CLASS="bold"
3367 ><B
3368 CLASS="emphasis"
3369 >fstrace dump</B
3370 ></SPAN
3371 > [<SPAN
3372 CLASS="bold"
3373 ><B
3374 CLASS="emphasis"
3375 >-set</B
3376 ></SPAN
3377 > &#60;<VAR
3378 CLASS="replaceable"
3379 >set_name</VAR
3380 >&#62;+]  [<SPAN
3381 CLASS="bold"
3382 ><B
3383 CLASS="emphasis"
3384 >-follow</B
3385 ></SPAN
3386 > &#60;<VAR
3387 CLASS="replaceable"
3388 >log_name</VAR
3389 >&#62;]  \
3390                   [<SPAN
3391 CLASS="bold"
3392 ><B
3393 CLASS="emphasis"
3394 >-file</B
3395 ></SPAN
3396 > &#60;<VAR
3397 CLASS="replaceable"
3398 >output_filename</VAR
3399 >&#62;]  \
3400                   [<SPAN
3401 CLASS="bold"
3402 ><B
3403 CLASS="emphasis"
3404 >-sleep</B
3405 ></SPAN
3406 > &#60;<VAR
3407 CLASS="replaceable"
3408 >seconds_between_reads</VAR
3409 >&#62;]
3410 </PRE
3411 ></P
3412 ></LI
3413 ></OL
3414 ><P
3415 >At the beginning of the output of each dump is a header specifying the date and time at which the dump began. The number
3416       of logs being dumped is also displayed if the <SPAN
3417 CLASS="bold"
3418 ><B
3419 CLASS="emphasis"
3420 >-follow</B
3421 ></SPAN
3422 > argument is not specified. The header
3423       appears as follows:</P
3424 ><PRE
3425 CLASS="programlisting"
3426 >&#13;   AFS Trace Dump --
3427    Date: date time
3428    Found n logs.
3429 </PRE
3430 ><P
3431 >where <SPAN
3432 CLASS="emphasis"
3433 ><I
3434 CLASS="emphasis"
3435 >date</I
3436 ></SPAN
3437 > is the starting date of the trace log dump, <SPAN
3438 CLASS="emphasis"
3439 ><I
3440 CLASS="emphasis"
3441 >time</I
3442 ></SPAN
3443 > is the starting
3444       time of the trace log dump, and <SPAN
3445 CLASS="emphasis"
3446 ><I
3447 CLASS="emphasis"
3448 >n</I
3449 ></SPAN
3450 > specifies the number of logs found by the <SPAN
3451 CLASS="bold"
3452 ><B
3453 CLASS="emphasis"
3454 >fstrace
3455       dump</B
3456 ></SPAN
3457 > command.</P
3458 ><P
3459 >The following is an example of trace log dump header:</P
3460 ><PRE
3461 CLASS="programlisting"
3462 >&#13;   AFS Trace Dump --
3463    Date: Fri Apr 16 10:44:38 1999
3464    Found 1 logs.
3465 </PRE
3466 ><P
3467 >The contents of the log follow the header and are comprised of messages written to the log from an active event set. The
3468       messages written to the log contain the following three components: <UL
3469 ><LI
3470 ><P
3471 >The timestamp associated with the message (number of seconds from an arbitrary start point)</P
3472 ></LI
3473 ><LI
3474 ><P
3475 >The process ID or thread ID associated with the message</P
3476 ></LI
3477 ><LI
3478 ><P
3479 >The message itself</P
3480 ></LI
3481 ></UL
3482 ></P
3483 ><P
3484 >A trace log message is formatted as follows:</P
3485 ><PRE
3486 CLASS="programlisting"
3487 >&#13;   time timestamp, pid pid:event message
3488 </PRE
3489 ><P
3490 >where <SPAN
3491 CLASS="emphasis"
3492 ><I
3493 CLASS="emphasis"
3494 >timestamp</I
3495 ></SPAN
3496 > is the number of seconds from an arbitrary start point, <SPAN
3497 CLASS="emphasis"
3498 ><I
3499 CLASS="emphasis"
3500 >pid</I
3501 ></SPAN
3502 > is
3503       the process ID number of the Cache Manager event, and <SPAN
3504 CLASS="emphasis"
3505 ><I
3506 CLASS="emphasis"
3507 >event message</I
3508 ></SPAN
3509 > is the Cache Manager event which
3510       corresponds with a function in the AFS source code.</P
3511 ><P
3512 >The following is an example of a dumped trace log message:</P
3513 ><PRE
3514 CLASS="programlisting"
3515 >&#13;   time 749.641274, pid 3002:Returning code 2 from 19
3516 </PRE
3517 ><P
3518 >For the messages in the trace log to be most readable, the Cache Manager catalog file needs to be installed on the local
3519       disk of the client machine; the conventional location is <SPAN
3520 CLASS="bold"
3521 ><B
3522 CLASS="emphasis"
3523 >/usr/vice/etc/C/afszcm.cat</B
3524 ></SPAN
3525 >. Log
3526       messages that begin with the string <SAMP
3527 CLASS="computeroutput"
3528 >raw op</SAMP
3529 >, like the following, indicate that the catalog is
3530       not installed.</P
3531 ><PRE
3532 CLASS="programlisting"
3533 >&#13;   raw op 232c, time 511.916288, pid 0
3534    p0:Fri Apr 16 10:36:31 1999
3535 </PRE
3536 ><P
3537 >Every 1024 seconds, a current time message is written to each log. This message has the following format:</P
3538 ><PRE
3539 CLASS="programlisting"
3540 >&#13;   time timestamp, pid pid: Current time: unix_time
3541 </PRE
3542 ><P
3543 >where timestamp is the number of seconds from an arbitrary start point, pid is the process ID number, and unix_time is
3544       the standard time format since January 1, 1970.</P
3545 ><P
3546 >The current time message can be used to determine the actual time associated with each log message. Determine the actual
3547       time as follows: <OL
3548 TYPE="1"
3549 ><LI
3550 ><P
3551 >Locate the log message whose actual time you want to determine.</P
3552 ></LI
3553 ><LI
3554 ><P
3555 >Search backward through the dump record until you come to a current time message.</P
3556 ></LI
3557 ><LI
3558 ><P
3559 >If the current time message's <SPAN
3560 CLASS="emphasis"
3561 ><I
3562 CLASS="emphasis"
3563 >timestamp</I
3564 ></SPAN
3565 > is smaller than the log message's
3566             <SPAN
3567 CLASS="emphasis"
3568 ><I
3569 CLASS="emphasis"
3570 >timestamp</I
3571 ></SPAN
3572 >, subtract the former from the latter. If the current time message's
3573             <SPAN
3574 CLASS="emphasis"
3575 ><I
3576 CLASS="emphasis"
3577 >timestamp</I
3578 ></SPAN
3579 > is larger than the log message's <SPAN
3580 CLASS="emphasis"
3581 ><I
3582 CLASS="emphasis"
3583 >timestamp</I
3584 ></SPAN
3585 >, add 1024 to the latter
3586             and subtract the former from the result.</P
3587 ></LI
3588 ><LI
3589 ><P
3590 >Add the resulting number to the current time message's <SPAN
3591 CLASS="emphasis"
3592 ><I
3593 CLASS="emphasis"
3594 >unix_time</I
3595 ></SPAN
3596 > to determine the log
3597             message's actual time.</P
3598 ></LI
3599 ></OL
3600 ></P
3601 ><P
3602 >Because log data is stored in a finite, circular buffer, some of the data can be overwritten before being read. If this
3603       happens, the following message appears at the appropriate place in the dump:</P
3604 ><PRE
3605 CLASS="programlisting"
3606 >&#13;   Log wrapped; data missing.
3607 </PRE
3608 ><DIV
3609 CLASS="note"
3610 ><BLOCKQUOTE
3611 CLASS="note"
3612 ><P
3613 ><B
3614 >Note: </B
3615 >If this message appears in the middle of a dump, which can happen under a heavy work load, it indicates that not all
3616         of the log data is being written to the log or some data is being overwritten. Increasing the size of the log with the
3617         <SPAN
3618 CLASS="bold"
3619 ><B
3620 CLASS="emphasis"
3621 >fstrace setlog</B
3622 ></SPAN
3623 > command can alleviate this problem.</P
3624 ></BLOCKQUOTE
3625 ></DIV
3626 ></DIV
3627 ><DIV
3628 CLASS="sect2"
3629 ><H2
3630 CLASS="sect2"
3631 ><A
3632 NAME="Header_388"
3633 >To clear the contents of a trace log</A
3634 ></H2
3635 ><OL
3636 TYPE="1"
3637 ><LI
3638 ><P
3639 >Become the local superuser <SPAN
3640 CLASS="bold"
3641 ><B
3642 CLASS="emphasis"
3643 >root</B
3644 ></SPAN
3645 > on the machine, if you are not already, by issuing
3646           the <SPAN
3647 CLASS="bold"
3648 ><B
3649 CLASS="emphasis"
3650 >su</B
3651 ></SPAN
3652 > command. <PRE
3653 CLASS="programlisting"
3654 >&#13;   % <SPAN
3655 CLASS="bold"
3656 ><B
3657 CLASS="emphasis"
3658 >su root</B
3659 ></SPAN
3660 >
3661    Password: &#60;<VAR
3662 CLASS="replaceable"
3663 >root_password</VAR
3664 >&#62;
3665 </PRE
3666 ></P
3667 ></LI
3668 ><LI
3669 ><P
3670 >Issue the <SPAN
3671 CLASS="bold"
3672 ><B
3673 CLASS="emphasis"
3674 >fstrace clear</B
3675 ></SPAN
3676 > command to clear logs by log name or by event set.
3677           <PRE
3678 CLASS="programlisting"
3679 >&#13;   # <SPAN
3680 CLASS="bold"
3681 ><B
3682 CLASS="emphasis"
3683 >fstrace clear</B
3684 ></SPAN
3685 >  [<SPAN
3686 CLASS="bold"
3687 ><B
3688 CLASS="emphasis"
3689 >-set</B
3690 ></SPAN
3691 > &#60;<VAR
3692 CLASS="replaceable"
3693 >set_name</VAR
3694 >&#62;+]  [<SPAN
3695 CLASS="bold"
3696 ><B
3697 CLASS="emphasis"
3698 >-log</B
3699 ></SPAN
3700 > &#60;<VAR
3701 CLASS="replaceable"
3702 >log_name</VAR
3703 >&#62;+]
3704 </PRE
3705 ></P
3706 ></LI
3707 ></OL
3708 ><P
3709 >The following example clears the <SPAN
3710 CLASS="bold"
3711 ><B
3712 CLASS="emphasis"
3713 >cmfx</B
3714 ></SPAN
3715 > log used by the <SPAN
3716 CLASS="bold"
3717 ><B
3718 CLASS="emphasis"
3719 >cm</B
3720 ></SPAN
3721 > event set on the local machine.</P
3722 ><PRE
3723 CLASS="programlisting"
3724 >&#13;   # <SPAN
3725 CLASS="bold"
3726 ><B
3727 CLASS="emphasis"
3728 >fstrace clear cm</B
3729 ></SPAN
3730 >
3731 </PRE
3732 ><P
3733 >The following example also clears the <SPAN
3734 CLASS="bold"
3735 ><B
3736 CLASS="emphasis"
3737 >cmfx</B
3738 ></SPAN
3739 > log on the local machine.</P
3740 ><PRE
3741 CLASS="programlisting"
3742 >&#13;   # <SPAN
3743 CLASS="bold"
3744 ><B
3745 CLASS="emphasis"
3746 >fstrace clear cmfx</B
3747 ></SPAN
3748 >
3749 </PRE
3750 ></DIV
3751 ><DIV
3752 CLASS="sect2"
3753 ><H2
3754 CLASS="sect2"
3755 ><A
3756 NAME="HDRWQ348"
3757 >Examples of fstrace Commands</A
3758 ></H2
3759 ><P
3760 >This section contains an extensive example of the use of the <SPAN
3761 CLASS="bold"
3762 ><B
3763 CLASS="emphasis"
3764 >fstrace</B
3765 ></SPAN
3766 > command suite,
3767       which is useful for gathering a detailed trace of Cache Manager activity when you are working with AFS Product Support to
3768       diagnose a problem. The Product Support representative can guide you in choosing appropriate parameter settings for the
3769       trace.</P
3770 ><P
3771 >Before starting the kernel trace log, try to isolate the Cache Manager on the AFS client machine that is experiencing
3772       the problem accessing the file. If necessary, instruct users to move to another machine so as to minimize the Cache Manager
3773       activity on this machine. To minimize the amount of unrelated AFS activity recorded in the trace log, place both the <SPAN
3774 CLASS="bold"
3775 ><B
3776 CLASS="emphasis"
3777 >fstrace</B
3778 ></SPAN
3779 > binary and the dump file must reside on the local disk, not in AFS. You must be logged in as
3780       the local superuser <SPAN
3781 CLASS="bold"
3782 ><B
3783 CLASS="emphasis"
3784 >root</B
3785 ></SPAN
3786 > to issue <SPAN
3787 CLASS="bold"
3788 ><B
3789 CLASS="emphasis"
3790 >fstrace</B
3791 ></SPAN
3792 > commands.</P
3793 ><P
3794 >Before starting a kernel trace, issue the <SPAN
3795 CLASS="bold"
3796 ><B
3797 CLASS="emphasis"
3798 >fstrace lsset</B
3799 ></SPAN
3800 > command to check the state of
3801       the <SPAN
3802 CLASS="bold"
3803 ><B
3804 CLASS="emphasis"
3805 >cm</B
3806 ></SPAN
3807 > event set.</P
3808 ><PRE
3809 CLASS="programlisting"
3810 >&#13;   # <SPAN
3811 CLASS="bold"
3812 ><B
3813 CLASS="emphasis"
3814 >fstrace lsset cm</B
3815 ></SPAN
3816 >
3817 </PRE
3818 ><P
3819 >If tracing has not been enabled previously or if tracing has been turned off on the client machine, the following output
3820       is displayed:</P
3821 ><PRE
3822 CLASS="programlisting"
3823 >&#13;   Available sets:
3824    cm inactive
3825 </PRE
3826 ><P
3827 >If tracing has been turned off and kernel memory is not allocated for the trace log on the client machine, the following
3828       output is displayed:</P
3829 ><PRE
3830 CLASS="programlisting"
3831 >&#13;   Available sets:
3832    cm inactive (dormant)
3833 </PRE
3834 ><P
3835 >If the current state of the <SPAN
3836 CLASS="bold"
3837 ><B
3838 CLASS="emphasis"
3839 >cm</B
3840 ></SPAN
3841 > event set is <SAMP
3842 CLASS="computeroutput"
3843 >inactive</SAMP
3844 >
3845       or <SAMP
3846 CLASS="computeroutput"
3847 >inactive (dormant)</SAMP
3848 >, turn on kernel tracing by issuing the <SPAN
3849 CLASS="bold"
3850 ><B
3851 CLASS="emphasis"
3852 >fstrace
3853       setset</B
3854 ></SPAN
3855 > command with the <SPAN
3856 CLASS="bold"
3857 ><B
3858 CLASS="emphasis"
3859 >-active</B
3860 ></SPAN
3861 > flag.</P
3862 ><PRE
3863 CLASS="programlisting"
3864 >&#13;   # <SPAN
3865 CLASS="bold"
3866 ><B
3867 CLASS="emphasis"
3868 >fstrace setset cm -active</B
3869 ></SPAN
3870 >
3871 </PRE
3872 ><P
3873 >If tracing is enabled currently on the client machine, the following output is displayed:</P
3874 ><PRE
3875 CLASS="programlisting"
3876 >&#13;   Available sets:
3877    cm active
3878 </PRE
3879 ><P
3880 >If tracing is enabled currently, you do not need to use the <SPAN
3881 CLASS="bold"
3882 ><B
3883 CLASS="emphasis"
3884 >fstrace setset</B
3885 ></SPAN
3886 > command. Do
3887       issue the <SPAN
3888 CLASS="bold"
3889 ><B
3890 CLASS="emphasis"
3891 >fstrace clear</B
3892 ></SPAN
3893 > command to clear the contents of any existing trace log, removing
3894       prior traces that are not related to the current problem.</P
3895 ><PRE
3896 CLASS="programlisting"
3897 >&#13;   # <SPAN
3898 CLASS="bold"
3899 ><B
3900 CLASS="emphasis"
3901 >fstrace clear cm</B
3902 ></SPAN
3903 >
3904 </PRE
3905 ><P
3906 >After checking on the state of the event set, issue the <SPAN
3907 CLASS="bold"
3908 ><B
3909 CLASS="emphasis"
3910 >fstrace lslog</B
3911 ></SPAN
3912 > command with the
3913       <SPAN
3914 CLASS="bold"
3915 ><B
3916 CLASS="emphasis"
3917 >-long</B
3918 ></SPAN
3919 > flag to check the current state and size of the kernel trace log .</P
3920 ><PRE
3921 CLASS="programlisting"
3922 >&#13;   # <SPAN
3923 CLASS="bold"
3924 ><B
3925 CLASS="emphasis"
3926 >fstrace lslog cmfx -long</B
3927 ></SPAN
3928 >
3929 </PRE
3930 ><P
3931 >If tracing has not been enabled previously or the <SPAN
3932 CLASS="bold"
3933 ><B
3934 CLASS="emphasis"
3935 >cm</B
3936 ></SPAN
3937 > event set was set to
3938       <SAMP
3939 CLASS="computeroutput"
3940 >active</SAMP
3941 > or <SAMP
3942 CLASS="computeroutput"
3943 >inactive</SAMP
3944 > previously, output similar to the
3945       following is displayed:</P
3946 ><PRE
3947 CLASS="programlisting"
3948 >&#13;   Available logs:
3949    cmfx : 60 kbytes (allocated)
3950 </PRE
3951 ><P
3952 >The <SPAN
3953 CLASS="bold"
3954 ><B
3955 CLASS="emphasis"
3956 >fstrace</B
3957 ></SPAN
3958 > tracing utility allocates 60 kilobytes of memory to the trace log by
3959       default. You can increase or decrease the amount of memory allocated to the kernel trace log by setting it with the <SPAN
3960 CLASS="bold"
3961 ><B
3962 CLASS="emphasis"
3963 >fstrace setlog</B
3964 ></SPAN
3965 > command. The number specified with the <SPAN
3966 CLASS="bold"
3967 ><B
3968 CLASS="emphasis"
3969 >-buffersize</B
3970 ></SPAN
3971 >
3972       argument represents the number of kilobytes allocated to the kernel trace log. If you increase the size of the kernel trace
3973       log to 100 kilobytes, issue the following command.</P
3974 ><PRE
3975 CLASS="programlisting"
3976 >&#13;   # <SPAN
3977 CLASS="bold"
3978 ><B
3979 CLASS="emphasis"
3980 >fstrace setlog cmfx</B
3981 ></SPAN
3982 > 100
3983 </PRE
3984 ><P
3985 >After ensuring that the kernel trace log is configured for your needs, you can set up a file into which you can dump the
3986       kernel trace log. For example, create a dump file with the name <SPAN
3987 CLASS="bold"
3988 ><B
3989 CLASS="emphasis"
3990 >cmfx.dump.file.1</B
3991 ></SPAN
3992 > using the
3993       following <SPAN
3994 CLASS="bold"
3995 ><B
3996 CLASS="emphasis"
3997 >fstrace dump</B
3998 ></SPAN
3999 > command. Issue the command as a continuous process by adding the
4000       <SPAN
4001 CLASS="bold"
4002 ><B
4003 CLASS="emphasis"
4004 >-follow</B
4005 ></SPAN
4006 > and <SPAN
4007 CLASS="bold"
4008 ><B
4009 CLASS="emphasis"
4010 >-sleep</B
4011 ></SPAN
4012 > arguments. Setting the <SPAN
4013 CLASS="bold"
4014 ><B
4015 CLASS="emphasis"
4016 >-sleep</B
4017 ></SPAN
4018 > argument to <SPAN
4019 CLASS="emphasis"
4020 ><I
4021 CLASS="emphasis"
4022 >10</I
4023 ></SPAN
4024 > dumps output from the kernel trace log to the file every 10
4025       seconds.</P
4026 ><PRE
4027 CLASS="programlisting"
4028 >&#13;   # <SPAN
4029 CLASS="bold"
4030 ><B
4031 CLASS="emphasis"
4032 >fstrace dump -follow</B
4033 ></SPAN
4034 > cmfx <SPAN
4035 CLASS="bold"
4036 ><B
4037 CLASS="emphasis"
4038 >-file</B
4039 ></SPAN
4040 > cmfx.dump.file.1 <SPAN
4041 CLASS="bold"
4042 ><B
4043 CLASS="emphasis"
4044 >-sleep</B
4045 ></SPAN
4046 > 10
4047    AFS Trace Dump -
4048       Date: Fri Apr 16 10:54:57 1999
4049    Found 1 logs.
4050    time 32.965783, pid 0: Fri Apr 16 10:45:52 1999
4051    time 32.965783, pid 33657: Close 0x5c39ed8 flags 0x20 
4052    time 32.965897, pid 33657: Gn_close vp 0x5c39ed8 flags 0x20 (returns
4053    0x0) 
4054    time 35.159854, pid 10891: Breaking callback for 5bd95e4 states 1024
4055    (volume 0)
4056    time 35.407081, pid 10891: Breaking callback for 5c0fadc states 1024
4057    (volume 0)
4058        .                         .
4059        .                         .
4060        .                         .
4061    time 71.440456, pid 33658: Lookup adp 0x5bbdcf0 name g3oCKs fid (756
4062    4fb7e:588d240.2ff978a8.6) 
4063    time 71.440569, pid 33658: Returning code 2 from 19 
4064    time 71.440619, pid 33658: Gn_lookup vp 0x5bbdcf0 name g3oCKs (returns
4065    0x2) 
4066    time 71.464989, pid 38267: Gn_open vp 0x5bbd000 flags 0x0 (returns 0x
4067    0) 
4068    AFS Trace Dump - Completed
4069 </PRE
4070 ></DIV
4071 ></DIV
4072 ><DIV
4073 CLASS="sect1"
4074 ><H1
4075 CLASS="sect1"
4076 ><A
4077 NAME="HDRWQ349"
4078 >Using the afsmonitor Program</A
4079 ></H1
4080 ><P
4081 >The <SPAN
4082 CLASS="bold"
4083 ><B
4084 CLASS="emphasis"
4085 >afsmonitor</B
4086 ></SPAN
4087 > program enables you to monitor the status and performance of specified
4088     File Server and Cache Manager processes by gathering statistical information. Among its other uses, the <SPAN
4089 CLASS="bold"
4090 ><B
4091 CLASS="emphasis"
4092 >afsmonitor</B
4093 ></SPAN
4094 > program can be used to fine-tune Cache Manager configuration and load balance File
4095     Servers.</P
4096 ><P
4097 >The <SPAN
4098 CLASS="bold"
4099 ><B
4100 CLASS="emphasis"
4101 >afsmonitor</B
4102 ></SPAN
4103 > program enables you to perform the following tasks. <UL
4104 ><LI
4105 ><P
4106 >Monitor any number of File Server and Cache Manager processes on any number of machines (in both local and foreign
4107           cells) from a single location.</P
4108 ></LI
4109 ><LI
4110 ><P
4111 >Set threshold values for any monitored statistic. When the value of a statistic exceeds the threshold, the <SPAN
4112 CLASS="bold"
4113 ><B
4114 CLASS="emphasis"
4115 >afsmonitor</B
4116 ></SPAN
4117 > program highlights it to draw your attention. You can set threshold levels that apply to
4118           every machine or only some.</P
4119 ></LI
4120 ><LI
4121 ><P
4122 >Invoke programs or scripts automatically when a statistic exceeds its threshold.</P
4123 ></LI
4124 ></UL
4125 ></P
4126 ><DIV
4127 CLASS="sect2"
4128 ><H2
4129 CLASS="sect2"
4130 ><A
4131 NAME="HDRWQ350"
4132 >Requirements for running the afsmonitor program</A
4133 ></H2
4134 ><P
4135 >The following software must be accessible to a machine where the <SPAN
4136 CLASS="bold"
4137 ><B
4138 CLASS="emphasis"
4139 >afsmonitor</B
4140 ></SPAN
4141 > program is
4142       running: <UL
4143 ><LI
4144 ><P
4145 >The AFS <SPAN
4146 CLASS="bold"
4147 ><B
4148 CLASS="emphasis"
4149 >xstat</B
4150 ></SPAN
4151 > libraries, which the <SPAN
4152 CLASS="bold"
4153 ><B
4154 CLASS="emphasis"
4155 >afsmonitor</B
4156 ></SPAN
4157 >
4158             program uses to gather data</P
4159 ></LI
4160 ><LI
4161 ><P
4162 >The <SPAN
4163 CLASS="bold"
4164 ><B
4165 CLASS="emphasis"
4166 >curses</B
4167 ></SPAN
4168 > graphics package, which most UNIX distributions provide as a standard
4169             utility</P
4170 ></LI
4171 ></UL
4172 ></P
4173 ><P
4174 >The <SPAN
4175 CLASS="bold"
4176 ><B
4177 CLASS="emphasis"
4178 >afsmonitor</B
4179 ></SPAN
4180 > screens format successfully both on so-called dumb terminals and in
4181       windowing systems that emulate terminals. For the output to looks its best, the display environment needs to support reverse
4182       video and cursor addressing. Set the TERM environment variable to the correct terminal type, or to a value that has
4183       characteristics similar to the actual terminal type. The display window or terminal must be at least 80 columns wide and 12
4184       lines long.</P
4185 ><P
4186 >The <SPAN
4187 CLASS="bold"
4188 ><B
4189 CLASS="emphasis"
4190 >afsmonitor</B
4191 ></SPAN
4192 > program must run in the foreground, and in its own separate, dedicated
4193       window or terminal. The window or terminal is unavailable for any other activity as long as the <SPAN
4194 CLASS="bold"
4195 ><B
4196 CLASS="emphasis"
4197 >afsmonitor</B
4198 ></SPAN
4199 > program is running. Any number of instances of the <SPAN
4200 CLASS="bold"
4201 ><B
4202 CLASS="emphasis"
4203 >afsmonitor</B
4204 ></SPAN
4205 > program can run on a single machine, as long as each instance runs in its own dedicated
4206       window or terminal. Note that it can take up to three minutes to start an additional instance.</P
4207 ><P
4208 >No privilege is required to run the <SPAN
4209 CLASS="bold"
4210 ><B
4211 CLASS="emphasis"
4212 >afsmonitor</B
4213 ></SPAN
4214 > program. By convention, it is installed
4215       in the <SPAN
4216 CLASS="bold"
4217 ><B
4218 CLASS="emphasis"
4219 >/usr/afsws/bin</B
4220 ></SPAN
4221 > directory, and anyone who can access the directory can monitor File
4222       Servers and Cache Managers. The probes through which the <SPAN
4223 CLASS="bold"
4224 ><B
4225 CLASS="emphasis"
4226 >afsmonitor</B
4227 ></SPAN
4228 > program collects
4229       statistics do not constitute a significant burden on the File Server or Cache Manager unless hundreds of people are running
4230       the program. If you wish to restrict its use, place the binary file in a directory available only to authorized users.</P
4231 ></DIV
4232 ><DIV
4233 CLASS="sect2"
4234 ><H2
4235 CLASS="sect2"
4236 ><A
4237 NAME="Header_392"
4238 >The afsmonitor Output Screens</A
4239 ></H2
4240 ><P
4241 >The <SPAN
4242 CLASS="bold"
4243 ><B
4244 CLASS="emphasis"
4245 >afsmonitor</B
4246 ></SPAN
4247 > program displays its data on three screens: <UL
4248 ><LI
4249 ><P
4250 ><SAMP
4251 CLASS="computeroutput"
4252 >System Overview</SAMP
4253 >: This screen appears automatically when the <SPAN
4254 CLASS="bold"
4255 ><B
4256 CLASS="emphasis"
4257 >afsmonitor</B
4258 ></SPAN
4259 > program initializes. It summarizes separately for File Servers and Cache Managers the
4260             number of machines being monitored and how many of them have <SPAN
4261 CLASS="emphasis"
4262 ><I
4263 CLASS="emphasis"
4264 >alerts</I
4265 ></SPAN
4266 > (statistics that have exceeded
4267             their thresholds). It then lists the hostname and number of alerts for each machine being monitored, indicating if
4268             appropriate that a process failed to respond to the last probe.</P
4269 ></LI
4270 ><LI
4271 ><P
4272 ><SAMP
4273 CLASS="computeroutput"
4274 >File Server</SAMP
4275 >: This screen displays File Server statistics for each file server
4276             machine being monitored. It highlights statistics that have exceeded their thresholds, and identifies machines that
4277             failed to respond to the last probe.</P
4278 ></LI
4279 ><LI
4280 ><P
4281 ><SAMP
4282 CLASS="computeroutput"
4283 >Cache Managers</SAMP
4284 >: This screen displays Cache Manager statistics for each client
4285             machine being monitored. It highlights statistics that have exceeded their thresholds, and identifies machines that
4286             failed to respond to the last probe.</P
4287 ></LI
4288 ></UL
4289 ></P
4290 ><P
4291 >Fields at the corners of every screen display the following information: <UL
4292 ><LI
4293 ><P
4294 >In the top left corner, the program name and version number.</P
4295 ></LI
4296 ><LI
4297 ><P
4298 >In the top right corner, the screen name, current and total page numbers, and current and total column numbers.
4299             The page number (for example, <SAMP
4300 CLASS="computeroutput"
4301 >p. 1 of 3</SAMP
4302 >) indicates the index of the current page and
4303             the total number of (vertical) pages over which data is displayed. The column number (for example, <SAMP
4304 CLASS="computeroutput"
4305 >c. 1
4306             of 235</SAMP
4307 >) indicates the index of the current leftmost column and the total number of columns in which
4308             data appears. (The symbol <SAMP
4309 CLASS="computeroutput"
4310 >&#62;&#62;&#62;</SAMP
4311 > indicates that there is additional data to the
4312             right; the symbol <SAMP
4313 CLASS="computeroutput"
4314 >&#60;&#60;&#60;</SAMP
4315 > indicates that there is additional data to the
4316             left.)</P
4317 ></LI
4318 ><LI
4319 ><P
4320 >In the bottom left corner, a list of the available commands. Enter the first letter in the command name to run
4321             that command. Only the currently possible options appear; for example, if there is only one page of data, the
4322             <SAMP
4323 CLASS="computeroutput"
4324 >next</SAMP
4325 > and <SAMP
4326 CLASS="computeroutput"
4327 >prev</SAMP
4328 > commands, which scroll the screen up and
4329             down respectively, do not appear. For descriptions of the commands, see the following section about navigating the
4330             display screens.</P
4331 ></LI
4332 ><LI
4333 ><P
4334 >In the bottom right corner, the <SAMP
4335 CLASS="computeroutput"
4336 >probes</SAMP
4337 > field reports how many times the program
4338             has probed File Servers (<SAMP
4339 CLASS="computeroutput"
4340 >fs</SAMP
4341 >), Cache Managers (<SAMP
4342 CLASS="computeroutput"
4343 >cm</SAMP
4344 >), or
4345             both. The counts for File Servers and Cache Managers can differ. The <SAMP
4346 CLASS="computeroutput"
4347 >freq</SAMP
4348 > field reports
4349             how often the program sends probes.</P
4350 ></LI
4351 ></UL
4352 ></P
4353 ><P
4354 ><SPAN
4355 CLASS="bold"
4356 ><B
4357 CLASS="emphasis"
4358 >Navigating the afsmonitor Display Screens</B
4359 ></SPAN
4360 ></P
4361 ><P
4362 >As noted, the lower left hand corner of every display screen displays the names of the commands currently available for
4363       moving to alternate screens, which can either be a different type or display more statistics or machines of the current type.
4364       To execute a command, press the lowercase version of the first letter in its name. Some commands also have an uppercase
4365       version that has a somewhat different effect, as indicated in the following list. <DIV
4366 CLASS="variablelist"
4367 ><DL
4368 ><DT
4369 ><SAMP
4370 CLASS="computeroutput"
4371 >cm</SAMP
4372 ></DT
4373 ><DD
4374 ><P
4375 >Switches to the <SAMP
4376 CLASS="computeroutput"
4377 >Cache Managers</SAMP
4378 > screen. Available only on the
4379               <SAMP
4380 CLASS="computeroutput"
4381 >System Overview</SAMP
4382 > and <SAMP
4383 CLASS="computeroutput"
4384 >File Servers</SAMP
4385 > screens.</P
4386 ></DD
4387 ><DT
4388 ><SAMP
4389 CLASS="computeroutput"
4390 >fs</SAMP
4391 ></DT
4392 ><DD
4393 ><P
4394 >Switches to the <SAMP
4395 CLASS="computeroutput"
4396 >File Servers</SAMP
4397 > screen. Available only on the
4398               <SAMP
4399 CLASS="computeroutput"
4400 >System Overview</SAMP
4401 > and the <SAMP
4402 CLASS="computeroutput"
4403 >Cache Managers</SAMP
4404 >
4405               screens.</P
4406 ></DD
4407 ><DT
4408 ><SAMP
4409 CLASS="computeroutput"
4410 >left</SAMP
4411 ></DT
4412 ><DD
4413 ><P
4414 >Scrolls horizontally to the left, to access the data columns situated to the left of the current set. Available
4415               when the <SAMP
4416 CLASS="computeroutput"
4417 >&#60;&#60;&#60;</SAMP
4418 > symbol appears at the top left of the screen. Press uppercase
4419               <SPAN
4420 CLASS="bold"
4421 ><B
4422 CLASS="emphasis"
4423 >L</B
4424 ></SPAN
4425 > to scroll horizontally all the way to the left (to display the first set of data
4426               columns).</P
4427 ></DD
4428 ><DT
4429 ><SAMP
4430 CLASS="computeroutput"
4431 >next</SAMP
4432 ></DT
4433 ><DD
4434 ><P
4435 >Scrolls down vertically to the next page of machine names. Available when there are two or more pages of
4436               machines and the final page is not currently displayed. Press uppercase <SPAN
4437 CLASS="bold"
4438 ><B
4439 CLASS="emphasis"
4440 >N</B
4441 ></SPAN
4442 > to scroll
4443               to the final page.</P
4444 ></DD
4445 ><DT
4446 ><SAMP
4447 CLASS="computeroutput"
4448 >oview</SAMP
4449 ></DT
4450 ><DD
4451 ><P
4452 >Switches to the <SAMP
4453 CLASS="computeroutput"
4454 >System Overview</SAMP
4455 > screen. Available only on the
4456               <SAMP
4457 CLASS="computeroutput"
4458 >Cache Managers</SAMP
4459 > and <SAMP
4460 CLASS="computeroutput"
4461 >File Servers</SAMP
4462 > screens.</P
4463 ></DD
4464 ><DT
4465 ><SAMP
4466 CLASS="computeroutput"
4467 >prev</SAMP
4468 ></DT
4469 ><DD
4470 ><P
4471 >Scrolls up vertically to the previous page of machine names. Available when there are two or more pages of
4472               machines and the first page is not currently displayed. Press uppercase <SPAN
4473 CLASS="bold"
4474 ><B
4475 CLASS="emphasis"
4476 >N</B
4477 ></SPAN
4478 > to scroll
4479               to the first page.</P
4480 ></DD
4481 ><DT
4482 ><SAMP
4483 CLASS="computeroutput"
4484 >right</SAMP
4485 ></DT
4486 ><DD
4487 ><P
4488 >Scrolls horizontally to the right, to access the data columns situated to the right of the current set. This
4489               command is available when the <SAMP
4490 CLASS="computeroutput"
4491 >&#62;&#62;&#62;</SAMP
4492 > symbol appears at the upper right of the
4493               screen. Press uppercase <SPAN
4494 CLASS="bold"
4495 ><B
4496 CLASS="emphasis"
4497 >R</B
4498 ></SPAN
4499 > to scroll horizontally all the way to the right (to display
4500               the final set of data columns).</P
4501 ></DD
4502 ></DL
4503 ></DIV
4504 ></P
4505 ></DIV
4506 ><DIV
4507 CLASS="sect2"
4508 ><H2
4509 CLASS="sect2"
4510 ><A
4511 NAME="Header_393"
4512 >The System Overview Screen</A
4513 ></H2
4514 ><P
4515 >The <SAMP
4516 CLASS="computeroutput"
4517 >System Overview</SAMP
4518 > screen appears automatically as the <SPAN
4519 CLASS="bold"
4520 ><B
4521 CLASS="emphasis"
4522 >afsmonitor</B
4523 ></SPAN
4524 > program initializes. This screen displays the status of as many File Server and Cache
4525       Manager processes as can fit in the current window; scroll down to access additional information.</P
4526 ><P
4527 >The information on this screen is split into File Server information on the left and Cache Manager information on the
4528       right. The header for each grouping reports two pieces of information: <UL
4529 ><LI
4530 ><P
4531 >The number of machines on which the program is monitoring the indicated process</P
4532 ></LI
4533 ><LI
4534 ><P
4535 >The number of alerts and the number of machines affected by them (an <SPAN
4536 CLASS="emphasis"
4537 ><I
4538 CLASS="emphasis"
4539 >alert</I
4540 ></SPAN
4541 > means that a
4542             statistic has exceeded its threshold or a process failed to respond to the last probe)</P
4543 ></LI
4544 ></UL
4545 ></P
4546 ><P
4547 >A list of the machines being monitored follows. If there are any alerts on a machine, the number of them appears in
4548       square brackets to the left of the hostname. If a process failed to respond to the last probe, the letters
4549       <SAMP
4550 CLASS="computeroutput"
4551 >PF</SAMP
4552 > (probe failure) appear in square brackets to the left of the hostname.</P
4553 ><P
4554 >The following graphic is an example <SAMP
4555 CLASS="computeroutput"
4556 >System Overview</SAMP
4557 > screen. The <SPAN
4558 CLASS="bold"
4559 ><B
4560 CLASS="emphasis"
4561 >afsmonitor</B
4562 ></SPAN
4563 > program is monitoring six File Servers and seven Cache Managers. The File Server process on
4564       host <SPAN
4565 CLASS="bold"
4566 ><B
4567 CLASS="emphasis"
4568 >fs1.abc.com</B
4569 ></SPAN
4570 > and the Cache Manager on host <SPAN
4571 CLASS="bold"
4572 ><B
4573 CLASS="emphasis"
4574 >cli33.abc.com</B
4575 ></SPAN
4576 >
4577       are each marked <SAMP
4578 CLASS="computeroutput"
4579 >[ 1]</SAMP
4580 > to indicate that one threshold value is exceeded. The
4581       <SAMP
4582 CLASS="computeroutput"
4583 >[PF]</SAMP
4584 > marker on host <SPAN
4585 CLASS="bold"
4586 ><B
4587 CLASS="emphasis"
4588 >fs6.abc.com</B
4589 ></SPAN
4590 > indicates that its File
4591       Server process did not respond to the last probe.</P
4592 ><DIV
4593 CLASS="figure"
4594 ><A
4595 NAME="Figure_6"
4596 ></A
4597 ><DIV
4598 CLASS="mediaobject"
4599 ><P
4600 ><IMG
4601 SRC="overview.png"></P
4602 ></DIV
4603 ><P
4604 ><B
4605 >Figure 6. The afsmonitor System Overview Screen</B
4606 ></P
4607 ></DIV
4608 ><P
4609 ><SPAN
4610 CLASS="bold"
4611 ><B
4612 CLASS="emphasis"
4613 > </B
4614 ></SPAN
4615 ></P
4616 ></DIV
4617 ><DIV
4618 CLASS="sect2"
4619 ><H2
4620 CLASS="sect2"
4621 ><A
4622 NAME="Header_394"
4623 >The File Servers Screen</A
4624 ></H2
4625 ><P
4626 >The <SAMP
4627 CLASS="computeroutput"
4628 >File Servers</SAMP
4629 > screen displays the values collected at the most recent probe for File
4630       Server statistics.</P
4631 ><P
4632 >A summary line at the top of the screen (just below the standard program version and screen title blocks) specifies the
4633       number of monitored File Servers, the number of alerts, and the number of machines affected by the alerts.</P
4634 ><P
4635 >The first column always displays the hostnames of the machines running the monitored File Servers.</P
4636 ><P
4637 >To the right of the hostname column appear as many columns of statistics as can fit within the current width of the
4638       display screen or window; each column requires space for 10 characters. The name of the statistic appears at the top of each
4639       column. If the File Server on a machine did not respond to the most recent probe, a pair of dashes
4640       (<SAMP
4641 CLASS="computeroutput"
4642 >--</SAMP
4643 >) appears in each column. If a value exceeds its configured threshold, it is highlighted
4644       in reverse video. If a value is too large to fit into the allotted column width, it overflows into the next row in the same
4645       column.</P
4646 ><P
4647 >For a list of the available File Server statistics, see <A
4648 HREF="a34149.html"
4649 >Appendix C, The afsmonitor Program
4650       Statistics</A
4651 >.</P
4652 ><P
4653 >The following graphic depicts the <SAMP
4654 CLASS="computeroutput"
4655 >File Servers</SAMP
4656 > screen that follows the System Overview
4657       Screen example previously discussed; however, one additional server probe has been completed. In this example, the File Server
4658       process on <SPAN
4659 CLASS="bold"
4660 ><B
4661 CLASS="emphasis"
4662 >fs1</B
4663 ></SPAN
4664 > has exceeded the configured threshold for the number of performance calls
4665       received (the <SPAN
4666 CLASS="bold"
4667 ><B
4668 CLASS="emphasis"
4669 >numPerfCalls</B
4670 ></SPAN
4671 > statistic), and that field appears in reverse video. Host
4672       <SPAN
4673 CLASS="bold"
4674 ><B
4675 CLASS="emphasis"
4676 >fs6</B
4677 ></SPAN
4678 > did not respond to Probe 10, so dashes appear in all fields.</P
4679 ><DIV
4680 CLASS="figure"
4681 ><A
4682 NAME="Figure_7"
4683 ></A
4684 ><DIV
4685 CLASS="mediaobject"
4686 ><P
4687 ><IMG
4688 SRC="fserver1.png"></P
4689 ></DIV
4690 ><P
4691 ><B
4692 >Figure 7. The afsmonitor File Servers Screen</B
4693 ></P
4694 ></DIV
4695 ><P
4696 ><SPAN
4697 CLASS="bold"
4698 ><B
4699 CLASS="emphasis"
4700 > </B
4701 ></SPAN
4702 ></P
4703 ><P
4704 >Both the File Servers and Cache Managers screen (discussed in the following section) can display hundreds of columns of
4705       data and are therefore designed to scroll left and right. In the preceding graphic, the screen displays the leftmost screen
4706       and the screen title block shows that column 1 of 235 is displayed. The appearance of the
4707       <SAMP
4708 CLASS="computeroutput"
4709 >&#62;&#62;&#62;</SAMP
4710 > symbol in the upper right hand corner of the screen and the <SPAN
4711 CLASS="bold"
4712 ><B
4713 CLASS="emphasis"
4714 >right</B
4715 ></SPAN
4716 > command in the command block indicate that additional data is available by scrolling right. (For
4717       information on the available statistics, see <A
4718 HREF="a34149.html"
4719 >Appendix C, The afsmonitor Program
4720       Statistics</A
4721 >.)</P
4722 ><P
4723 >If the <SPAN
4724 CLASS="bold"
4725 ><B
4726 CLASS="emphasis"
4727 >right</B
4728 ></SPAN
4729 > command is executed, the screen looks something like the following
4730       example. Note that the horizontal scroll symbols now point both to the left (<SAMP
4731 CLASS="computeroutput"
4732 >&#60;&#60;&#60;</SAMP
4733 >)
4734       and to the right (<SAMP
4735 CLASS="computeroutput"
4736 >&#62;&#62;&#62;</SAMP
4737 >) and both the <SPAN
4738 CLASS="bold"
4739 ><B
4740 CLASS="emphasis"
4741 >left</B
4742 ></SPAN
4743 > and
4744       <SPAN
4745 CLASS="bold"
4746 ><B
4747 CLASS="emphasis"
4748 >right</B
4749 ></SPAN
4750 > commands appear, indicating that additional data is available by scrolling both left
4751       and right.</P
4752 ><DIV
4753 CLASS="figure"
4754 ><A
4755 NAME="Figure_8"
4756 ></A
4757 ><DIV
4758 CLASS="mediaobject"
4759 ><P
4760 ><IMG
4761 SRC="fserver2.png"></P
4762 ></DIV
4763 ><P
4764 ><B
4765 >Figure 8. The afsmonitor File Servers Screen Shifted One Page to the Right</B
4766 ></P
4767 ></DIV
4768 ><P
4769 ><SPAN
4770 CLASS="bold"
4771 ><B
4772 CLASS="emphasis"
4773 > </B
4774 ></SPAN
4775 ></P
4776 ></DIV
4777 ><DIV
4778 CLASS="sect2"
4779 ><H2
4780 CLASS="sect2"
4781 ><A
4782 NAME="Header_395"
4783 >The Cache Managers Screen</A
4784 ></H2
4785 ><P
4786 >The <SAMP
4787 CLASS="computeroutput"
4788 >Cache Managers</SAMP
4789 > screen displays the values collected at the most recent probe for
4790       Cache Manager statistics.</P
4791 ><P
4792 >A summary line at the top of the screen (just below the standard program version and screen title blocks) specifies the
4793       number of monitored Cache Managers, the number of alerts, and the number of machines affected by the alerts.</P
4794 ><P
4795 >The first column always displays the hostnames of the machines running the monitored Cache Managers.</P
4796 ><P
4797 >To the right of the hostname column appear as many columns of statistics as can fit within the current width of the
4798       display screen or window; each column requires space for 10 characters. The name of the statistic appears at the top of each
4799       column. If the Cache Manager on a machine did not respond to the most recent probe, a pair of dashes
4800       (<SAMP
4801 CLASS="computeroutput"
4802 >--</SAMP
4803 >) appears in each column. If a value exceeds its configured threshold, it is highlighted
4804       in reverse video. If a value is too large to fit into the allotted column width, it overflows into the next row in the same
4805       column.</P
4806 ><P
4807 >For a list of the available Cache Manager statistics, see <A
4808 HREF="a34149.html"
4809 >Appendix C, The afsmonitor Program
4810       Statistics</A
4811 >.</P
4812 ><P
4813 >The following graphic depicts a Cache Managers screen that follows the System Overview Screen previously discussed. In
4814       the example, the Cache Manager process on host <SPAN
4815 CLASS="bold"
4816 ><B
4817 CLASS="emphasis"
4818 >cli33</B
4819 ></SPAN
4820 > has exceeded the configured threshold
4821       for the number of cells it can contact (the <SPAN
4822 CLASS="bold"
4823 ><B
4824 CLASS="emphasis"
4825 >numCellsContacted</B
4826 ></SPAN
4827 > statistic), so that field
4828       appears in reverse video.</P
4829 ><DIV
4830 CLASS="figure"
4831 ><A
4832 NAME="Figure_9"
4833 ></A
4834 ><DIV
4835 CLASS="mediaobject"
4836 ><P
4837 ><IMG
4838 SRC="cachmgr.png"></P
4839 ></DIV
4840 ><P
4841 ><B
4842 >Figure 9. The afsmonitor Cache Managers Screen</B
4843 ></P
4844 ></DIV
4845 ><P
4846 ><SPAN
4847 CLASS="bold"
4848 ><B
4849 CLASS="emphasis"
4850 > </B
4851 ></SPAN
4852 ></P
4853 ></DIV
4854 ></DIV
4855 ><DIV
4856 CLASS="sect1"
4857 ><H1
4858 CLASS="sect1"
4859 ><A
4860 NAME="HDRWQ351"
4861 >Configuring the afsmonitor Program</A
4862 ></H1
4863 ><P
4864 >To customize the <SPAN
4865 CLASS="bold"
4866 ><B
4867 CLASS="emphasis"
4868 >afsmonitor</B
4869 ></SPAN
4870 > program, create an ASCII-format configuration file and use
4871     the <SPAN
4872 CLASS="bold"
4873 ><B
4874 CLASS="emphasis"
4875 >-config</B
4876 ></SPAN
4877 > argument to name it. You can specify the following in the configuration file:
4878     <UL
4879 ><LI
4880 ><P
4881 >The File Servers, Cache Managers, or both to monitor.</P
4882 ></LI
4883 ><LI
4884 ><P
4885 >The statistics to display. By default, the display includes 271 statistics for File Servers and 570 statistics for
4886           Cache Managers. For information on the available statistics, see <A
4887 HREF="a34149.html"
4888 >Appendix C, The afsmonitor
4889           Program Statistics</A
4890 >.</P
4891 ></LI
4892 ><LI
4893 ><P
4894 >The threshold values to set for statistics and a script or program to execute if a threshold is exceeded. By
4895           default, no threshold values are defined and no scripts or programs are executed.</P
4896 ></LI
4897 ></UL
4898 ></P
4899 ><P
4900 >The following list describes the instructions that can appear in the configuration file: <DIV
4901 CLASS="variablelist"
4902 ><DL
4903 ><DT
4904 ><SAMP
4905 CLASS="computeroutput"
4906 >cm</SAMP
4907 > <VAR
4908 CLASS="replaceable"
4909 >hostname</VAR
4910 ></DT
4911 ><DD
4912 ><P
4913 >Names a client machine for which to display Cache Manager statistics. The order of <SPAN
4914 CLASS="bold"
4915 ><B
4916 CLASS="emphasis"
4917 >cm</B
4918 ></SPAN
4919 > lines in the file determines the order in which client machines appear from top to bottom on
4920             the <SAMP
4921 CLASS="computeroutput"
4922 >System Overview</SAMP
4923 > and <SAMP
4924 CLASS="computeroutput"
4925 >Cache Managers</SAMP
4926 > output
4927             screens.</P
4928 ></DD
4929 ><DT
4930 ><SAMP
4931 CLASS="computeroutput"
4932 >fs</SAMP
4933 > <VAR
4934 CLASS="replaceable"
4935 >hostname</VAR
4936 ></DT
4937 ><DD
4938 ><P
4939 >Names a file server machine for which to display File Server statistics. The order of <SPAN
4940 CLASS="bold"
4941 ><B
4942 CLASS="emphasis"
4943 >fs</B
4944 ></SPAN
4945 > lines in the file determines the order in which file server machines appear from top to bottom
4946             on the <SAMP
4947 CLASS="computeroutput"
4948 >System Overview</SAMP
4949 > and <SAMP
4950 CLASS="computeroutput"
4951 >File Servers</SAMP
4952 > output
4953             screens.</P
4954 ></DD
4955 ><DT
4956 ><SAMP
4957 CLASS="computeroutput"
4958 >thresh fs | cm <VAR
4959 CLASS="replaceable"
4960 >field_name</VAR
4961 > <VAR
4962 CLASS="replaceable"
4963 >thresh_val</VAR
4964 >
4965           [<VAR
4966 CLASS="replaceable"
4967 >cmd_to_run</VAR
4968 >] [<VAR
4969 CLASS="replaceable"
4970 >arg1</VAR
4971 >] . . .
4972           [<VAR
4973 CLASS="replaceable"
4974 >argn</VAR
4975 >]</SAMP
4976 ></DT
4977 ><DD
4978 ><P
4979 >Assigns the threshold value thresh_val to the statistic field_name, for either a File Server statistic (<SPAN
4980 CLASS="bold"
4981 ><B
4982 CLASS="emphasis"
4983 >fs</B
4984 ></SPAN
4985 >) or a Cache Manager statistic (<SPAN
4986 CLASS="bold"
4987 ><B
4988 CLASS="emphasis"
4989 >cm</B
4990 ></SPAN
4991 >). The optional
4992             cmd_to_execute field names a binary or script to execute each time the value of the statistic changes from being below
4993             thresh_val to being at or above thresh_val. A change between two values that both exceed thresh_val does not retrigger
4994             the binary or script. The optional arg1 through argn fields are additional values that the <SPAN
4995 CLASS="bold"
4996 ><B
4997 CLASS="emphasis"
4998 >afsmonitor</B
4999 ></SPAN
5000 > program passes as arguments to the cmd_to_execute command. If any of them include one
5001             or more spaces, enclose the entire field in double quotes.</P
5002 ><P
5003 >The parameters <SPAN
5004 CLASS="bold"
5005 ><B
5006 CLASS="emphasis"
5007 >fs</B
5008 ></SPAN
5009 >, <SPAN
5010 CLASS="bold"
5011 ><B
5012 CLASS="emphasis"
5013 >cm</B
5014 ></SPAN
5015 >, field_name,
5016             threshold_val, and arg1 through argn correspond to the values with the same name on the <SPAN
5017 CLASS="bold"
5018 ><B
5019 CLASS="emphasis"
5020 >thresh</B
5021 ></SPAN
5022 > line. The host_name parameter identifies the file server or client machine where the
5023             statistic has crossed the threshold, and the actual_val parameter is the actual value of field_name that equals or
5024             exceeds the threshold value.</P
5025 ><P
5026 >Use the <SPAN
5027 CLASS="bold"
5028 ><B
5029 CLASS="emphasis"
5030 >thresh</B
5031 ></SPAN
5032 > line to set either a global threshold, which applies to all file
5033             server machines listed on <SPAN
5034 CLASS="bold"
5035 ><B
5036 CLASS="emphasis"
5037 >fs</B
5038 ></SPAN
5039 > lines or client machines listed on <SPAN
5040 CLASS="bold"
5041 ><B
5042 CLASS="emphasis"
5043 >cm</B
5044 ></SPAN
5045 > lines in the configuration file, or a machine-specific threshold, which applies to only one
5046             file server or client machine. <UL
5047 ><LI
5048 ><P
5049 >To set a global threshold, place the <SPAN
5050 CLASS="bold"
5051 ><B
5052 CLASS="emphasis"
5053 >thresh</B
5054 ></SPAN
5055 > line before any of the
5056                   <SPAN
5057 CLASS="bold"
5058 ><B
5059 CLASS="emphasis"
5060 >fs</B
5061 ></SPAN
5062 > or <SPAN
5063 CLASS="bold"
5064 ><B
5065 CLASS="emphasis"
5066 >cm</B
5067 ></SPAN
5068 > lines in the file.</P
5069 ></LI
5070 ><LI
5071 ><P
5072 >To set a machine-specific threshold, place the <SPAN
5073 CLASS="bold"
5074 ><B
5075 CLASS="emphasis"
5076 >thresh</B
5077 ></SPAN
5078 > line below the
5079                   corresponding <SPAN
5080 CLASS="bold"
5081 ><B
5082 CLASS="emphasis"
5083 >fs</B
5084 ></SPAN
5085 > or <SPAN
5086 CLASS="bold"
5087 ><B
5088 CLASS="emphasis"
5089 >cm</B
5090 ></SPAN
5091 > line, and above any other
5092                   <SPAN
5093 CLASS="bold"
5094 ><B
5095 CLASS="emphasis"
5096 >fs</B
5097 ></SPAN
5098 > or <SPAN
5099 CLASS="bold"
5100 ><B
5101 CLASS="emphasis"
5102 >cm</B
5103 ></SPAN
5104 > lines. A machine-specific threshold
5105                   value always overrides the corresponding global threshold, if set. Do not place a <SPAN
5106 CLASS="bold"
5107 ><B
5108 CLASS="emphasis"
5109 >thresh
5110                   fs</B
5111 ></SPAN
5112 > line directly after a <SPAN
5113 CLASS="bold"
5114 ><B
5115 CLASS="emphasis"
5116 >cm</B
5117 ></SPAN
5118 > line or a <SPAN
5119 CLASS="bold"
5120 ><B
5121 CLASS="emphasis"
5122 >thresh
5123                   cm</B
5124 ></SPAN
5125 > line directly after a <SPAN
5126 CLASS="bold"
5127 ><B
5128 CLASS="emphasis"
5129 >fs</B
5130 ></SPAN
5131 > line.</P
5132 ></LI
5133 ></UL
5134 ></P
5135 ></DD
5136 ><DT
5137 ><SAMP
5138 CLASS="computeroutput"
5139 >show fs | cm <VAR
5140 CLASS="replaceable"
5141 >field/group/section</VAR
5142 ></SAMP
5143 ></DT
5144 ><DD
5145 ><P
5146 >Specifies which individual statistic, group of statistics, or section of statistics to display on the
5147             <SAMP
5148 CLASS="computeroutput"
5149 >File Servers</SAMP
5150 > screen (<SPAN
5151 CLASS="bold"
5152 ><B
5153 CLASS="emphasis"
5154 >fs</B
5155 ></SPAN
5156 >) or <SAMP
5157 CLASS="computeroutput"
5158 >Cache
5159             Managers</SAMP
5160 > screen (<SPAN
5161 CLASS="bold"
5162 ><B
5163 CLASS="emphasis"
5164 >cm</B
5165 ></SPAN
5166 >) and the order in which to display them. The
5167             appendix of <SPAN
5168 CLASS="bold"
5169 ><B
5170 CLASS="emphasis"
5171 >afsmonitor</B
5172 ></SPAN
5173 > statistics in the <SPAN
5174 CLASS="emphasis"
5175 ><I
5176 CLASS="emphasis"
5177 >IBM AFS Administration
5178             Guide</I
5179 ></SPAN
5180 > specifies the group and section to which each statistic belongs. Include as many <SPAN
5181 CLASS="bold"
5182 ><B
5183 CLASS="emphasis"
5184 >show</B
5185 ></SPAN
5186 > lines as necessary to customize the screen display as desired, and place them anywhere in
5187             the file. The top-to-bottom order of the <SPAN
5188 CLASS="bold"
5189 ><B
5190 CLASS="emphasis"
5191 >show</B
5192 ></SPAN
5193 > lines in the configuration file
5194             determines the left-to-right order in which the statistics appear on the corresponding screen.</P
5195 ><P
5196 >If there are no <SPAN
5197 CLASS="bold"
5198 ><B
5199 CLASS="emphasis"
5200 >show</B
5201 ></SPAN
5202 > lines in the configuration file, then the screens display
5203             all statistics for both Cache Managers and File Servers. Similarly, if there are no <SPAN
5204 CLASS="bold"
5205 ><B
5206 CLASS="emphasis"
5207 >show
5208             fs</B
5209 ></SPAN
5210 > lines, the <SAMP
5211 CLASS="computeroutput"
5212 >File Servers</SAMP
5213 > screen displays all file server statistics, and
5214             if there are no <SPAN
5215 CLASS="bold"
5216 ><B
5217 CLASS="emphasis"
5218 >show cm</B
5219 ></SPAN
5220 > lines, the <SAMP
5221 CLASS="computeroutput"
5222 >Cache Managers</SAMP
5223 >
5224             screen displays all client statistics.</P
5225 ></DD
5226 ><DT
5227 ><SPAN
5228 CLASS="bold"
5229 ><B
5230 CLASS="emphasis"
5231 ># comments</B
5232 ></SPAN
5233 ></DT
5234 ><DD
5235 ><P
5236 >Precedes a line of text that the <SPAN
5237 CLASS="bold"
5238 ><B
5239 CLASS="emphasis"
5240 >afsmonitor</B
5241 ></SPAN
5242 > program ignores because of the
5243             initial number (<SPAN
5244 CLASS="bold"
5245 ><B
5246 CLASS="emphasis"
5247 >#</B
5248 ></SPAN
5249 >) sign, which must appear in the very first column of the line.</P
5250 ></DD
5251 ></DL
5252 ></DIV
5253 ></P
5254 ><P
5255 >For a list of the values that can appear in the field/group/section field of a <SPAN
5256 CLASS="bold"
5257 ><B
5258 CLASS="emphasis"
5259 >show</B
5260 ></SPAN
5261 >
5262     instruction, see <A
5263 HREF="a34149.html"
5264 >Appendix C, The afsmonitor Program Statistics</A
5265 >.)</P
5266 ><P
5267 >The following example illustrates a possible configuration file:</P
5268 ><PRE
5269 CLASS="programlisting"
5270 >&#13;   thresh cm dlocalAccesses  1000000
5271    thresh cm dremoteAccesses  500000 handleDRemote
5272    thresh fs rx_maxRtt_Usec     1000
5273    cm client5
5274    cm client33
5275    cm client14
5276    thresh cm dlocalAccesses  2000000
5277    thresh cm vcacheMisses      10000
5278    cm client2
5279    fs fs3
5280    fs fs9
5281    fs fs5
5282    fs fs10
5283    show cm numCellsContacted
5284    show cm dlocalAccesses
5285    show cm dremoteAccesses
5286    show cm vcacheMisses
5287    show cm Auth_Stats_group
5288 </PRE
5289 ><P
5290 >Since the first three <SPAN
5291 CLASS="bold"
5292 ><B
5293 CLASS="emphasis"
5294 >thresh</B
5295 ></SPAN
5296 > instructions appear before any <SPAN
5297 CLASS="bold"
5298 ><B
5299 CLASS="emphasis"
5300 >fs</B
5301 ></SPAN
5302 > or <SPAN
5303 CLASS="bold"
5304 ><B
5305 CLASS="emphasis"
5306 >cm</B
5307 ></SPAN
5308 > instructions, they set global threshold values: <UL
5309 ><LI
5310 ><P
5311 >All Cache Manager process in this file use <SPAN
5312 CLASS="bold"
5313 ><B
5314 CLASS="emphasis"
5315 >1000000</B
5316 ></SPAN
5317 > as the threshold for the
5318           <SPAN
5319 CLASS="bold"
5320 ><B
5321 CLASS="emphasis"
5322 >dlocalAccesses</B
5323 ></SPAN
5324 > statistic (except for the machine <SPAN
5325 CLASS="bold"
5326 ><B
5327 CLASS="emphasis"
5328 >client2</B
5329 ></SPAN
5330 >
5331           which uses an overriding value of <SPAN
5332 CLASS="bold"
5333 ><B
5334 CLASS="emphasis"
5335 >2000000</B
5336 ></SPAN
5337 >.)</P
5338 ></LI
5339 ><LI
5340 ><P
5341 >All Cache Manager processes in this file use <SPAN
5342 CLASS="bold"
5343 ><B
5344 CLASS="emphasis"
5345 >500000</B
5346 ></SPAN
5347 > as the threshold value for the
5348           <SPAN
5349 CLASS="bold"
5350 ><B
5351 CLASS="emphasis"
5352 >dremoteAccesses</B
5353 ></SPAN
5354 > statistic; if that value is exceeded, the script <SPAN
5355 CLASS="bold"
5356 ><B
5357 CLASS="emphasis"
5358 >handleDRemote</B
5359 ></SPAN
5360 > is invoked.</P
5361 ></LI
5362 ><LI
5363 ><P
5364 >All File Server processes in this file use <SPAN
5365 CLASS="bold"
5366 ><B
5367 CLASS="emphasis"
5368 >1000</B
5369 ></SPAN
5370 > as the threshold value for the
5371           <SPAN
5372 CLASS="bold"
5373 ><B
5374 CLASS="emphasis"
5375 >rx_maxRtt_Usec</B
5376 ></SPAN
5377 > statistic.</P
5378 ></LI
5379 ></UL
5380 ></P
5381 ><P
5382 >The four <SPAN
5383 CLASS="bold"
5384 ><B
5385 CLASS="emphasis"
5386 >cm</B
5387 ></SPAN
5388 > instructions monitor the Cache Manager on the machines <SPAN
5389 CLASS="bold"
5390 ><B
5391 CLASS="emphasis"
5392 >client5</B
5393 ></SPAN
5394 >, <SPAN
5395 CLASS="bold"
5396 ><B
5397 CLASS="emphasis"
5398 >client33</B
5399 ></SPAN
5400 >, <SPAN
5401 CLASS="bold"
5402 ><B
5403 CLASS="emphasis"
5404 >client14</B
5405 ></SPAN
5406 >, and
5407     <SPAN
5408 CLASS="bold"
5409 ><B
5410 CLASS="emphasis"
5411 >client2</B
5412 ></SPAN
5413 >. The first three use all of the global threshold values.</P
5414 ><P
5415 >The Cache Manager on <SPAN
5416 CLASS="bold"
5417 ><B
5418 CLASS="emphasis"
5419 >client2</B
5420 ></SPAN
5421 > uses the global threshold value for the <SPAN
5422 CLASS="bold"
5423 ><B
5424 CLASS="emphasis"
5425 >dremoteAccesses</B
5426 ></SPAN
5427 > statistic, but a different one for the <SPAN
5428 CLASS="bold"
5429 ><B
5430 CLASS="emphasis"
5431 >dlocalAccesses</B
5432 ></SPAN
5433 >
5434     statistic. Furthermore, <SPAN
5435 CLASS="bold"
5436 ><B
5437 CLASS="emphasis"
5438 >client22</B
5439 ></SPAN
5440 > is the only Cache Manager that uses the threshold set for the
5441     <SPAN
5442 CLASS="bold"
5443 ><B
5444 CLASS="emphasis"
5445 >vcacheMisses</B
5446 ></SPAN
5447 > statistic.</P
5448 ><P
5449 >The <SPAN
5450 CLASS="bold"
5451 ><B
5452 CLASS="emphasis"
5453 >fs</B
5454 ></SPAN
5455 > instructions monitor the File Server on the machines <SPAN
5456 CLASS="bold"
5457 ><B
5458 CLASS="emphasis"
5459 >fs3</B
5460 ></SPAN
5461 >, <SPAN
5462 CLASS="bold"
5463 ><B
5464 CLASS="emphasis"
5465 >fs9</B
5466 ></SPAN
5467 >, <SPAN
5468 CLASS="bold"
5469 ><B
5470 CLASS="emphasis"
5471 >fs5</B
5472 ></SPAN
5473 >, and <SPAN
5474 CLASS="bold"
5475 ><B
5476 CLASS="emphasis"
5477 >fs10</B
5478 ></SPAN
5479 >. They all use the global threshold for the<SPAN
5480 CLASS="bold"
5481 ><B
5482 CLASS="emphasis"
5483 >rx_maxRtt_Usec</B
5484 ></SPAN
5485 >
5486     statistic.</P
5487 ><P
5488 >Because there are no <SPAN
5489 CLASS="bold"
5490 ><B
5491 CLASS="emphasis"
5492 >show fs</B
5493 ></SPAN
5494 > instructions, the File Servers screen displays all File
5495     Server statistics. The Cache Managers screen displays only the statistics named in <SPAN
5496 CLASS="bold"
5497 ><B
5498 CLASS="emphasis"
5499 >show cm</B
5500 ></SPAN
5501 >
5502     instructions, ordering them from left to right. The <SPAN
5503 CLASS="bold"
5504 ><B
5505 CLASS="emphasis"
5506 >Auth_Stats_group</B
5507 ></SPAN
5508 > includes several
5509     statistics, all of which are displayed (<SPAN
5510 CLASS="bold"
5511 ><B
5512 CLASS="emphasis"
5513 >curr_PAGs</B
5514 ></SPAN
5515 >, <SPAN
5516 CLASS="bold"
5517 ><B
5518 CLASS="emphasis"
5519 >curr_Records</B
5520 ></SPAN
5521 >, <SPAN
5522 CLASS="bold"
5523 ><B
5524 CLASS="emphasis"
5525 >curr_AuthRecords</B
5526 ></SPAN
5527 >, <SPAN
5528 CLASS="bold"
5529 ><B
5530 CLASS="emphasis"
5531 >curr_UnauthRecords</B
5532 ></SPAN
5533 >, <SPAN
5534 CLASS="bold"
5535 ><B
5536 CLASS="emphasis"
5537 >curr_MaxRecordsInPAG</B
5538 ></SPAN
5539 >, <SPAN
5540 CLASS="bold"
5541 ><B
5542 CLASS="emphasis"
5543 >curr_LongestChain</B
5544 ></SPAN
5545 >, <SPAN
5546 CLASS="bold"
5547 ><B
5548 CLASS="emphasis"
5549 >PAGCreations</B
5550 ></SPAN
5551 >, <SPAN
5552 CLASS="bold"
5553 ><B
5554 CLASS="emphasis"
5555 >TicketUpdates</B
5556 ></SPAN
5557 >, <SPAN
5558 CLASS="bold"
5559 ><B
5560 CLASS="emphasis"
5561 >HWM_PAGS</B
5562 ></SPAN
5563 >, <SPAN
5564 CLASS="bold"
5565 ><B
5566 CLASS="emphasis"
5567 >HWM_Records</B
5568 ></SPAN
5569 >,
5570     <SPAN
5571 CLASS="bold"
5572 ><B
5573 CLASS="emphasis"
5574 >HWM_MaxRecordsInPAG</B
5575 ></SPAN
5576 >, and <SPAN
5577 CLASS="bold"
5578 ><B
5579 CLASS="emphasis"
5580 >HWM_LongestChain</B
5581 ></SPAN
5582 >).</P
5583 ></DIV
5584 ><DIV
5585 CLASS="sect1"
5586 ><H1
5587 CLASS="sect1"
5588 ><A
5589 NAME="HDRWQ352"
5590 >Writing afsmonitor Statistics to a File</A
5591 ></H1
5592 ><P
5593 >All of the statistical information collected and displayed by the <SPAN
5594 CLASS="bold"
5595 ><B
5596 CLASS="emphasis"
5597 >afsmonitor</B
5598 ></SPAN
5599 > program can
5600     be preserved by writing it to an output file. You can create an output file by using the <SPAN
5601 CLASS="bold"
5602 ><B
5603 CLASS="emphasis"
5604 >-output</B
5605 ></SPAN
5606 > argument when you startup the <SPAN
5607 CLASS="bold"
5608 ><B
5609 CLASS="emphasis"
5610 >afsmonitor</B
5611 ></SPAN
5612 > process. You can use
5613     the output file to track process performance over long periods of time and to apply post-processing techniques to further
5614     analyze system trends.</P
5615 ><P
5616 >The <SPAN
5617 CLASS="bold"
5618 ><B
5619 CLASS="emphasis"
5620 >afsmonitor</B
5621 ></SPAN
5622 > program output file is a simple ASCII file that records the information
5623     reported by the File Server and Cache Manager screens. The output file has the following format:</P
5624 ><PRE
5625 CLASS="programlisting"
5626 >&#13;   time   host_name <SPAN
5627 CLASS="bold"
5628 ><B
5629 CLASS="emphasis"
5630 >CM</B
5631 ></SPAN
5632 >|<SPAN
5633 CLASS="bold"
5634 ><B
5635 CLASS="emphasis"
5636 >FS</B
5637 ></SPAN
5638 >   list_of_measured_values
5639 </PRE
5640 ><P
5641 >and specifies the <SPAN
5642 CLASS="emphasis"
5643 ><I
5644 CLASS="emphasis"
5645 >time</I
5646 ></SPAN
5647 > at which the <SPAN
5648 CLASS="emphasis"
5649 ><I
5650 CLASS="emphasis"
5651 >list_of_measured_values</I
5652 ></SPAN
5653 > were gathered from
5654     the Cache Manager (<SPAN
5655 CLASS="bold"
5656 ><B
5657 CLASS="emphasis"
5658 >CM</B
5659 ></SPAN
5660 >) or File Server (<SPAN
5661 CLASS="bold"
5662 ><B
5663 CLASS="emphasis"
5664 >FS</B
5665 ></SPAN
5666 >) process housed on
5667     host_name. On those occasion where probes fail, the value <SAMP
5668 CLASS="computeroutput"
5669 >-1</SAMP
5670 > is reported instead of the
5671     <SPAN
5672 CLASS="emphasis"
5673 ><I
5674 CLASS="emphasis"
5675 >list_of_measured_values</I
5676 ></SPAN
5677 >.</P
5678 ><P
5679 >This file format provides several advantages: <UL
5680 ><LI
5681 ><P
5682 >It can be viewed using a standard editor. If you intend to view this file frequently, use the <SPAN
5683 CLASS="bold"
5684 ><B
5685 CLASS="emphasis"
5686 >-detailed</B
5687 ></SPAN
5688 > flag with the <SPAN
5689 CLASS="bold"
5690 ><B
5691 CLASS="emphasis"
5692 >-output</B
5693 ></SPAN
5694 > argument. It formats the output
5695           file in a way that is easier to read.</P
5696 ></LI
5697 ><LI
5698 ><P
5699 >It can be passed through filters to extract desired information using the standard set of UNIX tools.</P
5700 ></LI
5701 ><LI
5702 ><P
5703 >It is suitable for long term storage of the <SPAN
5704 CLASS="bold"
5705 ><B
5706 CLASS="emphasis"
5707 >afsmonitor</B
5708 ></SPAN
5709 > program output.</P
5710 ></LI
5711 ></UL
5712 ></P
5713 ></DIV
5714 ><DIV
5715 CLASS="sect1"
5716 ><H1
5717 CLASS="sect1"
5718 ><A
5719 NAME="Header_398"
5720 >To start the afsmonitor Program</A
5721 ></H1
5722 ><OL
5723 TYPE="1"
5724 ><LI
5725 ><P
5726 >Open a separate command shell window or use a dedicated terminal for each instance of the <SPAN
5727 CLASS="bold"
5728 ><B
5729 CLASS="emphasis"
5730 >afsmonitor</B
5731 ></SPAN
5732 > program. This window or terminal must be devoted to the exclusive use of the <SPAN
5733 CLASS="bold"
5734 ><B
5735 CLASS="emphasis"
5736 >afsmonitor</B
5737 ></SPAN
5738 > process because the command cannot be run in the background.</P
5739 ></LI
5740 ><LI
5741 ><P
5742 >Initialize the <SPAN
5743 CLASS="bold"
5744 ><B
5745 CLASS="emphasis"
5746 >afsmonitor</B
5747 ></SPAN
5748 > program. The message <SAMP
5749 CLASS="computeroutput"
5750 >afsmonitor Collecting
5751         Statistics...</SAMP
5752 >, followed by the appearance of the <SAMP
5753 CLASS="computeroutput"
5754 >System Overview</SAMP
5755 > screen,
5756         confirms a successful start. <PRE
5757 CLASS="programlisting"
5758 >&#13;   % <SPAN
5759 CLASS="bold"
5760 ><B
5761 CLASS="emphasis"
5762 >afsmonitor</B
5763 ></SPAN
5764 > [<SPAN
5765 CLASS="bold"
5766 ><B
5767 CLASS="emphasis"
5768 >initcmd</B
5769 ></SPAN
5770 >]  [<SPAN
5771 CLASS="bold"
5772 ><B
5773 CLASS="emphasis"
5774 >-config</B
5775 ></SPAN
5776 > &#60;<VAR
5777 CLASS="replaceable"
5778 >configuration file</VAR
5779 >&#62;]  \
5780                 [<SPAN
5781 CLASS="bold"
5782 ><B
5783 CLASS="emphasis"
5784 >-frequency</B
5785 ></SPAN
5786 > &#60;<VAR
5787 CLASS="replaceable"
5788 >poll frequency, in seconds</VAR
5789 >&#62;]  \
5790                 [<SPAN
5791 CLASS="bold"
5792 ><B
5793 CLASS="emphasis"
5794 >-output</B
5795 ></SPAN
5796 > &#60;<VAR
5797 CLASS="replaceable"
5798 >storage file name</VAR
5799 >&#62;] [<SPAN
5800 CLASS="bold"
5801 ><B
5802 CLASS="emphasis"
5803 >-detailed</B
5804 ></SPAN
5805 >]  \
5806                 [<SPAN
5807 CLASS="bold"
5808 ><B
5809 CLASS="emphasis"
5810 >-debug</B
5811 ></SPAN
5812 > &#60;<VAR
5813 CLASS="replaceable"
5814 >turn debugging output on to the named file</VAR
5815 >&#62;] \
5816                 [<SPAN
5817 CLASS="bold"
5818 ><B
5819 CLASS="emphasis"
5820 >-fshosts</B
5821 ></SPAN
5822 > &#60;<VAR
5823 CLASS="replaceable"
5824 >list of file servers to monitor</VAR
5825 >&#62;+]  \
5826                 [<SPAN
5827 CLASS="bold"
5828 ><B
5829 CLASS="emphasis"
5830 >-cmhosts</B
5831 ></SPAN
5832 > &#60;<VAR
5833 CLASS="replaceable"
5834 >list of cache managers to monitor</VAR
5835 >&#62;+]
5836    afsmonitor Collecting Statistics...
5837 </PRE
5838 ></P
5839 ><P
5840 >where <DIV
5841 CLASS="variablelist"
5842 ><DL
5843 ><DT
5844 ><SPAN
5845 CLASS="bold"
5846 ><B
5847 CLASS="emphasis"
5848 >initcmd</B
5849 ></SPAN
5850 ></DT
5851 ><DD
5852 ><P
5853 >Is an optional string that accommodates the command's use of the AFS command parser. It can be omitted and
5854                 ignored.</P
5855 ></DD
5856 ><DT
5857 ><SPAN
5858 CLASS="bold"
5859 ><B
5860 CLASS="emphasis"
5861 >-config</B
5862 ></SPAN
5863 ></DT
5864 ><DD
5865 ><P
5866 >Specifies the pathname of an <SPAN
5867 CLASS="bold"
5868 ><B
5869 CLASS="emphasis"
5870 >afsmonitor</B
5871 ></SPAN
5872 > configuration file, which lists the
5873                 machines and statistics to monitor. Partial pathnames are interpreted relative to the current working directory.
5874                 Provide either this argument or one or both of the <SPAN
5875 CLASS="bold"
5876 ><B
5877 CLASS="emphasis"
5878 >-fshosts</B
5879 ></SPAN
5880 > and <SPAN
5881 CLASS="bold"
5882 ><B
5883 CLASS="emphasis"
5884 >-cmhosts</B
5885 ></SPAN
5886 > arguments. You must use a configuration file to set thresholds or customize the
5887                 screen display. For instructions on creating the configuration file, see <A
5888 HREF="c18360.html#HDRWQ351"
5889 >Configuring the
5890                 afsmonitor Program</A
5891 >.</P
5892 ></DD
5893 ><DT
5894 ><SPAN
5895 CLASS="bold"
5896 ><B
5897 CLASS="emphasis"
5898 >-frequency</B
5899 ></SPAN
5900 ></DT
5901 ><DD
5902 ><P
5903 >Specifies how often to probe the File Server and Cache Manager processes, as a number of seconds. Acceptable
5904                 values range from <SPAN
5905 CLASS="bold"
5906 ><B
5907 CLASS="emphasis"
5908 >1</B
5909 ></SPAN
5910 > and <SPAN
5911 CLASS="bold"
5912 ><B
5913 CLASS="emphasis"
5914 >86400</B
5915 ></SPAN
5916 >; the default value
5917                 is <SPAN
5918 CLASS="bold"
5919 ><B
5920 CLASS="emphasis"
5921 >60</B
5922 ></SPAN
5923 >. This frequency applies to both File Server and Cache Manager probes;
5924                 however, File Server and Cache Manager probes are initiated and processed independent of each other. The actual
5925                 interval between probes to a host is the probe frequency plus the time needed by all hosts to respond to the
5926                 probe.</P
5927 ></DD
5928 ><DT
5929 ><SPAN
5930 CLASS="bold"
5931 ><B
5932 CLASS="emphasis"
5933 >-output</B
5934 ></SPAN
5935 ></DT
5936 ><DD
5937 ><P
5938 >Specifies the name of an output file to which to write all of the statistical data. By default, no output file
5939                 is created. For information on this file, see <A
5940 HREF="c18360.html#HDRWQ352"
5941 >Writing afsmonitor Statistics to a
5942                 File</A
5943 >.</P
5944 ></DD
5945 ><DT
5946 ><SPAN
5947 CLASS="bold"
5948 ><B
5949 CLASS="emphasis"
5950 >-detailed</B
5951 ></SPAN
5952 ></DT
5953 ><DD
5954 ><P
5955 >Formats the output file named by the <SPAN
5956 CLASS="bold"
5957 ><B
5958 CLASS="emphasis"
5959 >-output</B
5960 ></SPAN
5961 > argument to be more easily
5962                 readable. The <SPAN
5963 CLASS="bold"
5964 ><B
5965 CLASS="emphasis"
5966 >-output</B
5967 ></SPAN
5968 > argument must be provided along with this flag.</P
5969 ></DD
5970 ><DT
5971 ><SPAN
5972 CLASS="bold"
5973 ><B
5974 CLASS="emphasis"
5975 >-fshosts</B
5976 ></SPAN
5977 ></DT
5978 ><DD
5979 ><P
5980 >Identifies each File Server process to monitor by specifying the host it is running on. You can identify a
5981                 host using either its complete Internet-style host name or an abbreviation acceptable to the cell's naming service.
5982                 Combine this argument with the <SPAN
5983 CLASS="bold"
5984 ><B
5985 CLASS="emphasis"
5986 >-cmhosts</B
5987 ></SPAN
5988 > if you wish, but not the <SPAN
5989 CLASS="bold"
5990 ><B
5991 CLASS="emphasis"
5992 >-config</B
5993 ></SPAN
5994 > argument.</P
5995 ></DD
5996 ><DT
5997 ><SPAN
5998 CLASS="bold"
5999 ><B
6000 CLASS="emphasis"
6001 >-cmhosts</B
6002 ></SPAN
6003 ></DT
6004 ><DD
6005 ><P
6006 >Identifies each Cache Manager process to monitor by specifying the host it is running on. You can identify a
6007                 host using either its complete Internet-style host name or an abbreviation acceptable to the cell's naming service.
6008                 Combine this argument with the <SPAN
6009 CLASS="bold"
6010 ><B
6011 CLASS="emphasis"
6012 >-fshosts</B
6013 ></SPAN
6014 > if you wish, but not the <SPAN
6015 CLASS="bold"
6016 ><B
6017 CLASS="emphasis"
6018 >-config</B
6019 ></SPAN
6020 > argument.</P
6021 ></DD
6022 ></DL
6023 ></DIV
6024 ></P
6025 ></LI
6026 ></OL
6027 ></DIV
6028 ><DIV
6029 CLASS="sect1"
6030 ><H1
6031 CLASS="sect1"
6032 ><A
6033 NAME="Header_399"
6034 >To stop the afsmonitor program</A
6035 ></H1
6036 ><P
6037 >To exit an <SPAN
6038 CLASS="bold"
6039 ><B
6040 CLASS="emphasis"
6041 >afsmonitor</B
6042 ></SPAN
6043 > program session, Enter the &#60;<SPAN
6044 CLASS="bold"
6045 ><B
6046 CLASS="emphasis"
6047 >Ctrl-c</B
6048 ></SPAN
6049 >&#62; interrupt signal or an uppercase <SPAN
6050 CLASS="bold"
6051 ><B
6052 CLASS="emphasis"
6053 >Q</B
6054 ></SPAN
6055 >.</P
6056 ></DIV
6057 ><DIV
6058 CLASS="sect1"
6059 ><H1
6060 CLASS="sect1"
6061 ><A
6062 NAME="HDRWQ353"
6063 >The xstat Data Collection Facility</A
6064 ></H1
6065 ><P
6066 >The <SPAN
6067 CLASS="bold"
6068 ><B
6069 CLASS="emphasis"
6070 >afsmonitor</B
6071 ></SPAN
6072 > program uses the <SPAN
6073 CLASS="bold"
6074 ><B
6075 CLASS="emphasis"
6076 >xstat</B
6077 ></SPAN
6078 > data collection
6079     facility to gather and calculate the data that it (the <SPAN
6080 CLASS="bold"
6081 ><B
6082 CLASS="emphasis"
6083 >afsmonitor</B
6084 ></SPAN
6085 > program) then uses to perform
6086     its function. You can also use the <SPAN
6087 CLASS="bold"
6088 ><B
6089 CLASS="emphasis"
6090 >xstat</B
6091 ></SPAN
6092 > facility to create your own data display programs. If
6093     you do, keep the following in mind. The File Server considers any program calling its RPC routines to be a Cache Manager;
6094     therefore, any program calling the File Server interface directly must export the Cache Manager's callback interface. The
6095     calling program must be capable of emulating the necessary callback state, and it must respond to periodic keep-alive messages
6096     from the File Server. In addition, a calling program must be able to gather the collected data.</P
6097 ><P
6098 >The <SPAN
6099 CLASS="bold"
6100 ><B
6101 CLASS="emphasis"
6102 >xstat</B
6103 ></SPAN
6104 > facility consists of two C language libraries available to user-level
6105     applications: <UL
6106 ><LI
6107 ><P
6108 ><SPAN
6109 CLASS="bold"
6110 ><B
6111 CLASS="emphasis"
6112 >/usr/afsws/lib/afs/libxstat_fs.a</B
6113 ></SPAN
6114 > exports calls that gather information from one or
6115           more running File Server processes.</P
6116 ></LI
6117 ><LI
6118 ><P
6119 ><SPAN
6120 CLASS="bold"
6121 ><B
6122 CLASS="emphasis"
6123 >/usr/afsws/lib/afs/libxstat_cm.a</B
6124 ></SPAN
6125 > exports calls that collect information from one or
6126           more running Cache Managers.</P
6127 ></LI
6128 ></UL
6129 ></P
6130 ><P
6131 >The libraries allow the caller to register <UL
6132 ><LI
6133 ><P
6134 >A set of File Servers or Cache Managers to be examined.</P
6135 ></LI
6136 ><LI
6137 ><P
6138 >The frequency with which the File Servers or Cache Managers are to be probed for data.</P
6139 ></LI
6140 ><LI
6141 ><P
6142 >A user-specified routine to be called each time data is collected.</P
6143 ></LI
6144 ></UL
6145 ></P
6146 ><P
6147 >The libraries handle all of the lightweight processes, callback interactions, and timing issues associated with the data
6148     collection. The user needs only to process the data as it arrives.</P
6149 ><DIV
6150 CLASS="sect2"
6151 ><H2
6152 CLASS="sect2"
6153 ><A
6154 NAME="Header_401"
6155 >The libxstat Libraries</A
6156 ></H2
6157 ><P
6158 >The <SPAN
6159 CLASS="bold"
6160 ><B
6161 CLASS="emphasis"
6162 >libxstat_fs.a</B
6163 ></SPAN
6164 > and <SPAN
6165 CLASS="bold"
6166 ><B
6167 CLASS="emphasis"
6168 >libxstat_cm.a</B
6169 ></SPAN
6170 > libraries handle
6171       the callback requirements and other complications associated with the collection of data from File Servers and Cache Managers.
6172       The user provides only the means of accumulating the desired data. Each <SPAN
6173 CLASS="bold"
6174 ><B
6175 CLASS="emphasis"
6176 >xstat</B
6177 ></SPAN
6178 > library
6179       implements three routines: <UL
6180 ><LI
6181 ><P
6182 >Initialization (<SPAN
6183 CLASS="bold"
6184 ><B
6185 CLASS="emphasis"
6186 >xstat_fs_Init</B
6187 ></SPAN
6188 > and <SPAN
6189 CLASS="bold"
6190 ><B
6191 CLASS="emphasis"
6192 >xstat_cm_Init</B
6193 ></SPAN
6194 >)
6195             arranges the periodic collection and handling of data.</P
6196 ></LI
6197 ><LI
6198 ><P
6199 >Immediate probe (<SPAN
6200 CLASS="bold"
6201 ><B
6202 CLASS="emphasis"
6203 >xstat_fs_ForceProbeNow</B
6204 ></SPAN
6205 > and <SPAN
6206 CLASS="bold"
6207 ><B
6208 CLASS="emphasis"
6209 >xstat_cm_ForceProbeNow</B
6210 ></SPAN
6211 >) forces the immediate collection of data, after which collection returns
6212             to its normal probe schedule.</P
6213 ></LI
6214 ><LI
6215 ><P
6216 >Cleanup (<SPAN
6217 CLASS="bold"
6218 ><B
6219 CLASS="emphasis"
6220 >xstat_fs_Cleanup</B
6221 ></SPAN
6222 > and <SPAN
6223 CLASS="bold"
6224 ><B
6225 CLASS="emphasis"
6226 >xstat_cm_Cleanup</B
6227 ></SPAN
6228 >)
6229             terminates all connections and removes all traces of the data collection from memory.</P
6230 ></LI
6231 ></UL
6232 ></P
6233 ><P
6234 >The File Server and Cache Manager each define data collections that clients can fetch. A data collection is simply a
6235       related set of numbers that can be collected as a unit. For example, the File Server and Cache Manager each define profiling
6236       and performance data collections. The profiling collections maintain counts of the number of times internal functions are
6237       called within servers, allowing bottleneck analysis to be performed. The performance collections record, among other things,
6238       internal disk I/O statistics for a File Server and cache effectiveness figures for a Cache Manager, allowing for performance
6239       analysis.</P
6240 ><P
6241 >For a copy of the detailed specification which provides much additional usage information about the <SPAN
6242 CLASS="bold"
6243 ><B
6244 CLASS="emphasis"
6245 >xstat</B
6246 ></SPAN
6247 > facility, its libraries, and the routines in the libraries, contact AFS Product Support.</P
6248 ></DIV
6249 ><DIV
6250 CLASS="sect2"
6251 ><H2
6252 CLASS="sect2"
6253 ><A
6254 NAME="Header_402"
6255 >Example xstat Commands</A
6256 ></H2
6257 ><P
6258 >AFS comes with two low-level, example commands: <SPAN
6259 CLASS="bold"
6260 ><B
6261 CLASS="emphasis"
6262 >xstat_fs_test</B
6263 ></SPAN
6264 > and <SPAN
6265 CLASS="bold"
6266 ><B
6267 CLASS="emphasis"
6268 >xstat_cm_test</B
6269 ></SPAN
6270 >. The commands allow you to experiment with the <SPAN
6271 CLASS="bold"
6272 ><B
6273 CLASS="emphasis"
6274 >xstat</B
6275 ></SPAN
6276 >
6277       facility. They gather information and display the available data collections for a File Server or Cache Manager. They are
6278       intended merely to provide examples of the types of data that can be collected via <SPAN
6279 CLASS="bold"
6280 ><B
6281 CLASS="emphasis"
6282 >xstat</B
6283 ></SPAN
6284 >;
6285       they are not intended for use in the actual collection of data.</P
6286 ><DIV
6287 CLASS="sect3"
6288 ><H3
6289 CLASS="sect3"
6290 ><A
6291 NAME="Header_403"
6292 >To use the example xstat_fs_test command</A
6293 ></H3
6294 ><OL
6295 TYPE="1"
6296 ><LI
6297 ><P
6298 >Issue the example <SPAN
6299 CLASS="bold"
6300 ><B
6301 CLASS="emphasis"
6302 >xstat_fs_test</B
6303 ></SPAN
6304 > command to test the routines in the <SPAN
6305 CLASS="bold"
6306 ><B
6307 CLASS="emphasis"
6308 >libxstat_fs.a</B
6309 ></SPAN
6310 > library and display the data collections associated with the File Server process.
6311             The command executes in the foreground. <PRE
6312 CLASS="programlisting"
6313 >&#13;   % <SPAN
6314 CLASS="bold"
6315 ><B
6316 CLASS="emphasis"
6317 >xstat_fs_test</B
6318 ></SPAN
6319 > [<SPAN
6320 CLASS="bold"
6321 ><B
6322 CLASS="emphasis"
6323 >initcmd</B
6324 ></SPAN
6325 >]  \
6326                    <SPAN
6327 CLASS="bold"
6328 ><B
6329 CLASS="emphasis"
6330 >-fsname</B
6331 ></SPAN
6332 > &#60;<VAR
6333 CLASS="replaceable"
6334 >File Server name(s) to monitor</VAR
6335 >&#62;+  \
6336                    <SPAN
6337 CLASS="bold"
6338 ><B
6339 CLASS="emphasis"
6340 >-collID</B
6341 ></SPAN
6342 > &#60;<VAR
6343 CLASS="replaceable"
6344 >Collection(s) to fetch</VAR
6345 >&#62;+  [<SPAN
6346 CLASS="bold"
6347 ><B
6348 CLASS="emphasis"
6349 >-onceonly</B
6350 ></SPAN
6351 >]  \
6352                    [<SPAN
6353 CLASS="bold"
6354 ><B
6355 CLASS="emphasis"
6356 >-frequency</B
6357 ></SPAN
6358 > &#60;<VAR
6359 CLASS="replaceable"
6360 >poll frequency, in seconds</VAR
6361 >&#62;]  \
6362                    [<SPAN
6363 CLASS="bold"
6364 ><B
6365 CLASS="emphasis"
6366 >-period</B
6367 ></SPAN
6368 > &#60;<VAR
6369 CLASS="replaceable"
6370 >data collection time, in minutes</VAR
6371 >&#62;] [<SPAN
6372 CLASS="bold"
6373 ><B
6374 CLASS="emphasis"
6375 >-debug</B
6376 ></SPAN
6377 >] 
6378 </PRE
6379 ></P
6380 ><P
6381 >where <DIV
6382 CLASS="variablelist"
6383 ><DL
6384 ><DT
6385 ><SPAN
6386 CLASS="bold"
6387 ><B
6388 CLASS="emphasis"
6389 >xstat_fs_test</B
6390 ></SPAN
6391 ></DT
6392 ><DD
6393 ><P
6394 >Must be typed in full.</P
6395 ></DD
6396 ><DT
6397 ><SPAN
6398 CLASS="bold"
6399 ><B
6400 CLASS="emphasis"
6401 >initcmd</B
6402 ></SPAN
6403 ></DT
6404 ><DD
6405 ><P
6406 >Is an optional string that accommodates the command's use of the AFS command parser. It can be omitted and
6407                     ignored.</P
6408 ></DD
6409 ><DT
6410 ><SPAN
6411 CLASS="bold"
6412 ><B
6413 CLASS="emphasis"
6414 >-fsname</B
6415 ></SPAN
6416 ></DT
6417 ><DD
6418 ><P
6419 >Is the Internet host name of each file server machine on which to monitor the File Server process.</P
6420 ></DD
6421 ><DT
6422 ><SPAN
6423 CLASS="bold"
6424 ><B
6425 CLASS="emphasis"
6426 >-collID</B
6427 ></SPAN
6428 ></DT
6429 ><DD
6430 ><P
6431 >Specifies each data collection to return. The indicated data collection defines the type and amount of
6432                     data the command is to gather about the File Server. Data is returned in the form of a predefined data structure
6433                     (refer to the specification documents referenced previously for more information about the data
6434                     structures).</P
6435 ><P
6436 >There are two acceptable values: <UL
6437 ><LI
6438 ><P
6439 ><SPAN
6440 CLASS="bold"
6441 ><B
6442 CLASS="emphasis"
6443 >1</B
6444 ></SPAN
6445 > reports various internal performance statistics related to the
6446                           File Server (for example, vnode cache entries and <SPAN
6447 CLASS="bold"
6448 ><B
6449 CLASS="emphasis"
6450 >Rx</B
6451 ></SPAN
6452 > protocol
6453                           activity).</P
6454 ></LI
6455 ><LI
6456 ><P
6457 ><SPAN
6458 CLASS="bold"
6459 ><B
6460 CLASS="emphasis"
6461 >2</B
6462 ></SPAN
6463 > reports all of the internal performance statistics provided by
6464                           the <SPAN
6465 CLASS="bold"
6466 ><B
6467 CLASS="emphasis"
6468 >1</B
6469 ></SPAN
6470 > setting, plus some additional, detailed performance figures about
6471                           the File Server (for example, minimum, maximum, and cumulative statistics regarding File Server RPCs, how
6472                           long they take to complete, and how many succeed).</P
6473 ></LI
6474 ></UL
6475 ></P
6476 ></DD
6477 ><DT
6478 ><SPAN
6479 CLASS="bold"
6480 ><B
6481 CLASS="emphasis"
6482 >-onceonly</B
6483 ></SPAN
6484 ></DT
6485 ><DD
6486 ><P
6487 >Directs the command to gather statistics just one time. Omit this option to have the command continue to
6488                     probe the File Server for statistics every 30 seconds. If you omit this option, you can use the &#60;<SPAN
6489 CLASS="bold"
6490 ><B
6491 CLASS="emphasis"
6492 >Ctrl-c</B
6493 ></SPAN
6494 >&#62; interrupt signal to halt the command at any time.</P
6495 ></DD
6496 ><DT
6497 ><SPAN
6498 CLASS="bold"
6499 ><B
6500 CLASS="emphasis"
6501 >-frequency</B
6502 ></SPAN
6503 ></DT
6504 ><DD
6505 ><P
6506 >Sets the frequency in seconds at which the program initiates probes to the File Server. If you omit this
6507                     argument, the default is 30 seconds.</P
6508 ></DD
6509 ><DT
6510 ><SPAN
6511 CLASS="bold"
6512 ><B
6513 CLASS="emphasis"
6514 >-period</B
6515 ></SPAN
6516 ></DT
6517 ><DD
6518 ><P
6519 >Sets how long the utility runs before exiting, as a number of minutes. If you omit this argument, the
6520                     default is 10 minutes.</P
6521 ></DD
6522 ><DT
6523 ><SPAN
6524 CLASS="bold"
6525 ><B
6526 CLASS="emphasis"
6527 >-debug</B
6528 ></SPAN
6529 ></DT
6530 ><DD
6531 ><P
6532 >Displays additional information as the command runs.</P
6533 ></DD
6534 ></DL
6535 ></DIV
6536 ></P
6537 ></LI
6538 ></OL
6539 ></DIV
6540 ><DIV
6541 CLASS="sect3"
6542 ><H3
6543 CLASS="sect3"
6544 ><A
6545 NAME="Header_404"
6546 >To use the example xstat_cm_test command</A
6547 ></H3
6548 ><OL
6549 TYPE="1"
6550 ><LI
6551 ><P
6552 >Issue the example <SPAN
6553 CLASS="bold"
6554 ><B
6555 CLASS="emphasis"
6556 >xstat_cm_test</B
6557 ></SPAN
6558 > command to test the routines in the <SPAN
6559 CLASS="bold"
6560 ><B
6561 CLASS="emphasis"
6562 >libxstat_cm.a</B
6563 ></SPAN
6564 > library and display the data collections associated with the Cache Manager. The
6565             command executes in the foreground. <PRE
6566 CLASS="programlisting"
6567 >&#13;   % <SPAN
6568 CLASS="bold"
6569 ><B
6570 CLASS="emphasis"
6571 >xstat_cm_test</B
6572 ></SPAN
6573 > [<SPAN
6574 CLASS="bold"
6575 ><B
6576 CLASS="emphasis"
6577 >initcmd</B
6578 ></SPAN
6579 >]  \
6580                    <SPAN
6581 CLASS="bold"
6582 ><B
6583 CLASS="emphasis"
6584 >-cmname</B
6585 ></SPAN
6586 > &#60;<VAR
6587 CLASS="replaceable"
6588 >Cache Manager name(s) to monitor</VAR
6589 >&#62;+  \
6590                    <SPAN
6591 CLASS="bold"
6592 ><B
6593 CLASS="emphasis"
6594 >-collID</B
6595 ></SPAN
6596 > &#60;<VAR
6597 CLASS="replaceable"
6598 >Collection(s) to fetch</VAR
6599 >&#62;+ \
6600                    [<SPAN
6601 CLASS="bold"
6602 ><B
6603 CLASS="emphasis"
6604 >-onceonly</B
6605 ></SPAN
6606 >] [<SPAN
6607 CLASS="bold"
6608 ><B
6609 CLASS="emphasis"
6610 >-frequency</B
6611 ></SPAN
6612 > &#60;<VAR
6613 CLASS="replaceable"
6614 >poll frequency, in seconds</VAR
6615 >&#62;]  \
6616                    [<SPAN
6617 CLASS="bold"
6618 ><B
6619 CLASS="emphasis"
6620 >-period</B
6621 ></SPAN
6622 > &#60;<VAR
6623 CLASS="replaceable"
6624 >data collection time, in minutes</VAR
6625 >&#62;] [<SPAN
6626 CLASS="bold"
6627 ><B
6628 CLASS="emphasis"
6629 >-debug</B
6630 ></SPAN
6631 >] 
6632 </PRE
6633 ></P
6634 ><P
6635 >where <DIV
6636 CLASS="variablelist"
6637 ><DL
6638 ><DT
6639 ><SPAN
6640 CLASS="bold"
6641 ><B
6642 CLASS="emphasis"
6643 >xstat_cm_test</B
6644 ></SPAN
6645 ></DT
6646 ><DD
6647 ><P
6648 >Must be typed in full.</P
6649 ></DD
6650 ><DT
6651 ><SPAN
6652 CLASS="bold"
6653 ><B
6654 CLASS="emphasis"
6655 >initcmd</B
6656 ></SPAN
6657 ></DT
6658 ><DD
6659 ><P
6660 >Is an optional string that accommodates the command's use of the AFS command parser. It can be omitted and
6661                     ignored.</P
6662 ></DD
6663 ><DT
6664 ><SPAN
6665 CLASS="bold"
6666 ><B
6667 CLASS="emphasis"
6668 >-cmname</B
6669 ></SPAN
6670 ></DT
6671 ><DD
6672 ><P
6673 >Is the host name of each client machine on which to monitor the Cache Manager.</P
6674 ></DD
6675 ><DT
6676 ><SPAN
6677 CLASS="bold"
6678 ><B
6679 CLASS="emphasis"
6680 >-collID</B
6681 ></SPAN
6682 ></DT
6683 ><DD
6684 ><P
6685 >Specifies each data collection to return. The indicated data collection defines the type and amount of
6686                     data the command is to gather about the Cache Manager. Data is returned in the form of a predefined data
6687                     structure (refer to the specification documents referenced previously for more information about the data
6688                     structures).</P
6689 ><P
6690 >There are two acceptable values: <UL
6691 ><LI
6692 ><P
6693 ><SPAN
6694 CLASS="bold"
6695 ><B
6696 CLASS="emphasis"
6697 >0</B
6698 ></SPAN
6699 > provides profiling information about the numbers of times
6700                           different internal Cache Manager routines were called since the Cache manager was started.</P
6701 ></LI
6702 ><LI
6703 ><P
6704 ><SPAN
6705 CLASS="bold"
6706 ><B
6707 CLASS="emphasis"
6708 >1</B
6709 ></SPAN
6710 > reports various internal performance statistics related to the
6711                           Cache manager (for example, statistics about how effectively the cache is being used and the quantity of
6712                           intracell and intercell data access).</P
6713 ></LI
6714 ><LI
6715 ><P
6716 ><SPAN
6717 CLASS="bold"
6718 ><B
6719 CLASS="emphasis"
6720 >2</B
6721 ></SPAN
6722 > reports all of the internal performance statistics provided by
6723                           the <SPAN
6724 CLASS="bold"
6725 ><B
6726 CLASS="emphasis"
6727 >1</B
6728 ></SPAN
6729 > setting, plus some additional, detailed performance figures about
6730                           the Cache Manager (for example, statistics about the number of RPCs sent by the Cache Manager and how long
6731                           they take to complete; and statistics regarding things such as authentication, access, and PAG information
6732                           associated with data access).</P
6733 ></LI
6734 ></UL
6735 ></P
6736 ></DD
6737 ><DT
6738 ><SPAN
6739 CLASS="bold"
6740 ><B
6741 CLASS="emphasis"
6742 >-onceonly</B
6743 ></SPAN
6744 ></DT
6745 ><DD
6746 ><P
6747 >Directs the command to gather statistics just one time. Omit this option to have the command continue to
6748                     probe the Cache Manager for statistics every 30 seconds. If you omit this option, you can use the &#60;<SPAN
6749 CLASS="bold"
6750 ><B
6751 CLASS="emphasis"
6752 >Ctrl-c</B
6753 ></SPAN
6754 >&#62; interrupt signal to halt the command at any time.</P
6755 ></DD
6756 ><DT
6757 ><SPAN
6758 CLASS="bold"
6759 ><B
6760 CLASS="emphasis"
6761 >-frequency</B
6762 ></SPAN
6763 ></DT
6764 ><DD
6765 ><P
6766 >Sets the frequency in seconds at which the program initiates probes to the Cache Manager. If you omit this
6767                     argument, the default is 30 seconds.</P
6768 ></DD
6769 ><DT
6770 ><SPAN
6771 CLASS="bold"
6772 ><B
6773 CLASS="emphasis"
6774 >-period</B
6775 ></SPAN
6776 ></DT
6777 ><DD
6778 ><P
6779 >Sets how long the utility runs before exiting, as a number of minutes. If you omit this argument, the
6780                     default is 10 minutes.</P
6781 ></DD
6782 ><DT
6783 ><SPAN
6784 CLASS="bold"
6785 ><B
6786 CLASS="emphasis"
6787 >-debug</B
6788 ></SPAN
6789 ></DT
6790 ><DD
6791 ><P
6792 >Displays additional information as the command runs.</P
6793 ></DD
6794 ></DL
6795 ></DIV
6796 ></P
6797 ></LI
6798 ></OL
6799 ></DIV
6800 ></DIV
6801 ></DIV
6802 ><DIV
6803 CLASS="sect1"
6804 ><H1
6805 CLASS="sect1"
6806 ><A
6807 NAME="HDRWQ354"
6808 >Auditing AFS Events on AIX File Servers</A
6809 ></H1
6810 ><P
6811 >You can audit AFS events on AIX File Servers using an AFS mechanism that transfers audit information from AFS to the AIX
6812     auditing system. The following general classes of AFS events can be audited. For a complete list of specific AFS audit events,
6813     see <A
6814 HREF="a35965.html"
6815 >Appendix D, AIX Audit Events</A
6816 >. <UL
6817 ><LI
6818 ><P
6819 >Authentication and Identification Events</P
6820 ></LI
6821 ><LI
6822 ><P
6823 >Security Events</P
6824 ></LI
6825 ><LI
6826 ><P
6827 >Privilege Required Events</P
6828 ></LI
6829 ><LI
6830 ><P
6831 >Object Creation and Deletion Events</P
6832 ></LI
6833 ><LI
6834 ><P
6835 >Attribute Modification Events</P
6836 ></LI
6837 ><LI
6838 ><P
6839 >Process Control Events</P
6840 ></LI
6841 ></UL
6842 ></P
6843 ><DIV
6844 CLASS="note"
6845 ><BLOCKQUOTE
6846 CLASS="note"
6847 ><P
6848 ><B
6849 >Note: </B
6850 >This section assumes familiarity with the AIX auditing system. For more information, see the <SPAN
6851 CLASS="emphasis"
6852 ><I
6853 CLASS="emphasis"
6854 >AIX System
6855       Management Guide</I
6856 ></SPAN
6857 > for the version of AIX you are using.</P
6858 ></BLOCKQUOTE
6859 ></DIV
6860 ><DIV
6861 CLASS="sect2"
6862 ><H2
6863 CLASS="sect2"
6864 ><A
6865 NAME="Header_406"
6866 >Configuring AFS Auditing on AIX File Servers</A
6867 ></H2
6868 ><P
6869 >The directory <SPAN
6870 CLASS="bold"
6871 ><B
6872 CLASS="emphasis"
6873 >/usr/afs/local/audit</B
6874 ></SPAN
6875 > contains three files that contain the information
6876       needed to configure AIX File Servers to audit AFS events: <UL
6877 ><LI
6878 ><P
6879 >The <SPAN
6880 CLASS="bold"
6881 ><B
6882 CLASS="emphasis"
6883 >events.sample</B
6884 ></SPAN
6885 > file contains information on auditable AFS events. The contents
6886             of this file are integrated into the corresponding AIX events file (<SPAN
6887 CLASS="bold"
6888 ><B
6889 CLASS="emphasis"
6890 >/etc/security/audit/events</B
6891 ></SPAN
6892 >).</P
6893 ></LI
6894 ><LI
6895 ><P
6896 >The <SPAN
6897 CLASS="bold"
6898 ><B
6899 CLASS="emphasis"
6900 >config.sample</B
6901 ></SPAN
6902 > file defines the six classes of AFS audit events and the events
6903             that make up each class. It also defines the classes of AFS audit events to audit for the File Server, which runs as the
6904             local superuser <SPAN
6905 CLASS="bold"
6906 ><B
6907 CLASS="emphasis"
6908 >root</B
6909 ></SPAN
6910 >. The contents of this file must be integrated into the
6911             corresponding AIX config file (<SPAN
6912 CLASS="bold"
6913 ><B
6914 CLASS="emphasis"
6915 >/etc/security/audit/config</B
6916 ></SPAN
6917 >).</P
6918 ></LI
6919 ><LI
6920 ><P
6921 >The <SPAN
6922 CLASS="bold"
6923 ><B
6924 CLASS="emphasis"
6925 >objects.sample</B
6926 ></SPAN
6927 > file contains a list of information about audited files. You
6928             must only audit files in the local file space. The contents of this file must be integrated into the corresponding AIX
6929             objects file (<SPAN
6930 CLASS="bold"
6931 ><B
6932 CLASS="emphasis"
6933 >/etc/security/audit/objects</B
6934 ></SPAN
6935 >).</P
6936 ></LI
6937 ></UL
6938 ></P
6939 ><P
6940 >Once you have properly configured these files to include the AFS-relevant information, use the AIX auditing system to
6941       start up and shut down the auditing.</P
6942 ></DIV
6943 ><DIV
6944 CLASS="sect2"
6945 ><H2
6946 CLASS="sect2"
6947 ><A
6948 NAME="Header_407"
6949 >To enable AFS auditing</A
6950 ></H2
6951 ><OL
6952 TYPE="1"
6953 ><LI
6954 ><P
6955 >Create the following string in the file <SPAN
6956 CLASS="bold"
6957 ><B
6958 CLASS="emphasis"
6959 >/usr/afs/local/Audit</B
6960 ></SPAN
6961 > on each File Server on
6962           which you plan to audit AFS events: <PRE
6963 CLASS="programlisting"
6964 ><SPAN
6965 CLASS="bold"
6966 ><B
6967 CLASS="emphasis"
6968 >AFS_AUDIT_AllEvents</B
6969 ></SPAN
6970 ></PRE
6971 ></P
6972 ></LI
6973 ><LI
6974 ><P
6975 >Issue the <SPAN
6976 CLASS="bold"
6977 ><B
6978 CLASS="emphasis"
6979 >bos restart</B
6980 ></SPAN
6981 > command (with the <SPAN
6982 CLASS="bold"
6983 ><B
6984 CLASS="emphasis"
6985 >-all</B
6986 ></SPAN
6987 > flag)
6988           to stop and restart all server processes on each File Server. For instructions on using this command, see <A
6989 HREF="c6449.html#HDRWQ170"
6990 >Stopping and Immediately Restarting Processes</A
6991 >.</P
6992 ></LI
6993 ></OL
6994 ></DIV
6995 ><DIV
6996 CLASS="sect2"
6997 ><H2
6998 CLASS="sect2"
6999 ><A
7000 NAME="Header_408"
7001 >To disable AFS auditing</A
7002 ></H2
7003 ><OL
7004 TYPE="1"
7005 ><LI
7006 ><P
7007 >Remove the contents of the file <SPAN
7008 CLASS="bold"
7009 ><B
7010 CLASS="emphasis"
7011 >/usr/afs/local/Audit</B
7012 ></SPAN
7013 > on each File Server for which
7014           you are no longer interested in auditing AFS events.</P
7015 ></LI
7016 ><LI
7017 ><P
7018 >Issue the <SPAN
7019 CLASS="bold"
7020 ><B
7021 CLASS="emphasis"
7022 >bos restart</B
7023 ></SPAN
7024 > command (with the <SPAN
7025 CLASS="bold"
7026 ><B
7027 CLASS="emphasis"
7028 >-all</B
7029 ></SPAN
7030 > flag)
7031           to stop and restart all server processes on each File Server. For instructions on using this command, see <A
7032 HREF="c6449.html#HDRWQ170"
7033 >Stopping and Immediately Restarting Processes</A
7034 >.</P
7035 ></LI
7036 ></OL
7037 ></DIV
7038 ></DIV
7039 ></DIV
7040 ><DIV
7041 CLASS="NAVFOOTER"
7042 ><HR
7043 ALIGN="LEFT"
7044 WIDTH="100%"><TABLE
7045 SUMMARY="Footer navigation table"
7046 WIDTH="100%"
7047 BORDER="0"
7048 CELLPADDING="0"
7049 CELLSPACING="0"
7050 ><TR
7051 ><TD
7052 WIDTH="33%"
7053 ALIGN="left"
7054 VALIGN="top"
7055 ><A
7056 HREF="c15383.html"
7057 ACCESSKEY="P"
7058 >Prev</A
7059 ></TD
7060 ><TD
7061 WIDTH="34%"
7062 ALIGN="center"
7063 VALIGN="top"
7064 ><A
7065 HREF="book1.html"
7066 ACCESSKEY="H"
7067 >Home</A
7068 ></TD
7069 ><TD
7070 WIDTH="33%"
7071 ALIGN="right"
7072 VALIGN="top"
7073 ><A
7074 HREF="c20494.html"
7075 ACCESSKEY="N"
7076 >Next</A
7077 ></TD
7078 ></TR
7079 ><TR
7080 ><TD
7081 WIDTH="33%"
7082 ALIGN="left"
7083 VALIGN="top"
7084 >Backing Up and Restoring AFS Data</TD
7085 ><TD
7086 WIDTH="34%"
7087 ALIGN="center"
7088 VALIGN="top"
7089 ><A
7090 HREF="p3023.html"
7091 ACCESSKEY="U"
7092 >Up</A
7093 ></TD
7094 ><TD
7095 WIDTH="33%"
7096 ALIGN="right"
7097 VALIGN="top"
7098 >Managing Server Encryption Keys</TD
7099 ></TR
7100 ></TABLE
7101 ></DIV
7102 ></BODY
7103 ></HTML
7104 >