:
~
1 .TH XMETER 1 "14 August 1989" "X Version 11"
2 .SH NAME
3 xmeter - rstat display for X
4 .SH SYNOPSIS
5 .B xmeter
6 [-\fItoolkitoption\fP ...] [-\fIoption\fP ...] [-\fIstat\fP] hosts ...
7 .SH DESCRIPTION
8 .I Xmeter
9 displays a periodically updating histogram of the system statistics
10 gathered by rstat(3) for the specified hosts. Meters can be
11 displayed in a vertical, horizontal or rectangular arrangement. As
12 statistics range between 4 user defineable levels (OK, WARN, ERROR
13 or FATAL), the background, foreground, highlight, border and internal
14 border colors, and the background bitmap of each meter can be changed.
15 .LP
16 .I Xmeter
17 uses the StripChart widget of the Athena Widget Set to graph each
18 statistic. StripCharts automatically scale the graph as the value
19 varies, by drawing a number of horizontal lines across the StripChart.
20 Each line represents an increment of a user settable value. For
21 example, if the statistic being graphed is number of pages paged in
22 per second, and the scale is set to 10, then each horizontal line
23 would represent 10 pages per second. Each time a graph is updated,
24 .I xmeter
25 will examine the current value of the statistic and the current scale.
26 As the number of scale lines increases above
27 .I wlevel
28 and
29 .I elevel
30 the background colors and bitmaps of each meter are modified as specified.
31 The current scale value can be examined by clicking any mouse button
32 while the mouse pointer is in the StripChart. If the host is down the
33 time it's been down will also be displayed.
34 .LP
35 Each meter has its own label displaying the host name and statistics name.
36 The statistic being graphed may be modified while
37 .I xmeter
38 is running by moving the mouse pointer into the label part of a meter,
39 clicking any mouse button, and sliding down to the desired stat. This
40 menu also contains a quit option to exit
41 .I xmeter.
42 .SH OPTIONS
43 .PP
44 .I Xmeter
45 accepts all of the standard X Toolkit command line options along with the
46 following additional options:
47 .PP
48 .TP 8
49 .B \-cols \fIcols\fP
50 This option specifies the number of columns the meters should be
51 displayed in. If both
52 .I cols
53 and
54 .I rows
55 are specified,
56 .I cols
57 takes precedence. The default is 1 column.
58 .PP
59 .TP 8
60 .B \-dv
61 If specified causes the current value, after scaling, to be displayed
62 in the label. The current scale value can be displayed by clicking
63 any mouse button in the StripChart.
64 .PP
65 .TP 8
66 .B \-ebd \fIcolor\fP
67 Set error level border color.
68 .PP
69 .TP 8
70 .B \-ebg \fIcolor\fP
71 Set error level background color.
72 .PP
73 .TP 8
74 .B \-efg \fIcolor\fP
75 Set error level foreground color.
76 .PP
77 .TP 8
78 .B \-ehl \fIcolor\fP
79 Set error level highlight color.
80 .PP
81 .TP 8
82 .B \-eibd \fIcolor\fP
83 Set error level internal border color.
84 .PP
85 .TP 8
86 .B \-elevel \fIinteger\fP
87 This option specifies the level at which the background color is changed
88 to ebg. The default is 6.
89 .PP
90 .TP 8
91 .B \-ep \fIprogram\fP
92 .I program
93 should be the name of a program to be invoked when the meter enters the
94 error state.
95 .I program
96 will be passed 4 arguments, oldstate, newstate, hostname and stat being
97 monitored. Oldstate and newstate will be integers ranging from 0 to
98 3, corresponding to levels OK, WARN, ERROR and FATAL.
99 .PP
100 .TP 8
101 .B \-fbd \fIcolor\fP
102 Set fatal level border color.
103 .PP
104 .TP 8
105 .B \-fbg \fIcolor\fP
106 Set fatal level background color.
107 .PP
108 .TP 8
109 .B \-ffg \fIcolor\fP
110 Set fatal level foreground color.
111 .PP
112 .TP 8
113 .B \-fhl \fIcolor\fP
114 Set fatal level highlight color.
115 .PP
116 .TP 8
117 .B \-fibd \fIcolor\fP
118 Set fatal level internal border color.
119 .PP
120 .TP 8
121 .B \-fp \fIprogram\fP
122 .I program
123 should be the name of a program to be invoked when the monitored host is
124 down.
125 .I program
126 will be passed 4 arguments, oldstate, newstate, hostname and stat being
127 monitored. Oldstate and newstate will be integers ranging from 0 to
128 3, corresponding to levels OK, WARN, ERROR and FATAL.
129 .PP
130 .TP 8
131 .B \-h \fIpixels\fP
132 This option specifies the height of each chart
133 .I xmeter
134 will display. The default is 80.
135 .PP
136 .TP 8
137 .B \-lebg \fIcolor\fP
138 Set error level background color in menubutton.
139 .PP
140 .TP 8
141 .B \-lefg \fIcolor\fP
142 Set error level foreground color in menubutton.
143 .PP
144 .TP 8
145 .B \-lfbg \fIcolor\fP
146 Set fatal level background color in menubutton.
147 .PP
148 .TP 8
149 .B \-lffg \fIcolor\fP
150 Set fatal level foreground color in menubutton.
151 .PP
152 .TP 8
153 .B \-lobg \fIcolor\fP
154 Set ok level background color in menubutton.
155 .PP
156 .TP 8
157 .B \-lofg \fIcolor\fP
158 Set ok level foreground color in menubutton.
159 .PP
160 .TP 8
161 .B \-lwbg \fIcolor\fP
162 Set warn level background color in menubutton.
163 .PP
164 .TP 8
165 .B \-lwfg \fIcolor\fP
166 Set warn level foreground color in menubutton.
167 .PP
168 .TP 8
169 .B \-obd \fIcolor\fP
170 Set ok level border color.
171 .PP
172 .TP 8
173 .B \-obg \fIcolor\fP
174 Set ok level background color.
175 .PP
176 .TP 8
177 .B \-ofg \fIcolor\fP
178 Set ok level foreground color.
179 .PP
180 .TP 8
181 .B \-ohl \fIcolor\fP
182 Set ok level highlight color.
183 .PP
184 .TP 8
185 .B \-oibd \fIcolor\fP
186 Set ok level internal border color.
187 .PP
188 .TP 8
189 .B \-op \fIprogram\fP
190 .I program
191 should be the name of a program to be invoked when the meter enters WARN
192 state.
193 .I program
194 will be passed 4 arguments, oldstate, newstate, hostname and stat being
195 monitored. Oldstate and newstate will be integers ranging from 0 to
196 3, corresponding to levels OK, WARN, ERROR and FATAL.
197 .PP
198 .TP 8
199 .B \-rows \fIrows\fP
200 This option specifies the number of rows the meters should be
201 displayed in. If both
202 .I cols
203 and
204 .I rows
205 are specified,
206 .I cols
207 takes precedence. The default is 1 column.
208 .PP
209 .TP 8
210 .B \-rt \fIretries\fP
211 This option specifies the number of times to retry failed RPC calls.
212 The default is 2.
213 .PP
214 .TP 8
215 .B \-scoll \fIinteger\fP
216 Set scale for collisions. The default is 1.
217 .PP
218 .TP 8
219 .B \-scpu \fIinteger\fP
220 Set scale for cpu time. The default is 20.
221 .PP
222 .TP 8
223 .B \-sdisks \fIinteger\fP
224 Set scale for total number of disk I/O. The default is 40.
225 .PP
226 .TP 8
227 .B \-serr \fIinteger\fP
228 Set scale for total number of errors (ierr+oerr). The default is 1.
229 .PP
230 .TP 8
231 .B \-sierr \fIinteger\fP
232 Set scale for input errors. The default is 1.
233 .PP
234 .TP 8
235 .B \-sintr \fIinteger\fP
236 Set scale for interrupts. The default is 50.
237 .PP
238 .TP 8
239 .B \-sipkt \fIinteger\fP
240 Set scale for input packets. The default is 20.
241 .PP
242 .TP 8
243 .B \-sload \fIinteger\fP
244 Set scale for load average. The default is FSCALE (see param.h).
245 .PP
246 .TP 8
247 .B \-sn
248 If specified strips off domain part of host name in menubuttons.
249 .PP
250 .TP 8
251 .B \-soerr \fIinteger\fP
252 Set scale for output errors. The default is 1.
253 .PP
254 .TP 8
255 .B \-sopkt \fIinteger\fP
256 Set scale for output packets. The default is 20.
257 .PP
258 .TP 8
259 .B \-spage \fIinteger\fP
260 Set scale for pages paged in and out. The default is 10.
261 .PP
262 .TP 8
263 .B \-spgpgin \fIinteger\fP
264 Set scale for pages paged in. The default is 10.
265 .PP
266 .TP 8
267 .B \-spgpgout \fIinteger\fP
268 Set scale for pages paged out. The default is 10.
269 .PP
270 .TP 8
271 .B \-spkts \fIinteger\fP
272 Set scale for total number of packets (ipkt+opkt). The default is 40.
273 .PP
274 .TP 8
275 .B \-spswpin \fIinteger\fP
276 Set scale for pages swapped in. The default is 5.
277 .PP
278 .TP 8
279 .B \-spswpout \fIinteger\fP
280 Set scale for pages swapped out. The default is 5.
281 .PP
282 .TP 8
283 .B \-sswap \fIinteger\fP
284 Set scale for pages swapped in and out. The default is 5.
285 .PP
286 .TP 8
287 .B \-sswt \fIinteger\fP
288 Set scale for context switches. The default is 30.
289 .PP
290 .TP 8
291 .B \-ssys \fIinteger\fP
292 Set scale for sys time. The default is 20.
293 .PP
294 .TP 8
295 .B \-suser \fIinteger\fP
296 Set scale for user time. The default is 20.
297 .PP
298 .TP 8
299 .B \-to \fIseconds\fP
300 This option specifies the timeout for RPC calls. The default is 5 seconds.
301 .PP
302 .TP 8
303 .B \-update \fIseconds\fP
304 This option specifies the frequency in seconds at which
305 .I xmeter
306 updates its display. The minimum amount of time allowed between updates
307 is 5 seconds. The default is 60 seconds.
308 .PP
309 .TP 8
310 .B \-v
311 Print version number and exit.
312 .PP
313 .TP 8
314 .B \-w \fIpixels\fP
315 This option specifies the width of each chart
316 .I xmeter
317 will display. The default is 80.
318 .PP
319 .TP 8
320 .B \-wbd \fIcolor\fP
321 Set warn level border color.
322 .PP
323 .TP 8
324 .B \-wbg \fIcolor\fP
325 Set warn level background color.
326 .PP
327 .TP 8
328 .B \-wfg \fIcolor\fP
329 Set warn level foreground color.
330 .PP
331 .TP 8
332 .B \-whl \fIcolor\fP
333 Set warn level highlight color.
334 .PP
335 .TP 8
336 .B \-wibd \fIcolor\fP
337 Set warn level internal border color.
338 .PP
339 .TP 8
340 .B \-wlevel \fIinteger\fP
341 This option specifies the level at which the background color is changed
342 to wbg. The default is 3.
343 .PP
344 .TP 8
345 .B \-wp \fIprogram\fP
346 .I program
347 should be the name of a program to be invoked when the meter enters
348 WARN state.
349 .I program
350 will be passed 4 arguments, oldstate, newstate, hostname and stat being
351 monitored. Oldstate and newstate will be integers ranging from 0 to
352 3, corresponding to levels OK, WARN, ERROR and FATAL.
353 .SH STATISTICS
354 .PP
355 .TP 8
356 .B \-coll
357 Graph number of collisions per second.
358 .PP
359 .TP 8
360 .B \-cpu
361 Graph percentage of non idle time for the specified host.
362 .PP
363 .TP 8
364 .B \-disks
365 Graph number of disk I/O per second (first four drives).
366 .PP
367 .TP 8
368 .B \-err
369 Graph number of total errors per second.
370 .PP
371 .TP 8
372 .B \-intr
373 Graph number of interrupts per second.
374 .PP
375 .TP 8
376 .B \-ipkt
377 Graph number of input packets per second.
378 .PP
379 .TP 8
380 .B \-load
381 Graph 1 minute load average.
382 .PP
383 .TP 8
384 .B \-oerr
385 Graph number of output errors per second.
386 .PP
387 .TP 8
388 .B \-opkt
389 Graph number of output packets per second.
390 .PP
391 .TP 8
392 .B \-page
393 Sum of pgpgin and pgpgout values.
394 .PP
395 .TP 8
396 .B \-pgpgin
397 Graph number of pages paged in per second.
398 .PP
399 .TP 8
400 .B \-pgpgout
401 Graph number of pages paged out per second.
402 .PP
403 .TP 8
404 .B \-pkts
405 Graph number of total packets per second.
406 .PP
407 .TP 8
408 .B \-pswpin
409 Graph number of swapins per second.
410 .PP
411 .TP 8
412 .B \-pswpout
413 Graph number of swapouts per second.
414 .PP
415 .TP 8
416 .B \-swap
417 Graph number of total pages swapped per second.
418 .PP
419 .TP 8
420 .B \-swt
421 Graph number of context switches per second.
422 .PP
423 .TP 8
424 .B \-sys
425 Graph percentage of system time for the specified host.
426 .PP
427 .TP 8
428 .B \-user
429 Graph percentage of user time for the specified host.
430 .SH "WIDGET HIERARCHY"
431 The widget hierarchy for
432 .I xmeter
433 is given below. Class names are given first, followed by instance
434 names.
435 .sp
436 .nf
437 XMeter xmeter
438 Form form
439 SimpleMenu statmenu
440 SmeBSB <stat>
441 Paned <hostname>
442 MenuButton menu
443 StripChart load
444 .SH "RESOURCES"
445 The following resources are defined. Resource instance names
446 are specified first, followed by class name.
447 .PP
448 .TP 8
449 .B columns Columns
450 Set number of columns of display.
451 .PP
452 .TP 8
453 .B displayvalue DisplayValues
454 Display current value in label.
455 .PP
456 .TP 8
457 .B defStat DefStat
458 Default statistic to graph, the default is \fBload\fP.
459 .PP
460 .TP 8
461 .B errorBack Background
462 Error level background color.
463 .PP
464 .TP 8
465 .B errorBd Foreground
466 Error level border color.
467 .PP
468 .TP 8
469 .B errorBitmap Bitmap
470 Error level background bitmap.
471 .PP
472 .TP 8
473 .B errorFore Foreground
474 Error level foreground color.
475 .PP
476 .TP 8
477 .B errorHl Foreground
478 Error level highlight color.
479 .PP
480 .TP 8
481 .B errorIbd Foreground
482 Error level internal border color.
483 .PP
484 .TP 8
485 .B errorLevel ErrorLevel
486 When a statistic is above this value colors and bitmaps are
487 set to the appropriate error level value.
488 .PP
489 .TP 8
490 .B errorProg Program
491 Program to be invoked when a meter enters error state.
492 .PP
493 .TP 8
494 .B fatalBack Background
495 Background color of dead hosts.
496 .PP
497 .TP 8
498 .B fatalBd Foreground
499 Border color of dead hosts.
500 .PP
501 .TP 8
502 .B fatalBitmap Bitmap
503 Background bitmap of dead hosts.
504 .PP
505 .TP 8
506 .B fatalFore Foreground
507 Foreground color of dead hosts.
508 .PP
509 .TP 8
510 .B fatalHl Foreground
511 Highlight color of dead hosts.
512 .PP
513 .TP 8
514 .B fatalIbd Foreground
515 Internal border color of dead hosts.
516 .PP
517 .TP 8
518 .B fatalProg Program
519 Program to be invoked when a meter enters fatal state.
520 .PP
521 .TP 8
522 .B lErrorBack Background
523 Error level background color of menubutton widget.
524 .PP
525 .TP 8
526 .B lErrorFore Foreground
527 Error level foreground color of menubutton widget.
528 .PP
529 .TP 8
530 .B lFatalBack Background
531 Fatal level background color of menubutton widget.
532 .PP
533 .TP 8
534 .B lFatalFore Foreground
535 Fatal level foreground color of menubutton widget.
536 .PP
537 .TP 8
538 .B lOkBack Background
539 Ok level background color of menubutton widget.
540 .PP
541 .TP 8
542 .B lOkFore Foreground
543 Ok level foreground color of menubutton widget.
544 .PP
545 .TP 8
546 .B lWarnBack Background
547 Warn level background color of menubutton widget.
548 .PP
549 .TP 8
550 .B lWarnFore Foreground
551 Warn level foreground color of menubutton widget.
552 .PP
553 .TP 8
554 .B okBack Background
555 Ok level background color.
556 .PP
557 .TP 8
558 .B okBd Foreground
559 Ok level border color.
560 .PP
561 .TP 8
562 .B okBitmap Bitmap
563 Ok level background bitmap.
564 .PP
565 .TP 8
566 .B okFore Foreground
567 Ok level foreground color.
568 .PP
569 .TP 8
570 .B okHl Foreground
571 Ok level highlight color.
572 .PP
573 .TP 8
574 .B okIbd Foreground
575 Ok level internal border color.
576 .PP
577 .TP 8
578 .B okProg Program
579 Program to be invoked when a meter enters ok state.
580 .PP
581 .TP 8
582 .B retries Retries
583 Number of retries for RPC calls.
584 .PP
585 .TP 8
586 .B rows Rows
587 Number of rows to display.
588 .PP
589 .TP 8
590 .B scaleColl ScaleColl
591 Scale for interface collisions.
592 .PP
593 .TP 8
594 .B scaleCpu ScaleCpu
595 Scale for percentage cpu usage.
596 .PP
597 .TP 8
598 .B scaleIerr ScaleIerr
599 Scale for interface input errors.
600 .PP
601 .TP 8
602 .B scaleIerr ScaleIntr
603 Scale for interface interrupts.
604 .PP
605 .TP 8
606 .B scaleIpkt ScaleIpkt
607 Scale for interface input packets.
608 .PP
609 .TP 8
610 .B scaleLoad ScaleLoad
611 Scale for load average.
612 .PP
613 .TP 8
614 .B scaleOerr ScaleOerr
615 Scale for interface output errors.
616 .PP
617 .TP 8
618 .B scaleOpkt ScaleOpkt
619 Scale for interface output packets.
620 .PP
621 .TP 8
622 .B scalePage ScalePage
623 Scale for paging (sum of pageins and pageouts).
624 .PP
625 .TP 8
626 .B scalePgpgin ScalePgpgin
627 Scale for pages paged in.
628 .PP
629 .TP 8
630 .B scalePgpgout ScalePgpgout
631 Scale for pages paged out.
632 .PP
633 .TP 8
634 .B scalePswpin ScalePswpin
635 Scale for swap ins.
636 .PP
637 .TP 8
638 .B scalePswpout ScalePswpout
639 Scale for swap outs.
640 .PP
641 .TP 8
642 .B scaleSwt ScaleSwt
643 Scale for context switches.
644 .PP
645 .TP 8
646 .B scaleSys ScaleSys
647 Scale for percentage system time.
648 .PP
649 .TP 8
650 .B scaleUser ScaleUser
651 Scale for percentage user time.
652 .PP
653 .TP 8
654 .B shortName ShortName
655 Trim domains off host names.
656 .PP
657 .TP 8
658 .B timeout Timeout
659 Timeout for RPC calls.
660 .PP
661 .TP 8
662 .B update Interval
663 Interval between updates.
664 .PP
665 .TP 8
666 .B warnBack Background
667 Warn level background color.
668 .PP
669 .TP 8
670 .B warnBd Foreground
671 Warn level border color.
672 .PP
673 .TP 8
674 .B warnBitmap Bitmap
675 Warn level Background bitmap.
676 below ErrorLevel.
677 .PP
678 .TP 8
679 .B warnFore Foreground
680 Warn level foreground color.
681 .PP
682 .TP 8
683 .B warnHl Foreground
684 Warn level highlight color.
685 .PP
686 .TP 8
687 .B warnIbd Foreground
688 Warn level internal border.
689 .PP
690 .TP 8
691 .B warnLevel WarnLevel
692 When statistic is above this level and below ErrorLevel background colors
693 and bitmaps are set to WarnBack and WarnBitmap.
694 .PP
695 .TP 8
696 .B warnProg Program
697 Program to be invoked when a meter enters warn state.
698 .SH BUGS
699 When a host doesn't respond it can sometimes take a while for the labels
700 in the menubuttons to update.
701 .LP
702 The width and height of the stripchart widgets need to be initialized
703 to a non zero value or the error "Widget has zero width and/or height"
704 will be printed by the X toolkit. This can be done by the user or
705 in the application defaults file. The supplied application defaults
706 file initializes width and height to 80.
707 .SH AUTHOR
708 Bob Schwartzkopf, The RAND Corporation. Based on xload from MIT.
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.