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