3
<TITLE>smokeping</TITLE>
4
<LINK REV="made" HREF="mailto:karrer@iis.ee.ethz.ch">
9
<A NAME="__index__"></A>
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<title>smokeping</title>
5
<link rev="made" href="mailto:root@localhost" />
8
<body style="background-color: white">
10
<p><a name="__index__"></a></p>
10
11
<!-- INDEX BEGIN -->
15
<LI><A HREF="#name">NAME</A></LI>
16
<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
17
<LI><A HREF="#description">DESCRIPTION</A></LI>
18
<LI><A HREF="#setup">SETUP</A></LI>
19
<LI><A HREF="#copyright">COPYRIGHT</A></LI>
20
<LI><A HREF="#license">LICENSE</A></LI>
21
<LI><A HREF="#author">AUTHOR</A></LI>
16
<li><a href="#name">NAME</a></li>
17
<li><a href="#synopsis">SYNOPSIS</a></li>
18
<li><a href="#description">DESCRIPTION</a></li>
19
<li><a href="#setup">SETUP</a></li>
20
<li><a href="#copyright">COPYRIGHT</a></li>
21
<li><a href="#license">LICENSE</a></li>
22
<li><a href="#author">AUTHOR</a></li>
27
<H1><A NAME="name">NAME</A></H1>
28
<P>smokeping - Commandline tool for SmokePing</P>
31
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
32
<P><STRONG>smokeping</STRONG> [ <STRONG>--email</STRONG> | <STRONG>--makepod</STRONG> | <STRONG>--version</STRONG> | <STRONG>--restart</STRONG> ]</P>
36
--email Send SmokePing Agents to all Targets marked DYNAMIC
37
--makepod Create POD documentation on Config file
38
--version Show SmokePing Version
39
--debug Run Only once and do not Fork
40
--restart Restart SmokePing
41
--nodemon Do no demonize the process (no fork)</PRE>
44
<H1><A NAME="description">DESCRIPTION</A></H1>
45
<P>The <STRONG>smokeping</STRONG> tool is the commandline part of the SmokePing system. Its
29
<h1><a name="name">NAME</a></h1>
30
<p>smokeping - Commandline tool for SmokePing</p>
34
<h1><a name="synopsis">SYNOPSIS</a></h1>
35
<p><strong>smokeping</strong> [ <strong>--email</strong> | <strong>--makepod</strong> | <strong>--version</strong> | <strong>--restart</strong> ]</p>
39
--man Show the manpage</pre>
43
--email Send SmokePing Agents to all Targets marked DYNAMIC</pre>
45
--makepod Create POD documentation on Config file</pre>
47
--version Show SmokePing Version</pre>
49
--debug Run Only once and do not Fork</pre>
51
--debug-daemon Start the daemon with debugging enabled</pre>
53
--restart Restart SmokePing</pre>
55
--nodaemon Do no daemonize the process (no fork)</pre>
57
--filter=x Only measure entries which pass the filter x</pre>
59
--logfile Append warnings to this logfile</pre>
61
--static[=x] Generates a static website in directory x. If x is left out,
62
pagedir from the config is used.</pre>
64
--nosleep For debugging you may want to run SmokePing without sleep interval</pre>
68
<h1><a name="description">DESCRIPTION</a></h1>
69
<p>The <strong>smokeping</strong> tool is the commandline part of the SmokePing system. Its
46
70
main function is to run as a daemon and send Pings to all the Targets you
47
have specified in the Config file. When you call <STRONG>smokeping</STRONG> without
48
arguments it will start as a daemon and do it's work.</P>
49
<P>If called with an argument, then further functions can be activated, as seen
50
in the Synopsis above. The <STRONG>--email</STRONG> function is explained in the
51
documentation on the config file.</P>
52
<P>The <STRONG>--makepod</STRONG> does get used internally to produce the documentation on
53
the SmokePing configuration file.</P>
54
<P>Please refer to the installation document for detailed setup instructions.</P>
57
<H1><A NAME="setup">SETUP</A></H1>
58
<P>When installing SmokePing, this file has to be adjusted to fit your
59
local system. Three paths have to be entered.</P>
61
use lib qw(/usr/pack/rrdtool-1.0.33-to/lib/perl);</PRE>
62
<P>One pointing to your <STRONG>rrdtool</STRONG> installation</P>
64
use lib qw(/home/oetiker/public_html/smokeping/lib);</PRE>
65
<P>One pointing to the place where you have installed the SmokePing libraries</P>
69
Smokeping::main("/home/oetiker/.smokeping/config");</PRE>
70
<P>The third path is the argument to the Smokeping::main command. It points to
71
the SmokePing configuration file.</P>
74
<H1><A NAME="copyright">COPYRIGHT</A></H1>
75
<P>Copyright (c) 2001 by Tobias Oetiker. All right reserved.</P>
78
<H1><A NAME="license">LICENSE</A></H1>
79
<P>This program is free software; you can redistribute it
71
have specified in the Config file. When you call <strong>smokeping</strong> without
72
arguments it will start as a daemon and do its work.</p>
73
<p>If called with an argument, then further functions can be activated, as seen
74
in the Synopsis above. The <strong>--email</strong> function is explained in the
75
documentation on the config file.</p>
76
<p>The <strong>--filter</strong> option allows you to run the daemon on a big config file,
77
but have the config file filtered and only measure the entries that pass the
78
filter. This is useful for remote measurement. Run Smokeping with two
79
exclusive filters in two locations and rsync the rrds back to the webserver
80
host where you run the cgi. Filters act on the section names in the config
81
file. Multiple section names are concatenated with <strong>/</strong> like path names:</p>
95
<p>If I want to monitor /A my filter would look like this:</p>
98
<p>Filters follow regular expression syntax. The are always anchored at the tip of the string.
99
by adding a <strong>!</strong> to the front of the filter string you negate it. Matching entries will be excluded from monitoring.
100
Multiple <strong>--filter</strong> arguments can be used to assemble complex filters:</p>
102
--filter=/A --filter=/B</pre>
103
<p>would include all the targets</p>
105
--filter=/A --filter=/B --filter=!/B/C</pre>
106
<p>would include all but /B/C.</p>
107
<p>The <strong>--makepod</strong> does get used internally to produce the documentation on
108
the SmokePing configuration file.</p>
109
<p>Please refer to the installation document for detailed setup instructions.</p>
113
<h1><a name="setup">SETUP</a></h1>
114
<p>When installing SmokePing, this file has to be adjusted to fit your
115
local system. Three paths have to be entered.</p>
116
<p>One pointing to your <strong>rrdtool</strong> installation</p>
118
use lib qw(/usr/pack/rrdtool-1.0.33-to/lib/perl);</pre>
119
<p>One pointing to the place where you have installed the SmokePing libraries</p>
121
use lib qw(/home/oetiker/public_html/smokeping/lib);</pre>
122
<p>The third path is the argument to the Smokeping::main command. It points to
123
the SmokePing configuration file.</p>
126
Smokeping::main("/home/oetiker/.smokeping/config");</pre>
130
<h1><a name="copyright">COPYRIGHT</a></h1>
131
<p>Copyright (c) 2002 by Tobias Oetiker. All right reserved.</p>
135
<h1><a name="license">LICENSE</a></h1>
136
<p>This program is free software; you can redistribute it
80
137
and/or modify it under the terms of the GNU General Public
81
138
License as published by the Free Software Foundation; either
82
139
version 2 of the License, or (at your option) any later
84
<P>This program is distributed in the hope that it will be
141
<p>This program is distributed in the hope that it will be
85
142
useful, but WITHOUT ANY WARRANTY; without even the implied
86
143
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
87
144
PURPOSE. See the GNU General Public License for more
89
<P>You should have received a copy of the GNU General Public
146
<p>You should have received a copy of the GNU General Public
90
147
License along with this program; if not, write to the Free
91
148
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
95
<H1><A NAME="author">AUTHOR</A></H1>
96
<P>Tobias Oetiker <<A HREF="mailto:tobi@oetiker.ch">tobi@oetiker.ch</A>></P>
153
<h1><a name="author">AUTHOR</a></h1>
154
<p>Tobias Oetiker <<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>></p>
added
removed
doc/smokeping.html
