1
.\" $Id: monshow.1 1.4 Tue, 31 Jul 2001 15:54:49 -0400 trockij $
2
.TH monshow 1 "$Date: Tue, 31 Jul 2001 15:54:49 -0400 $" Linux "monshow"
4
monshow \- show operational status of mon server.
29
show the operational status of the
31
server. Both command-line and CGI interfaces are available.
41
Do not read configuration file, and show operational status of all groups
48
Instead of showing only failed services, show all services no matter the
52
.BI \-\-detail\ group,service
53
Display detailed information for
57
This includes description, detailed output of the monitor,
58
dependency information, and more. When invoked via CGI,
59
append "detail=group,service" to get detail for a service.
63
Display a pre-configured view. When invoked via CGI, supply
64
the arguments "view=name" in the URL, or by using this technique:
65
"http://monhost/monshow.cgi/name". For security reasons,
66
leading forward slashes and imbedded ".."s are removed from the
71
Authenticate client to the mon server.
77
Show disabled groups, services, and hosts. The default is to not show
78
anything which is disabled, but this may be overridden by the config file.
83
.BI "--server " hostname
84
Connect to the mon server on host
87
can be either the name of a host or an IP address.
88
If this name is not supplied by this argument, then the environment variable
90
is used, if it exists. Otherwise,
97
.BI \-\-login \ username
98
When authenticating, use
104
.BI \-\-port \ portnum
105
Connect to the server on
111
.BI \-\-prot \ protocol
114
The protocol must match the format "1.2.3". If unset, the default
115
supplied by the Mon::Client module is used. Do not use this parameter
116
unless you really know what you are doing.
122
Use the old 0.37 protocol and port number (32777).
127
.BI \-\-rcfile \ file
128
Use configuration file
130
instead of ~/.monshowrc.
135
is invoked with the "REQUEST_METHOD" environment variable
136
set, then CGI invocation is assumed. In that case,
138
gathers variables and commands submitted via the
139
POST method and QUERY_STRING. Command-line options
140
are ignored for security reasons.
142
All reports which are produced via the web interface have a text mode
147
A view is a pre-defined configuration supplied to
149
Views can be used to generate different reports of the status
150
of certain services for different audiences. They are especially useful
151
if you are monitoring hundreds of things with mon, and you need to
152
see only a subset of the overall operational status.
153
For example, the web server admins can see a report which
154
has only the web server statuses, and the file server admins can
155
have their own report which shows only the servers. Users can customize
156
their own views by editing their own configurations.
158
Views are stored as files in a system-wide directory, typically
159
.IR /etc/mon/monshow ,
160
where each file specifies one view. If this path is not suitable
161
for any reason, it can be changed by modifying the
169
from the command line, the view to display is specified by the
173
In the case of CGI invocation, views can be specified by
178
to the URL. For example, the following are equivalent:
180
.I "http://monhost/monshow.cgi?view=test"
182
.I "http://monhost/monshow.cgi/test"
184
If a view is not specified, then a default configuration will be
186
.I "$HOME/.monshowrc"
187
(command-line invocation) or
188
.I "cgi-path/.monshowrc"
191
.SH VIEW CONFIGURATION FILE
193
The view file contains a list of which services
194
to display, how to display them, and a number of other parameters.
195
Blank lines and lines beginning with a # (pound) are ignored.
199
Include the status of all the services for "group".
202
.BI "service" " group service"
203
Include the status of the service specified by
213
configuration lines are present, then the status of all groups
214
and services are displayed.
217
.B "set show-disabled"
218
This has the same effect as using
224
.BI "set host" " hostname"
229
.BI "set port" " number"
230
The TCP port which the mon server is listening on.
233
.BI "set prot" " protocol"
234
Set the protocol. This probably should not be used unless
235
you really know what you're doing.
239
Show everything disabled, all failures, all successes, and all
243
.BI "set bg" " color"
244
Background color for the CGI report. The value of this
245
parameter should resemble "d5d5d5" (without the quotes).
248
.BI "set bg-ok" " color"
249
Background color for services which are in an "ok" state.
252
.BI "set bg-fail" " color"
253
Background color for services which are failing.
256
.BI "set bg-untested" " color"
257
Background color for services which have yet to be tested.
260
.BI "set refresh" " seconds"
261
For CGI output, set the frequency that the report reloads.
262
The default is to not reload.
265
.BI "summary-len" " len"
266
For CGI output, set the maximum length of the summary output
267
to display. Summary text which exceeds
269
will be truncated and replaced with ellipses.
272
.BI "link" " group service URL"
273
For the CGI report, make a link to
275
at the bottom of the detail report for
277
for more information.
280
.BI "link-text" " group service"
281
Insert all HTML up until a line beginning with "END"
282
after the link specified
289
Lines after this statement, continuing up until a line beginning
290
with the word "END" will be displayed after the "</head>" tag
291
in the CGI output. Use this to display custom headers, including
292
images and other fancy things.
294
.SH "ENVIRONMENT VARIABLES"
297
The hostname of the server which runs the
304
Report bugs to the email address below.
306
Jim Trocki <trockij@transmeta.com>
added
removed
doc/monshow.1
