smokeping(1)

1SMOKEPING(1)                       SmokePing                      SMOKEPING(1)
2
3
4

NAME

6       smokeping - Commandline tool for SmokePing
7

SYNOPSIS

9       smokeping [ --email | --makepod | --version | --restart ]
10
11        Options:
12
13        --man[=x]    Show the manpage for the program (or for probe x, if specified)
14
15        --help       Help :-)
16
17        --email      Send SmokePing Agents to all Targets marked DYNAMIC
18
19        --config=x   Use a config file different from the default
20
21        --check      Just check the config file syntax, don't start the daemon
22
23        --makepod[=x] Create POD documentation on Config file (or for probe x, if specified)
24
25        --version    Show SmokePing Version
26
27        --debug      Run Only once and do not Fork
28
29        --debug-daemon Start the daemon with debugging enabled
30
31        --restart    Restart SmokePing
32
33        --reload     Reload configuration in the running process without interrupting
34                     any probes
35
36        --nodaemon    Do no daemonize the process (no fork)
37
38        --filter=x   Only measure entries which pass the filter x
39
40        --logfile=x    Append warnings to logfile x.
41
42        --static[=x] Generates a static website in directory x.  If x is left out,
43                     pagedir from the config is used.
44
45        --nosleep    For debugging you may want to run SmokePing without sleep interval
46
47        --gen-examples Generate the smokeping_examples document and example config files
48                       (to be used while building inside the smokeping distribution)
49                       With --check : check the syntax of the generated examples.
50
51        --master-url=s Run smokeping in slave mode. Attach to master for config.
52
53        --slave-name=s By default the slave will use whatever it thinks its name
54                       is, when talking to its master. In some cases you may
55                       probably want to override this.
56
57
58        --shared-secret=s File containing the shared secret for talking to the server.
59
60        --cache-dir=s Directory for temporary data storage when running in slave mode.
61
62        --pid-dir=s Directory for the PID file when running in slave mode.
63                    (optional, defaults to --cache-dir)
64

DESCRIPTION

66       The smokeping tool is the commandline part of the SmokePing system. Its
67       main function is to run as a daemon and send Pings to all the Targets
68       you have specified in the Config file. When you call smokeping without
69       arguments it will start as a daemon and do its work.
70
71       If called with an argument, then further functions can be activated, as
72       seen in the Synopsis above. The --email function is explained in the
73       documentation on the config file.
74
75       The --filter option allows you to run the daemon on a big config file,
76       but have the config file filtered and only measure the entries that
77       pass the filter. This is useful for remote measurement. Run Smokeping
78       with two exclusive filters in two locations and rsync the rrds back to
79       the webserver host where you run the cgi. Filters act on the section
80       names in the config file. Multiple section names are concatenated with
81       / like path names:
82
83        *** targets ***
84        + A
85        ....
86        + B
87        ...
88        ++ C
89
90       This gives
91
92        /A
93
94       and
95
96        /B, /B/C
97
98       If I want to monitor /A my filter would look like this:
99
100        --filter=/A
101
102       Filters follow regular expression syntax. The are always anchored at
103       the tip of the string.  by adding a ! to the front of the filter string
104       you negate it. Matching entries will be excluded from monitoring.
105       Multiple --filter arguments can be used to assemble complex filters:
106
107         --filter=/A --filter=/B
108
109       would include all the targets
110
111         --filter=/A --filter=/B --filter=!/B/C
112
113       would include all but /B/C.
114
115       The --makepod does get used internally to produce the documentation on
116       the SmokePing configuration file.
117
118       Please refer to the installation document for detailed setup
119       instructions.
120

SETUP

122       When installing SmokePing, this file has to be adjusted to fit your
123       local system. Three paths have to be entered.
124
125       One pointing to your rrdtool installation
126
127        use lib qw(/usr/pack/rrdtool-1.0.33-to/lib/perl);
128
129       One pointing to the place where you have installed the SmokePing
130       libraries
131
132        use lib qw(/home/oetiker/public_html/smokeping/lib);
133
134       The third path is the argument to the Smokeping::main command. It
135       points to the SmokePing configuration file.
136
137        use Smokeping;
138        Smokeping::main("/home/oetiker/.smokeping/config");
139

COPYRIGHT

147       Copyright (c) 2002 by Tobias Oetiker. All right reserved.
148

LICENSE

150       This program is free software; you can redistribute it and/or modify it
151       under the terms of the GNU General Public License as published by the
152       Free Software Foundation; either version 2 of the License, or (at your
153       option) any later version.
154
155       This program is distributed in the hope that it will be useful, but
156       WITHOUT ANY WARRANTY; without even the implied warranty of
157       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
158       General Public License for more details.
159
160       You should have received a copy of the GNU General Public License along
161       with this program; if not, write to the Free Software Foundation, Inc.,
162       675 Mass Ave, Cambridge, MA 02139, USA.
163

AUTHOR

165       Tobias Oetiker <tobi@oetiker.ch>
166
167
168
1692.8.2                             2023-07-22                      SMOKEPING(1)