1monshow(1) monshow monshow(1)
2
6 monshow - show operational status of mon server.
7
9 monshow [--help] [--showall] [--full] [--disabled] [--detail group,ser‐
10 vice] [--view name] [--auth] [--login user] [--old] [--server hostname]
11 [--port portnum] [--prot protocol] [--rcfile file]
12
14 monshow show the operational status of the mon server. Both command-
15 line and CGI interfaces are available.
16
18 --help show help
19 --showall
21 Do not read configuration file, and show operational status of
22 all groups and services.
23 --full Instead of showing only failed services, show all services no
25 matter the state.
26 --detail group,service
28 Display detailed information for group and service. This
29 includes description, detailed output of the monitor, dependency
30 information, and more. When invoked via CGI, append
31 "detail=group,service" to get detail for a service.
32 --view name
34 Display a pre-configured view. When invoked via CGI, supply the
35 arguments "view=name" in the URL, or by using this technique:
36 "http://monhost/monshow.cgi/name". For security reasons, leading
37 forward slashes and imbedded ".."s are removed from the view
38 name.
39 --auth Authenticate client to the mon server.
41 --disabled
43 Show disabled groups, services, and hosts. The default is to not
44 show anything which is disabled, but this may be overridden by
45 the config file.
46 --server hostname
48 Connect to the mon server on host hostname. hostname can be
49 either the name of a host or an IP address. If this name is not
50 supplied by this argument, then the environment variable MONHOST
51 is used, if it exists. Otherwise, monshow will fail.
52 --login username
54 When authenticating, use username.
55 --port portnum
57 Connect to the server on portnum.
58 --prot protocol
60 Sets the protocol to protocol. The protocol must match the for‐
61 mat "1.2.3". If unset, the default supplied by the Mon::Client
62 module is used. Do not use this parameter unless you really know
63 what you are doing.
64 --old Use the old 0.37 protocol and port number (32777).
66 --rcfile file
68 Use configuration file file instead of ~/.monshowrc.
69
72 If monshow is invoked with the "REQUEST_METHOD" environment variable
73 set, then CGI invocation is assumed. In that case, monshow gathers
74 variables and commands submitted via the POST method and QUERY_STRING.
75 Command-line options are ignored for security reasons.
76 All reports which are produced via the web interface have a text mode
78 equivalent.
79
82 A view is a pre-defined configuration supplied to monshow. Views can
83 be used to generate different reports of the status of certain services
84 for different audiences. They are especially useful if you are monitor‐
85 ing hundreds of things with mon, and you need to see only a subset of
86 the overall operational status. For example, the web server admins can
87 see a report which has only the web server statuses, and the file
88 server admins can have their own report which shows only the servers.
89 Users can customize their own views by editing their own configura‐
90 tions.
91 Views are stored as files in a system-wide directory, typically
93 /etc/mon/monshow, where each file specifies one view. If this path is
94 not suitable for any reason, it can be changed by modifying the $VIEW‐
95 PATH variable in the monshow script.
96 When invoking monshow from the command line, the view to display is
98 specified by the --view=name argument.
99 In the case of CGI invocation, views can be specified by appending
101 either ?view=name or /name to the URL. For example, the following are
102 equivalent:
103 http://monhost/monshow.cgi?view=test
105 http://monhost/monshow.cgi/test
106 If a view is not specified, then a default configuration will be loaded
108 from $HOME/.monshowrc (command-line invocation) or cgi-path/.monshowrc
109 (CGI invocation).
110
113 The view file contains a list of which services to display, how to dis‐
114 play them, and a number of other parameters. Blank lines and lines
115 beginning with a # (pound) are ignored.
116 watch group
119 Include the status of all the services for "group".
120 service group service
122 Include the status of the service specified by group and ser‐
123 vice.
124 If no watch or service configuration lines are present, then the status
126 of all groups and services are displayed.
127 set show-disabled
129 This has the same effect as using the --disabled option.
130 set host hostname
132 Query the mon server hostname.
133 set port number
135 The TCP port which the mon server is listening on.
136 set prot protocol
138 Set the protocol. This probably should not be used unless you
139 really know what you're doing.
140 set full
142 Show everything disabled, all failures, all successes, and all
143 untested services.
144 set bg color
146 Background color for the CGI report. The value of this parameter
147 should resemble "d5d5d5" (without the quotes).
148 set bg-ok color
150 Background color for services which are in an "ok" state.
151 set bg-fail color
153 Background color for services which are failing.
154 set bg-untested color
156 Background color for services which have yet to be tested.
157 set refresh seconds
159 For CGI output, set the frequency that the report reloads. The
160 default is to not reload.
161 summary-len len
163 For CGI output, set the maximum length of the summary output to
164 display. Summary text which exceeds len will be truncated and
165 replaced with ellipses.
166 link group service URL
168 For the CGI report, make a link to URL at the bottom of the
169 detail report for group/service for more information.
170 link-text group service
172 Insert all HTML up until a line beginning with "END" after the
173 link specified with the link setting.
174 set html-header
176 Lines after this statement, continuing up until a line beginning
177 with the word "END" will be displayed after the "</head>" tag in
178 the CGI output. Use this to display custom headers, including
179 images and other fancy things.
180
183 MONHOST
184 The hostname of the server which runs the mon process.
185
188 mon(8)
189
191 Report bugs to the email address below.
192
194 Jim Trocki <trockij@arctic.org>
195Linux $Date: 2005/04/17 07:42:27 $ monshow(1)