« back to all changes in this revision
Viewing changes to doc/smokeping_config.txt
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Jose Carlos Garcia Sogo
- Date: 2002-04-02 15:02:08 UTC
- Revision ID: james.westby@ubuntu.com-20020402150208-8eycqntc07q6gig5
Tags: upstream-1.6
Import upstream version 1.6
- files added:
- bin
- doc
- etc
- htdocs
- lib
- lib/ISG
- lib/probes
added
removed
doc/smokeping_config.txt
1
SMOKEPING_CONFIG(1) SmokePing SMOKEPING_CONFIG(1)
2
3
4
5
OOOOVVVVEEEERRRRVVVVIIIIEEEEWWWW
6
SmokePing takes its configuration from a single central
7
configuration file. Its location must be hardcoded in the
8
smokeping script and smokeping.cgi.
9
10
The contents of this manual is generated directly from the
11
configuration file parser.
12
13
The Parser for the Configuration file is written using
14
David Schweikers ParseConfig module. Read all about it in
15
the ISG::ParseConfig manpage.
16
17
The Configuration file has a tree-like structure with sec-
18
tion headings at various levels. It also contains variable
19
assignements and tables.
20
21
RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEE
22
The text below describes the syntax of the SmokePing con-
23
figuration file.
24
25
************ GGGGeeeennnneeeerrrraaaallll ************ _(_m_a_n_d_a_t_o_r_y _s_e_c_t_i_o_n_)
26
27
General configuration values valid for the whole SmokePing
28
setup.
29
30
The following variables can be set in this section:
31
32
oooowwwwnnnneeeerrrr _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
33
Name of the person responsible for this smokeping
34
installation.
35
36
iiiimmmmggggccccaaaacccchhhheeee _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
37
A directory which is visible on your webserver where
38
SmokePing can cache graphs.
39
40
iiiimmmmgggguuuurrrrllll _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
41
Either an absolute URL to the iiiimmmmggggccccaaaacccchhhheeee directory or
42
one relative to the directory where you keep the
43
SmokePing cgi.
44
45
ddddaaaattttaaaaddddiiiirrrr _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
46
The directory where SmokePing can keep its rrd files.
47
48
ppppiiiiddddddddiiiirrrr _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
49
The directory where SmokePing keeps its pid when
50
demonised.
51
52
sssseeeennnnddddmmmmaaaaiiiillll
53
Path to your sendmail binary. It will be used for
54
sending mails in connection with the support of
55
DYNAMIC addresses.
56
57
ssssmmmmooookkkkeeeemmmmaaaaiiiillll _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
58
Path to the mail template for DYNAMIC hosts. This mail
59
template must contain keywords of the form <<<<########_k_e_y_-
60
_w_o_r_d########>>>>. There is a sample template included with
61
SmokePing.
62
63
ccccggggiiiiuuuurrrrllll _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
64
Complete URL path of the SmokePing.cgi
65
66
67
68
mmmmaaaaiiiillllhhhhoooosssstttt
69
Instead of using sendmail, you can specify the name of
70
an smtp server and use perl's Net::SMTP module to send
71
mail to DYNAMIC host owners (see below).
72
73
ccccoooonnnnttttaaaacccctttt _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
74
Mail address of the person responsible for this
75
smokeping installation.
76
77
************ DDDDaaaattttaaaabbbbaaaasssseeee ************ _(_m_a_n_d_a_t_o_r_y _s_e_c_t_i_o_n_)
78
79
Describes the properties of the round robin database for
80
storing the SmokePing data. Note that it is not possible
81
to edit existing RRDs by changeing the entries in the cfg
82
file.
83
84
The following variables can be set in this section:
85
86
sssstttteeeepppp _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
87
Duration of the base operation interval of SmokePing
88
in seconds. SmokePing will venture out every sssstttteeeepppp
89
seconds to ping your target hosts.
90
91
ppppiiiinnnnggggssss _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
92
How many pings should be sent to each target. Sug-
93
gested: 20 pings.
94
95
This section also contains a table describing the setup of
96
the SmokePing database. Below are reasonable defaults.
97
Only change them if you know rrdtool and its workings.
98
Each row in the table describes one RRA.
99
100
# cons xff steps rows
101
AVERAGE 0.5 1 1008
102
AVERAGE 0.5 12 4320
103
MIN 0.5 12 4320
104
MAX 0.5 12 4320
105
AVERAGE 0.5 144 720
106
MAX 0.5 144 720
107
MIN 0.5 144 720
108
109
110
column 0
111
Consolidation method.
112
113
column 1
114
What part of the consolidated intervals must be known
115
to warrant a known entry.
116
117
column 2
118
How many sssstttteeeeppppssss to consolidate into for each RRA entry.
119
120
column 3
121
How many rrrroooowwwwssss this RRA should have.
122
123
************ PPPPrrrreeeesssseeeennnnttttaaaattttiiiioooonnnn ************ _(_m_a_n_d_a_t_o_r_y _s_e_c_t_i_o_n_)
124
125
Defines how the SmokePing data should be presented.
126
127
The following variables can be set in this section:
128
129
tttteeeemmmmppppllllaaaatttteeee _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
130
The webpage template must contain keywords of the form
131
<<<<########_k_e_y_w_o_r_d########>>>>. There is a sample template included
132
with SmokePing; use it as the basis for your
133
experiments. Default template contains a pointer to
134
the SmokePing counter and homepage. I would be glad if
135
you would not remove this as it gives me an indication
136
as to how widely used the tool is.
137
138
cccchhhhaaaarrrrsssseeeetttt
139
By default, SmokePing assumes the 'iso-8859-15' char-
140
acter set. If you use something else, this is the
141
place to speak up.
142
143
The following sections are valid on level 1:
144
145
++++oooovvvveeeerrrrvvvviiiieeeewwww _(_m_a_n_d_a_t_o_r_y _s_e_c_t_i_o_n_)
146
The Overview section defines how the Overview graphs
147
should look.
148
149
The following variables can be set in this section:
150
151
wwwwiiiiddddtttthhhh _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
152
Width of the Overview Graphs.
153
154
hhhheeeeiiiigggghhhhtttt _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
155
Height of the Overview Graphs.
156
157
rrrraaaannnnggggeeee
158
How much time should be depicted in the Overview
159
graph. Time must be specified as a number followed
160
by a letter which specifies the unit of time.
161
Known units are: sssseconds, mmmminutes, hhhhours, dddddays,
162
wwwweeks, yyyyears.
163
164
mmmmaaaaxxxx____rrrrtttttttt
165
Any roundtrip time larger than this value will
166
cropped in the overview graph
167
168
mmmmeeeeddddiiiiaaaannnn____ccccoooolllloooorrrr
169
By default the median line is drawn in red. Over-
170
ride it here with a hex color in the format
171
_r_r_g_g_b_b.
172
173
ssssttttrrrrffffttttiiiimmmmeeee
174
Use posix strftime to format the timestamp in the
175
left hand lower corner of the overview graph
176
177
++++ddddeeeettttaaaaiiiillll _(_m_a_n_d_a_t_o_r_y _s_e_c_t_i_o_n_)
178
The following variables can be set in this section:
179
180
wwwwiiiiddddtttthhhh _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
181
How many pixels wide should detail graphs be
182
183
hhhheeeeiiiigggghhhhtttt _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
184
How many pixels high should detail graphs be
185
186
llllooooggggaaaarrrriiiitttthhhhmmmmiiiicccc
187
should the graphs be shown in a logarithmic scale
188
(yes/no)
189
190
uuuunnnniiiissssoooonnnn____ttttoooolllleeeerrrraaaannnncccceeee
191
if a graph is more than this factor of the median
192
'max' it drops out of the unison scaling algo-
193
rithm. A factor of two would mean that any graph
194
with a max either less than half or more than
195
twice the median 'max' will be dropped from unison
196
scaling
197
198
199
200
mmmmaaaaxxxx____rrrrtttttttt
201
Any roundtrip time larger than this value will
202
cropped in the detail graph
203
204
ssssttttrrrrffffttttiiiimmmmeeee
205
Use posix strftime to format the timestamp in the
206
left hand lower corner of the detail graph
207
208
The detailed display can contain several graphs of
209
different resolution. In this table you can specify
210
the resolution of each graph.
211
212
Example:
213
214
"Last 3 Hours" 3h
215
"Last 30 Hours" 30h
216
"Last 10 Days" 10d
217
"Last 400 Days" 400d
218
219
220
column 0
221
Description of the particular resolution.
222
223
column 1
224
How much time should be depicted. The format is
225
the same as for the aaaaggggeeee parameter of the Overview
226
section.
227
228
The following sections are valid on level 2:
229
230
++++++++lllloooossssssss____ccccoooolllloooorrrrssss
231
In the Detail view, the color of the median line
232
depends the amount of lost packets. SmokePing
233
comes with a reasonable default setting, but you
234
may choose to disagree. The table below lets you
235
specify your own coloring.
236
237
Example:
238
239
Loss Color Legend
240
1 00ff00 "<1"
241
3 0000ff "<3"
242
1000 ff0000 ">=3"
243
244
245
column 0
246
Activate when the lossrate is larger of equal
247
to this number
248
249
column 1
250
Color for this range.
251
252
column 2
253
Description for this range.
254
255
++++++++uuuuppppttttiiiimmmmeeee____ccccoooolllloooorrrrssss
256
When monitoring a host with DYNAMIC addressing,
257
SmokePing will keep track of how long the machine
258
is able to keep the same IP address. This time is
259
plotted as a color in the graphs background.
260
SmokePing comes with a reasonable default setting,
261
but you may choose to disagree. The table below
262
lets you specify your own coloring
263
264
Example:
265
266
Uptime Color Legend
267
3600 00ff00 "<1h"
268
86400 0000ff "<1d"
269
604800 ff0000 "<1w"
270
1000000000000 ffff00 ">1w"
271
272
Uptime is in days!
273
274
column 0
275
Activate when uptime in days is larger of
276
equal to this number
277
278
column 1
279
Color for this uptime range range.
280
281
column 2
282
Description for this range.
283
284
************ PPPPrrrroooobbbbeeeessss ************ _(_m_a_n_d_a_t_o_r_y _s_e_c_t_i_o_n_)
285
286
The Probes Section configures Probe modules. Probe modules
287
integrate an external ping command into SmokePing. Check
288
the documentation of the Ping module for configuration
289
details.
290
291
The following sections are valid on level 1:
292
293
++++////[[[[----____0000----9999aaaa----zzzzAAAA----ZZZZ]]]]++++////
294
Each module can take specific configuration informa-
295
tion from this area. The jumble of letters above is a
296
regular expression defining legal module names.
297
298
The following variables can be set in this section:
299
300
////[[[[----____0000----9999aaaa----zzzzAAAA----ZZZZ]]]]++++////
301
Each module defines which variables it wants to
302
accept. So this expression here just defines legal
303
variable names.
304
305
************ TTTTaaaarrrrggggeeeettttssss ************ _(_m_a_n_d_a_t_o_r_y _s_e_c_t_i_o_n_)
306
307
The Target Section defines the actual work of SmokePing.
308
It contains a hierarchical list of hosts which mark the
309
endpoints of the network connections the system should
310
monitor. Each section can contain one host as well as
311
other sections.
312
313
The following variables can be set in this section:
314
315
pppprrrroooobbbbeeee _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
316
The name of the probe module to be used for this host.
317
The value of this variable gets propagated
318
319
mmmmeeeennnnuuuu _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
320
Menu entry for this section
321
322
ttttiiiittttlllleeee _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
323
Title of the page when it is displayed.
324
325
rrrreeeemmmmaaaarrrrkkkk
326
An optional remark on the current section. It gets
327
displayed on the webpage.
328
329
The following sections are valid on level 1:
330
331
332
++++PPPPRRRROOOOBBBBEEEE____CCCCOOOONNNNFFFF
333
Probe specific variables.
334
335
The following variables can be set in this section:
336
337
////[[[[----____0000----9999aaaa----zzzzAAAA----ZZZZ]]]]++++////
338
Should be found in the documentation of the corre-
339
sponding probe. The values get propagated. If a
340
child node uses the same Probe as the parent.
341
342
++++////[[[[----____0000----9999aaaa----zzzzAAAA----ZZZZ]]]]++++////
343
Each target section can contain information about a
344
host to monitor as well as further target sections.
345
Most variables have already been described above. The
346
expression above defines legal names for target sec-
347
tions.
348
349
The following variables can be set in this section:
350
351
pppprrrroooobbbbeeee
352
mmmmeeeennnnuuuu _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
353
ttttiiiittttlllleeee _(_m_a_n_d_a_t_o_r_y _s_e_t_t_i_n_g_)
354
nnnnooootttteeee
355
Some information about this entry which does NOT
356
get displayed on the web.
357
358
eeeemmmmaaaaiiiillll
359
This is the contact address for the owner of the
360
current host. In connection with the DDDDYYYYNNNNAAAAMMMMIIIICCCC
361
hosts, the address will be used for sending the
362
belowmentioned script.
363
364
hhhhoooosssstttt
365
Can either contain the name of a target host or
366
the string DDDDYYYYNNNNAAAAMMMMIIIICCCC.
367
368
In the second case, the target machine has a
369
dynamic IP address and thus is required to regu-
370
larly contact the SmokePing server to verify its
371
IP address. When starting SmokePing with the com-
372
mandline argument --------eeeemmmmaaaaiiiillll it will add a secret
373
password to each of the DDDDYYYYNNNNAAAAMMMMIIIICCCC host lines and
374
send a script to the owner of each host. This
375
script must be started regularly on the host in
376
question to make sure SmokePing monitors the right
377
box. If the target machine supports SNMP SmokePing
378
will also query the hosts sysContact, sysName and
379
sysLocation properties to make sure it is still
380
the same host.
381
382
rrrreeeemmmmaaaarrrrkkkk
383
384
The following sections are valid on level 2:
385
386
++++++++PPPPRRRROOOOBBBBEEEE____CCCCOOOONNNNFFFF
387
Probe specific variables.
388
389
The following variables can be set in this sec-
390
tion:
391
392
////[[[[----____0000----9999aaaa----zzzzAAAA----ZZZZ]]]]++++////
393
Should be found in the documentation of the
394
corresponding probe. The values get propa-
395
gated. If a child node uses the same Probe as
396
the parent.
397
398
++++++++////[[[[----____0000----9999aaaa----zzzzAAAA----ZZZZ]]]]++++////
399
Each target section can contain information about
400
a host to monitor as well as further target sec-
401
tions. Most variables have already been described
402
above. The expression above defines legal names
403
for target sections.
404
405
CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
406
Copyright (c) 2001 by Tobias Oetiker. All right reserved.
407
408
LLLLIIIICCCCEEEENNNNSSSSEEEE
409
This program is free software; you can redistribute it
410
and/or modify it under the terms of the GNU General Public
411
License as published by the Free Software Foundation;
412
either version 2 of the License, or (at your option) any
413
later version.
414
415
This program is distributed in the hope that it will be
416
useful, but WITHOUT ANY WARRANTY; without even the implied
417
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
418
PURPOSE. See the GNU General Public License for more
419
details.
420
421
You should have received a copy of the GNU General Public
422
License along with this program; if not, write to the Free
423
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
424
02139, USA.
425
426
AAAAUUUUTTTTHHHHOOOORRRR
427
Tobias Oetiker <tobi@oetiker.ch>
428
429
430
431
2002-03-27 1.6 SMOKEPING_CONFIG(1)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1