1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
4
.\" ========================================================================
5
.de Sh \" Subsection heading
13
.de Sp \" Vertical space (when we can't use .PP)
17
.de Vb \" Begin verbatim text
22
.de Ve \" End verbatim text
26
.\" Set up some character translations and predefined strings. \*(-- will
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28
.\" double quote, and \*(R" will give a right double quote. | will give a
29
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51
.\" If the F register is turned on, we'll generate index entries on stderr for
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53
.\" entries marked with X<> in POD. Of course, you'll have to process the
54
.\" output yourself in some meaningful fashion.
57
. tm Index:\\$1\t\\n%\t"\\$2"
63
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64
.\" way too many mistakes in technical documents.
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69
.\" Fear. Run. Save yourself. No user-serviceable parts.
70
. \" fudge factors for nroff and troff
79
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85
. \" simple accents for nroff and troff
95
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102
. \" troff and (daisy-wheel) nroff accents
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110
.ds ae a\h'-(\w'a'u*4/10)'e
111
.ds Ae A\h'-(\w'A'u*4/10)'E
112
. \" corrections for vroff
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115
. \" for low resolution devices (crt and lpr)
116
.if \n(.H>23 .if \n(.V>19 \
129
.\" ========================================================================
131
.IX Title "SMOKEPING_CONFIG 1"
132
.TH SMOKEPING_CONFIG 1 "2005-01-30" "1.38" "SmokePing"
134
smokeping_config \- Reference for the SmokePing Config File
136
.IX Header "OVERVIEW"
137
SmokePing takes its configuration from a single central configuration file.
138
Its location must be hardcoded in the smokeping script and smokeping.cgi.
140
The contents of this manual is generated directly from the configuration
143
The Parser for the Configuration file is written using David Schweikers
144
ParseConfig module. Read all about it in ISG::ParseConfig.
146
The Configuration file has a tree-like structure with section headings at
147
various levels. It also contains variable assignments and tables.
149
.IX Header "REFERENCE"
150
The text below describes the syntax of the SmokePing configuration file.
151
.Sh "*** General *** \fI(mandatory section)\fP"
152
.IX Subsection "*** General *** (mandatory section)"
153
General configuration values valid for the whole SmokePing setup.
155
The following variables can be set in this section:
156
.IP "\fBowner\fR \fI(mandatory setting)\fR" 4
157
.IX Item "owner (mandatory setting)"
158
Name of the person responsible for this smokeping installation.
159
.IP "\fBimgcache\fR \fI(mandatory setting)\fR" 4
160
.IX Item "imgcache (mandatory setting)"
161
A directory which is visible on your webserver where SmokePing can cache graphs.
162
.IP "\fBimgurl\fR \fI(mandatory setting)\fR" 4
163
.IX Item "imgurl (mandatory setting)"
164
Either an absolute \s-1URL\s0 to the \fBimgcache\fR directory or one relative to the directory where you keep the
166
.IP "\fBdatadir\fR \fI(mandatory setting)\fR" 4
167
.IX Item "datadir (mandatory setting)"
168
The directory where SmokePing can keep its rrd files.
169
.IP "\fBpagedir\fR" 4
171
Directory to store static representations of pages.
172
.IP "\fBpiddir\fR \fI(mandatory setting)\fR" 4
173
.IX Item "piddir (mandatory setting)"
174
The directory where SmokePing keeps its pid when daemonised.
175
.IP "\fBsendmail\fR" 4
177
Path to your sendmail binary. It will be used for sending mails in connection with the support of \s-1DYNAMIC\s0 addresses.
180
If you run many instances of smokeping you may want to prevent them from
181
hitting your network all at the same time. Using the offset parameter you
182
can change the point in time when the probes are run. Offset is specified
183
in % of total interval, or alternatively as 'random'. I recommend to use
184
\&'random'. Note that this does \s-1NOT\s0 influence the rrds itself, it is just a
185
matter of when data acqusition is initiated. The default offset is 'random'.
186
.IP "\fBsmokemail\fR \fI(mandatory setting)\fR" 4
187
.IX Item "smokemail (mandatory setting)"
188
Path to the mail template for \s-1DYNAMIC\s0 hosts. This mail template
189
must contain keywords of the form \fB<##\fR\fIkeyword\fR\fB##>\fR. There is a sample
190
template included with SmokePing.
191
.IP "\fBcgiurl\fR \fI(mandatory setting)\fR" 4
192
.IX Item "cgiurl (mandatory setting)"
193
Complete \s-1URL\s0 path of the SmokePing.cgi
194
.IP "\fBmailhost\fR" 4
196
Instead of using sendmail, you can specify the name of an smtp server
197
and use perl's Net::SMTP module to send mail to \s-1DYNAMIC\s0 host owners (see below).
198
.IP "\fBcontact\fR \fI(mandatory setting)\fR" 4
199
.IX Item "contact (mandatory setting)"
200
Mail address of the person responsible for this smokeping installation.
201
.IP "\fBnetsnpp\fR" 4
204
.IP "\fBsyslogfacility\fR" 4
205
.IX Item "syslogfacility"
207
The syslog facility to use, eg. local0...local7.
208
Note: syslog logging is only used if you specify this.
209
.IP "\fBsyslogpriority\fR" 4
210
.IX Item "syslogpriority"
211
The syslog priority to use, eg. debug, notice or info.
213
.IP "\fBconcurrentprobes\fR" 4
214
.IX Item "concurrentprobes"
215
If you use multiple probes or multiple instances of the same probe and you
216
want them to run concurrently in separate processes, set this to 'yes'. This
217
gives you the possibility to specify probe-specific step and offset parameters
218
(see the 'Probes' section) for each probe and makes the probes unable to block
219
each other in cases of service outages. The default is 'yes', but if you for
220
some reason want the old behaviour you can set this to 'no'.
221
.IP "\fBchangeprocessnames\fR" 4
222
.IX Item "changeprocessnames"
223
When using 'concurrentprobes' (see above), this controls whether the probe
224
subprocesses should change their argv string to indicate their probe in
225
the process name. If set to 'yes' (the default), the probe name will
226
be appended to the process name as '[probe]', eg. '/usr/bin/smokeping
227
[FPing]'. If you don't like this behaviour, set this variable to 'no'.
228
If 'concurrentprobes' is not set to 'yes', this variable has no effect.
229
.Sh "*** Database *** \fI(mandatory section)\fP"
230
.IX Subsection "*** Database *** (mandatory section)"
231
Describes the properties of the round robin database for storing the
232
SmokePing data. Note that it is not possible to edit existing RRDs
233
by changing the entries in the cfg file.
235
The following variables can be set in this section:
236
.IP "\fBstep\fR \fI(mandatory setting)\fR" 4
237
.IX Item "step (mandatory setting)"
238
Duration of the base operation interval of SmokePing in seconds.
239
SmokePing will venture out every \fBstep\fR seconds to ping your target hosts.
240
If 'concurrent_probes' is set to 'yes' (see above), this variable can be
241
overridden by each probe. Note that the step in the \s-1RRD\s0 files is fixed when
242
they are originally generated, and if you change the step parameter afterwards,
243
you'll have to delete the old \s-1RRD\s0 files or somehow convert them.
244
.IP "\fBpings\fR \fI(mandatory setting)\fR" 4
245
.IX Item "pings (mandatory setting)"
246
How many pings should be sent to each target. Suggested: 20 pings.
247
This can be overridden by each probe. Some probes (those derived from
248
basefork.pm, ie. most except the FPing variants) will even let this
249
be overridden target-specifically in the \s-1PROBE_CONF\s0 section (see the
250
basefork documentation for details). Note that the number of pings in
251
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
252
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
253
files or somehow convert them.
255
This section also contains a table describing the setup of the
256
SmokePing database. Below are reasonable defaults. Only change them if
257
you know rrdtool and its workings. Each row in the table describes one \s-1RRA\s0.
260
\& # cons xff steps rows
261
\& AVERAGE 0.5 1 1008
262
\& AVERAGE 0.5 12 4320
265
\& AVERAGE 0.5 144 720
271
Consolidation method.
274
What part of the consolidated intervals must be known to warrant a known entry.
277
How many \fBsteps\fR to consolidate into for each \s-1RRA\s0 entry.
280
How many \fBrows\fR this \s-1RRA\s0 should have.
281
.Sh "*** Presentation *** \fI(mandatory section)\fP"
282
.IX Subsection "*** Presentation *** (mandatory section)"
283
Defines how the SmokePing data should be presented.
285
The following variables can be set in this section:
286
.IP "\fBtemplate\fR \fI(mandatory setting)\fR" 4
287
.IX Item "template (mandatory setting)"
288
The webpage template must contain keywords of the form
289
\&\fB<##\fR\fIkeyword\fR\fB##>\fR. There is a sample
290
template included with SmokePing; use it as the basis for your
291
experiments. Default template contains a pointer to the SmokePing
292
counter and homepage. I would be glad if you would not remove this as
293
it gives me an indication as to how widely used the tool is.
294
.IP "\fBcharset\fR" 4
296
By default, SmokePing assumes the 'iso\-8859\-15' character set. If you use
297
something else, this is the place to speak up.
299
The following sections are valid on level 1:
300
.IP "\fB+overview\fR \fI(mandatory section)\fR" 4
301
.IX Item "+overview (mandatory section)"
302
The Overview section defines how the Overview graphs should look.
304
The following variables can be set in this section:
306
.IP "\fBwidth\fR \fI(mandatory setting)\fR" 4
307
.IX Item "width (mandatory setting)"
308
Width of the Overview Graphs.
309
.IP "\fBheight\fR \fI(mandatory setting)\fR" 4
310
.IX Item "height (mandatory setting)"
311
Height of the Overview Graphs.
314
How much time should be depicted in the Overview graph. Time must be specified
315
as a number followed by a letter which specifies the unit of time. Known units are:
316
\&\fBs\fReconds, \fBm\fRinutes, \fBh\fRours, \fBd\fRdays, \fBw\fReeks, \fBy\fRears.
317
.IP "\fBmax_rtt\fR" 4
319
Any roundtrip time larger than this value will cropped in the overview graph
320
.IP "\fBmedian_color\fR" 4
321
.IX Item "median_color"
322
By default the median line is drawn in red. Override it here with a hex color
323
in the format \fIrrggbb\fR.
324
.IP "\fBstrftime\fR" 4
326
Use posix strftime to format the timestamp in the left hand
327
lower corner of the overview graph
331
.IP "\fB+detail\fR \fI(mandatory section)\fR" 4
332
.IX Item "+detail (mandatory section)"
333
The following variables can be set in this section:
335
.IP "\fBwidth\fR \fI(mandatory setting)\fR" 4
336
.IX Item "width (mandatory setting)"
337
How many pixels wide should detail graphs be
338
.IP "\fBheight\fR \fI(mandatory setting)\fR" 4
339
.IX Item "height (mandatory setting)"
340
How many pixels high should detail graphs be
341
.IP "\fBlogarithmic\fR" 4
342
.IX Item "logarithmic"
343
should the graphs be shown in a logarithmic scale (yes/no)
344
.IP "\fBunison_tolerance\fR" 4
345
.IX Item "unison_tolerance"
346
if a graph is more than this factor of the median 'max' it drops out of the unison scaling algorithm. 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
347
.IP "\fBmax_rtt\fR" 4
349
Any roundtrip time larger than this value will cropped in the detail graph
350
.IP "\fBstrftime\fR" 4
352
Use posix strftime to format the timestamp in the left hand
353
lower corner of the detail graph
354
.IP "\fBnodata_color\fR" 4
355
.IX Item "nodata_color"
356
Paint the graph background in a special color when there is no data for this period because smokeping has not been running (#rrggbb)
360
The detailed display can contain several graphs of different resolution. In this
361
table you can specify the resolution of each graph.
367
\& "Last 30 Hours" 30h
368
\& "Last 10 Days" 10d
369
\& "Last 400 Days" 400d
373
Description of the particular resolution.
376
How much time should be depicted. The format is the same as for the \fBage\fR parameter of the Overview section.
380
The following sections are valid on level 2:
381
.IP "\fB++loss_colors\fR" 4
382
.IX Item "++loss_colors"
383
In the Detail view, the color of the median line depends
384
the amount of lost packets. SmokePing comes with a reasonable default setting,
385
but you may choose to disagree. The table below
386
lets you specify your own coloring.
399
Activate when the lossrate (in percent) is larger of equal to this number
402
Color for this range.
405
Description for this range.
409
.IP "\fB++uptime_colors\fR" 4
410
.IX Item "++uptime_colors"
411
When monitoring a host with \s-1DYNAMIC\s0 addressing, SmokePing will keep
412
track of how long the machine is able to keep the same \s-1IP\s0
413
address. This time is plotted as a color in the graphs
414
background. SmokePing comes with a reasonable default setting, but you
415
may choose to disagree. The table below lets you specify your own
421
\& # Uptime Color Legend
423
\& 86400 0000ff "<1d"
424
\& 604800 ff0000 "<1w"
425
\& 1000000000000 ffff00 ">1w"
432
Activate when uptime in days is larger of equal to this number
435
Color for this uptime range range.
438
Description for this range.
445
.Sh "*** Probes *** \fI(mandatory section)\fP"
446
.IX Subsection "*** Probes *** (mandatory section)"
447
The Probes Section configures Probe modules. Probe modules integrate an external ping command into SmokePing. Check the documentation of the FPing module for configuration details.
449
The following sections are valid on level 1:
450
.IP "\fB+/[\-_0\-9a\-zA\-Z]+/\fR" 4
451
.IX Item "+/[-_0-9a-zA-Z]+/"
452
Each module can take specific configuration information from this area. The jumble of letters above is a regular expression defining legal module names.
454
The following variables can be set in this section:
458
Duration of the base interval that this probe should use, if different
459
from the one specified in the 'Database' section. Note that the step in
460
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
461
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
462
files or somehow convert them. (This variable is only applicable if
463
the variable 'concurrentprobes' is set in the 'General' section.)
466
If you run many probes concurrently you may want to prevent them from
467
hitting your network all at the same time. Using the probe-specific
468
offset parameter you can change the point in time when each probe will
469
be run. Offset is specified in % of total interval, or alternatively as
470
\&'random', and the offset from the 'General' section is used if nothing
471
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
472
it is just a matter of when data acqusition is initiated.
473
(This variable is only applicable if the variable 'concurrentprobes' is set
474
in the 'General' section.)
477
How many pings should be sent to each target, if different from the global
478
value specified in the Database section. Some probes (those derived from
479
basefork.pm, ie. most except the FPing variants) will even let this be
480
overridden target-specifically in the \s-1PROBE_CONF\s0 section (see the
481
basefork documentation for details). Note that the number of pings in
482
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
483
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
484
files or somehow convert them.
485
.IP "\fB/[\-_0\-9a\-zA\-Z.]+/\fR" 4
486
.IX Item "/[-_0-9a-zA-Z.]+/"
487
Each module defines which
488
variables it wants to accept. So this expression here just defines legal variable names.
492
The following sections are valid on level 2:
493
.IP "\fB++/[\-_0\-9a\-zA\-Z]+/\fR" 4
494
.IX Item "++/[-_0-9a-zA-Z]+/"
495
You can define multiple instances of the same probe with subsections.
496
These instances can have different values for their variables, so you
497
can eg. have one instance of the FPing probe with packet size 1000 and
498
step 30 and another instance with packet size 64 and step 300.
499
The name of the subsection determines what the probe will be called, so
500
you can write descriptive names for the probes.
502
If there are any subsections defined, the main section for this probe
503
will just provide default parameter values for the probe instances, ie.
504
it will not become a probe instance itself.
506
The following variables can be set in this section:
515
.IP "\fB/[\-_0\-9a\-zA\-Z.]+/\fR" 4
516
.IX Item "/[-_0-9a-zA-Z.]+/"
518
Each module defines which
519
variables it wants to accept. So this expression here just defines legal variable names.
527
.IX Subsection "*** Alerts ***"
528
The Alert section lets you setup loss and \s-1RTT\s0 pattern detectors. After each
529
round of polling, SmokePing will examine its data and determine which
530
detectors match. Detectors are enabled per target and get inherited by
531
the targets children.
533
Detectors are not just simple thresholds which go off at first sight
534
of a problem. They are configurable to detect special loss or \s-1RTT\s0
535
patterns. They let you look at a number of past readings to make a
536
more educated decision on what kind of alert should be sent, or if an
537
alert should be sent at all.
539
The patterns are numbers prefixed with an operator indicating the type
540
of comparison required for a match.
542
The following \s-1RTT\s0 pattern detects if a target's \s-1RTT\s0 goes from constantly
543
below 10ms to constantly 100ms and more:
546
\& old ------------------------------> new
547
\& <10,<10,<10,<10,<10,>10,>100,>100,>100
550
Loss patterns work in a similar way, except that the loss is defined as the
551
percentage the total number of received packets is of the total number of packets sent.
554
\& old ------------------------------> new
555
\& ==0%,==0%,==0%,==0%,>20%,>20%,>=20%
558
Apart from normal numbers, patterns can also contain the values \fB*\fR
559
which is true for all values regardless of the operator. And \fBU\fR
560
which is true for \fBunknown\fR data together with the \fB==\fR and \fB=!\fR operators.
562
Detectors normally act on state changes. This has the disadvantage, that
563
they will fail to find conditions which were already present when launching
564
smokeping. For this it is possible to write detectors that begin with the
565
special value \fB==S\fR it is inserted whenever smokeping is started up.
573
to detect lines that have been losing more than 20% of the packets for two
574
periods after startup.
576
Sometimes it may be that conditions occur at irregular intervals. But still
577
you only want to throw an alert if they occur several times within a certain
578
amount of times. The operator \fB*X*\fR will ignore up to \fIX\fR values and still
579
let the pattern match:
585
will fire if more than 10% of the packets have been losst twice over the
592
\& to = admin@company.xy,peter@home.xy
593
\& from = smokealert@company.xy
600
\& pattern = ==0%,==0%,==0%,==0%,>20%,>20%,>20%
601
\& comment = suddenly there is packet loss
608
\& pattern = >0%,*12*,>0%,*12*,>0%
609
\& comment = detected loss 3 times over the last two hours
616
\& pattern = <10,<10,<10,<10,<10,<100,>100,>100,>100
617
\& comment = routing messed up again ?
625
\& comment = offline at startup
628
The following variables can be set in this section:
629
.IP "\fBto\fR \fI(mandatory setting)\fR" 4
630
.IX Item "to (mandatory setting)"
632
.IP "\fBfrom\fR \fI(mandatory setting)\fR" 4
633
.IX Item "from (mandatory setting)"
636
The following sections are valid on level 1:
637
.IP "\fB+/[^\es,]+/\fR" 4
639
The following variables can be set in this section:
641
.IP "\fBtype\fR \fI(mandatory setting)\fR" 4
642
.IX Item "type (mandatory setting)"
643
Currently the pattern types \fBrtt\fR and \fBloss\fR and \fBmatcher\fR are known
644
.IP "\fBpattern\fR \fI(mandatory setting)\fR" 4
645
.IX Item "pattern (mandatory setting)"
646
a comma separated list of comparison operators and numbers. rtt patterns are in milliseconds, loss patterns are in percents
647
.IP "\fBcomment\fR \fI(mandatory setting)\fR" 4
648
.IX Item "comment (mandatory setting)"
656
.Sh "*** Targets *** \fI(mandatory section)\fP"
657
.IX Subsection "*** Targets *** (mandatory section)"
658
The Target Section defines the actual work of SmokePing. It contains a hierarchical list
659
of hosts which mark the endpoints of the network connections the system should monitor.
660
Each section can contain one host as well as other sections.
662
The following variables can be set in this section:
663
.IP "\fBprobe\fR \fI(mandatory setting)\fR" 4
664
.IX Item "probe (mandatory setting)"
665
The name of the probe module to be used for this host. The value of
666
this variable gets propagated
667
.IP "\fBmenu\fR \fI(mandatory setting)\fR" 4
668
.IX Item "menu (mandatory setting)"
669
Menu entry for this section. If not set this will be set to the hostname.
670
.IP "\fBtitle\fR \fI(mandatory setting)\fR" 4
671
.IX Item "title (mandatory setting)"
672
Title of the page when it is displayed. This will be set to the hostname if
676
An optional remark on the current section. It gets displayed on the webpage.
679
A comma separated list of alerts to check for this target. The alerts have
680
to be setup in the Alerts section. Alerts are inherited by child nodes. Use
681
an empty alerts definition to remove inherited alerts from the current target
684
The following sections are valid on level 1:
685
.IP "\fB+PROBE_CONF\fR" 4
686
.IX Item "+PROBE_CONF"
687
Probe specific variables.
689
The following variables can be set in this section:
691
.IP "\fB/[\-_0\-9a\-zA\-Z.]+/\fR" 4
692
.IX Item "/[-_0-9a-zA-Z.]+/"
693
Should be found in the documentation of the
694
corresponding probe. The values get propagated to those child
695
nodes using the same Probe.
699
.IP "\fB+/[\-_0\-9a\-zA\-Z]+/\fR" 4
700
.IX Item "+/[-_0-9a-zA-Z]+/"
701
Each target section can contain information about a host to monitor as
702
well as further target sections. Most variables have already been
703
described above. The expression above defines legal names for target
706
The following variables can be set in this section:
718
Comma separated list of alert names
721
Some information about this entry which does \s-1NOT\s0 get displayed on the web.
724
This is the contact address for the owner of the current host. In connection with the \fB\s-1DYNAMIC\s0\fR hosts,
725
the address will be used for sending the belowmentioned script.
728
Can either contain the name of a target host or the string \fB\s-1DYNAMIC\s0\fR.
730
In the second case, the target machine has a dynamic \s-1IP\s0 address and
731
thus is required to regularly contact the SmokePing server to verify
732
its \s-1IP\s0 address. When starting SmokePing with the commandline argument
733
\&\fB\-\-email\fR it will add a secret password to each of the \fB\s-1DYNAMIC\s0\fR
734
host lines and send a script to the owner of each host. This script
735
must be started regularly on the host in question to make sure
736
SmokePing monitors the right box. If the target machine supports
737
\&\s-1SNMP\s0 SmokePing will also query the hosts
738
sysContact, sysName and sysLocation properties to make sure it is
746
Log the raw data, gathered for this target, in tab separated format, to a file with the
747
same basename as the corresponding \s-1RRD\s0 file. Use posix strftime to format the timestamp to be
748
put into the file name. The filename is built like this:
751
\& basename.strftime.csv
760
this would create a new logfile every day with a name like this:
763
\& targethost.2004-05-03.csv
765
.IP "\fBalertee\fR" 4
767
If you want to have alerts for this target and all targets below it go to a particular address
768
on top of the address already specified in the alert, you can add it here. This can be a comma separated list of items.
772
The following sections are valid on level 2:
773
.IP "\fB++PROBE_CONF\fR" 4
774
.IX Item "++PROBE_CONF"
775
Probe specific variables.
777
The following variables can be set in this section:
779
.IP "\fB/[\-_0\-9a\-zA\-Z.]+/\fR" 4
780
.IX Item "/[-_0-9a-zA-Z.]+/"
781
Should be found in the documentation of the
782
corresponding probe. The values get propagated to those child
783
nodes using the same Probe.
787
.IP "\fB++/[\-_0\-9a\-zA\-Z]+/\fR" 4
788
.IX Item "++/[-_0-9a-zA-Z]+/"
789
Each target section can contain information about a host to monitor as
790
well as further target sections. Most variables have already been
791
described above. The expression above defines legal names for target
797
.IX Header "COPYRIGHT"
798
Copyright (c) 2001\-2003 by Tobias Oetiker. All right reserved.
801
This program is free software; you can redistribute it
802
and/or modify it under the terms of the \s-1GNU\s0 General Public
803
License as published by the Free Software Foundation; either
804
version 2 of the License, or (at your option) any later
807
This program is distributed in the hope that it will be
808
useful, but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied
809
warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0
810
\&\s-1PURPOSE\s0. See the \s-1GNU\s0 General Public License for more
813
You should have received a copy of the \s-1GNU\s0 General Public
814
License along with this program; if not, write to the Free
815
Software Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0
819
Tobias Oetiker <tobi@oetiker.ch>
added
removed
doc/smokeping_config.1
