← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/EchoPingChargen.pod

  • 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/EchoPingChargen.pod
 
1
=head1 NAME
 
2
 
 
3
Smokeping::probes::EchoPingChargen - an echoping(1) probe for SmokePing
 
4
 
 
5
=head1 OVERVIEW
 
6
 
 
7
Measures TCP chargen (port 19) roundtrip times for SmokePing.
 
8
 
 
9
=head1 SYNOPSIS
 
10
 
 
11
 *** Probes ***
 
12
 
 
13
 +EchoPingChargen
 
14
 
 
15
 binary = /usr/bin/echoping
 
16
 forks = 5
 
17
 offset = 50%
 
18
 step = 300
 
19
 
 
20
 # The following variables can be overridden in each target section
 
21
 extraopts = -some-letter-the-author-did-not-think-of
 
22
 fill = A
 
23
 ipversion = 4
 
24
 pings = 5
 
25
 priority = 6
 
26
 size = 510
 
27
 timeout = 1
 
28
 tos = 0xa0
 
29
 waittime = 1
 
30
 
 
31
 # [...]
 
32
 
 
33
 *** Targets ***
 
34
 
 
35
 probe = EchoPingChargen # if this should be the default probe
 
36
 
 
37
 # [...]
 
38
 
 
39
 + mytarget
 
40
 # probe = EchoPingChargen # if the default probe is something else
 
41
 host = my.host
 
42
 extraopts = -some-letter-the-author-did-not-think-of
 
43
 fill = A
 
44
 ipversion = 4
 
45
 pings = 5
 
46
 priority = 6
 
47
 size = 510
 
48
 timeout = 1
 
49
 tos = 0xa0
 
50
 waittime = 1
 
51
 
 
52
=head1 VARIABLES
 
53
 
 
54
Supported probe-specific variables:
 
55
 
 
56
=over
 
57
 
 
58
=item binary
 
59
 
 
60
The location of your echoping binary.
 
61
 
 
62
Default value: /usr/bin/echoping
 
63
 
 
64
=item forks
 
65
 
 
66
Run this many concurrent processes at maximum
 
67
 
 
68
Example value: 5
 
69
 
 
70
Default value: 5
 
71
 
 
72
=item offset
 
73
 
 
74
If you run many probes concurrently you may want to prevent them from
 
75
hitting your network all at the same time. Using the probe-specific
 
76
offset parameter you can change the point in time when each probe will
 
77
be run. Offset is specified in % of total interval, or alternatively as
 
78
'random', and the offset from the 'General' section is used if nothing
 
79
is specified here. Note that this does NOT influence the rrds itself,
 
80
it is just a matter of when data acqusition is initiated.
 
81
(This variable is only applicable if the variable 'concurrentprobes' is set
 
82
in the 'General' section.)
 
83
 
 
84
Example value: 50%
 
85
 
 
86
=item step
 
87
 
 
88
Duration of the base interval that this probe should use, if different
 
89
from the one specified in the 'Database' section. Note that the step in
 
90
the RRD files is fixed when they are originally generated, and if you
 
91
change the step parameter afterwards, you'll have to delete the old RRD
 
92
files or somehow convert them. (This variable is only applicable if
 
93
the variable 'concurrentprobes' is set in the 'General' section.)
 
94
 
 
95
Example value: 300
 
96
 
 
97
=back
 
98
 
 
99
Supported target-specific variables:
 
100
 
 
101
=over
 
102
 
 
103
=item extraopts
 
104
 
 
105
Any extra options specified here will be passed unmodified to echoping(1).
 
106
 
 
107
Example value: -some-letter-the-author-did-not-think-of
 
108
 
 
109
=item fill
 
110
 
 
111
The "-f" echoping(1) option.
 
112
 
 
113
Example value: A
 
114
 
 
115
=item ipversion
 
116
 
 
117
The IP protocol used. Possible values are "4" and "6". 
 
118
Passed to echoping(1) as the "-4" or "-6" options.
 
119
 
 
120
Example value: 4
 
121
 
 
122
=item pings
 
123
 
 
124
How many pings should be sent to each target, if different from the global
 
125
value specified in the Database section. Note that the number of pings in
 
126
the RRD files is fixed when they are originally generated, and if you
 
127
change this parameter afterwards, you'll have to delete the old RRD
 
128
files or somehow convert them.
 
129
 
 
130
Example value: 5
 
131
 
 
132
=item priority
 
133
 
 
134
The "-p" echoping(1) option.
 
135
 
 
136
Example value: 6
 
137
 
 
138
=item size
 
139
 
 
140
The "-s" echoping(1) option.
 
141
 
 
142
Example value: 510
 
143
 
 
144
=item timeout
 
145
 
 
146
The "-t" echoping(1) option.
 
147
 
 
148
Example value: 1
 
149
 
 
150
Default value: 5
 
151
 
 
152
=item tos
 
153
 
 
154
The "-P" echoping(1) option.
 
155
 
 
156
Example value: 0xa0
 
157
 
 
158
=item waittime
 
159
 
 
160
The "-w" echoping(1) option.
 
161
 
 
162
Example value: 1
 
163
 
 
164
=back
 
165
 
 
166
 
 
167
=head1 AUTHORS
 
168
 
 
169
Niko Tyni <ntyni@iki.fi>
 
170
 
 
171
=head1 NOTES
 
172
 
 
173
The I<udp> variable is not supported.
 
174
 
 
175
=head1 SEE ALSO
 
176
 
 
177
L<Smokeping::probes::EchoPing>
 
178
 
 
179
=cut
 
 
b'\\ No newline at end of file'