← Back to branch summary

~ubuntu-branches/debian/lenny/smokeping/lenny

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/skel.html

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2006-10-26 21:45:56 UTC
  • mfrom: (1.2.2 upstream) (2.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061026214556-5jnpiesx4vdijmu6
http://bugs.debian.org/395056
* debian/patches/15_clean_makefile.dpatch:
  + remove unneeded and potentially unsecure include paths.
* debian/patches: selected patches from the upstream SVN repository
  + 40_password.dpatch: skip reading the password file when running as a CGI.
  + 50_ldap.dpatch: Make the 'scope' option in the LDAP probe actually work.
  + 60_fping.dpatch:
    * Support the '-S' (set source address, see #198486) fping option.
    * Don't try to execute fping when running as a CGI.
  + 70_syslog.dpatch: Don't die silently if syslogd is unavailable.
    (Closes: #395056)
* Remove all the autogenerated documentation at clean time, to properly
  undo the effects of the 'build' target.
* Install example configuration files for documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Smokeping/probes/skel.html
 
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">
 
3
<head>
 
4
<title>Smokeping/probes/skel</title>
 
5
<link rev="made" href="mailto:dws@ee.ethz.ch" />
 
6
</head>
 
7
 
 
8
<body style="background-color: white">
 
9
 
 
10
<p><a name="__index__"></a></p>
 
11
<!-- INDEX BEGIN -->
 
12
<!--
 
13
 
 
14
<ul>
 
15
 
 
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="#variables">VARIABLES</a></li>
 
20
        <li><a href="#authors">AUTHORS</a></li>
 
21
        <li><a href="#see_also">SEE ALSO</a></li>
 
22
</ul>
 
23
-->
 
24
<!-- INDEX END -->
 
25
 
 
26
<p>
 
27
</p>
 
28
<h1><a name="name">NAME</a></h1>
 
29
<p>Smokeping::probes::skel - a skeleton for Smokeping Probes</p>
 
30
<p>
 
31
</p>
 
32
<hr />
 
33
<h1><a name="synopsis">SYNOPSIS</a></h1>
 
34
<pre>
 
35
 *** Probes ***</pre>
 
36
<pre>
 
37
 +skel</pre>
 
38
<pre>
 
39
 forks = 5
 
40
 offset = 50%
 
41
 step = 300
 
42
 timeout = 15</pre>
 
43
<pre>
 
44
 # The following variables can be overridden in each target section
 
45
 pings = 5</pre>
 
46
<pre>
 
47
 # [...]</pre>
 
48
<pre>
 
49
 *** Targets ***</pre>
 
50
<pre>
 
51
 probe = skel # if this should be the default probe</pre>
 
52
<pre>
 
53
 # [...]</pre>
 
54
<pre>
 
55
 + mytarget
 
56
 # probe = skel # if the default probe is something else
 
57
 host = my.host
 
58
 pings = 5</pre>
 
59
<p>
 
60
</p>
 
61
<hr />
 
62
<h1><a name="description">DESCRIPTION</a></h1>
 
63
<p>This is a non-functional module that is intended to act as a
 
64
basis for creation of new probes. See the <a href="./../../smokeping_extend.html">the smokeping_extend manpage</a>
 
65
document for more information.</p>
 
66
<p>
 
67
</p>
 
68
<hr />
 
69
<h1><a name="variables">VARIABLES</a></h1>
 
70
<p>Supported probe-specific variables:</p>
 
71
<dl>
 
72
<dt><strong><a name="item_forks">forks</a></strong><br />
 
73
 
 
74
</dt><dd>
 
75
Run this many concurrent processes at maximum
 
76
 
 
77
</dd><dd>
 
78
<p>Example value: 5</p>
 
79
 
 
80
</dd><dd>
 
81
<p>Default value: 5</p>
 
82
 
 
83
<p></p>
 
84
</dd><dt><strong><a name="item_offset">offset</a></strong><br />
 
85
 
 
86
</dt><dd>
 
87
If you run many probes concurrently you may want to prevent them from
 
88
hitting your network all at the same time. Using the probe-specific
 
89
offset parameter you can change the point in time when each probe will
 
90
be run. Offset is specified in % of total interval, or alternatively as
 
91
'random', and the offset from the 'General' section is used if nothing
 
92
is specified here. Note that this does NOT influence the rrds itself,
 
93
it is just a matter of when data acqusition is initiated.
 
94
(This variable is only applicable if the variable 'concurrentprobes' is set
 
95
in the 'General' section.)
 
96
 
 
97
</dd><dd>
 
98
<p>Example value: 50%</p>
 
99
 
 
100
<p></p>
 
101
</dd><dt><strong><a name="item_step">step</a></strong><br />
 
102
 
 
103
</dt><dd>
 
104
Duration of the base interval that this probe should use, if different
 
105
from the one specified in the 'Database' section. Note that the step in
 
106
the RRD files is fixed when they are originally generated, and if you
 
107
change the step parameter afterwards, you'll have to delete the old RRD
 
108
files or somehow convert them. (This variable is only applicable if
 
109
the variable 'concurrentprobes' is set in the 'General' section.)
 
110
 
 
111
</dd><dd>
 
112
<p>Example value: 300</p>
 
113
 
 
114
<p></p>
 
115
</dd><dt><strong><a name="item_timeout">timeout</a></strong><br />
 
116
 
 
117
</dt><dd>
 
118
How long a single 'ping' takes at maximum
 
119
 
 
120
</dd><dd>
 
121
<p>Example value: 15</p>
 
122
 
 
123
</dd><dd>
 
124
<p>Default value: 5</p>
 
125
 
 
126
<p></p></dd></dl>
 
127
<p>Supported target-specific variables:</p>
 
128
<dl>
 
129
<dt><strong><a name="item_pings">pings</a></strong><br />
 
130
 
 
131
</dt><dd>
 
132
How many pings should be sent to each target, if different from the global
 
133
value specified in the Database section. Note that the number of pings in
 
134
the RRD files is fixed when they are originally generated, and if you
 
135
change this parameter afterwards, you'll have to delete the old RRD
 
136
files or somehow convert them.
 
137
 
 
138
</dd><dd>
 
139
<p>Example value: 5</p>
 
140
 
 
141
<p></p></dd></dl>
 
142
<p>
 
143
</p>
 
144
<hr />
 
145
<h1><a name="authors">AUTHORS</a></h1>
 
146
<pre>
 
147
 Niko Tyni &lt;ntyni@iki.fi&gt;,</pre>
 
148
<p>
 
149
</p>
 
150
<hr />
 
151
<h1><a name="see_also">SEE ALSO</a></h1>
 
152
<p><a href="./../../smokeping_extend.html">the smokeping_extend manpage</a></p>
 
153
 
 
154
</body>
 
155
 
 
156
</html>