← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/LDAP.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/LDAP.pod
 
1
=head1 NAME
 
2
 
 
3
Smokeping::probes::LDAP - a LDAP probe for SmokePing
 
4
 
 
5
=head1 OVERVIEW
 
6
 
 
7
Measures LDAP search latency for SmokePing
 
8
 
 
9
=head1 SYNOPSIS
 
10
 
 
11
 *** Probes ***
 
12
 
 
13
 +LDAP
 
14
 
 
15
 forks = 5
 
16
 offset = 50%
 
17
 passwordfile = /some/place/secret
 
18
 step = 300
 
19
 
 
20
 # The following variables can be overridden in each target section
 
21
 attrs = uid,someotherattr
 
22
 base = dc=foo,dc=bar
 
23
 binddn = uid=testuser,dc=foo,dc=bar
 
24
 filter = uid=testuser # mandatory
 
25
 mininterval = 1
 
26
 password = mypass
 
27
 pings = 5
 
28
 port = 389
 
29
 scope = one
 
30
 start_tls = 1
 
31
 timeout = 10
 
32
 version = 3
 
33
 
 
34
 # [...]
 
35
 
 
36
 *** Targets ***
 
37
 
 
38
 probe = LDAP # if this should be the default probe
 
39
 
 
40
 # [...]
 
41
 
 
42
 + mytarget
 
43
 # probe = LDAP # if the default probe is something else
 
44
 host = my.host
 
45
 attrs = uid,someotherattr
 
46
 base = dc=foo,dc=bar
 
47
 binddn = uid=testuser,dc=foo,dc=bar
 
48
 filter = uid=testuser # mandatory
 
49
 mininterval = 1
 
50
 password = mypass
 
51
 pings = 5
 
52
 port = 389
 
53
 scope = one
 
54
 start_tls = 1
 
55
 timeout = 10
 
56
 version = 3
 
57
 
 
58
=head1 DESCRIPTION
 
59
 
 
60
This probe measures LDAP query latency for SmokePing.
 
61
The query is specified by the target-specific variable `filter' and,
 
62
optionally, by the target-specific variable `base'. The attributes 
 
63
queried can be specified in the comma-separated list `attrs'.
 
64
 
 
65
The TCP port of the LDAP server and the LDAP version to be used can
 
66
be specified by the variables `port' and `version'.
 
67
 
 
68
The probe can issue the starttls command to convert the connection
 
69
into encrypted mode, if so instructed by the `start_tls' variable.
 
70
This requires the 'IO::Socket::SSL' perl module to be installed.
 
71
 
 
72
The probe can also optionally do an authenticated LDAP bind, if the `binddn'
 
73
variable is present. The password to be used can be specified by the
 
74
target-specific variable `password' or in an external file.
 
75
The location of this file is given in the probe-specific variable
 
76
`passwordfile'. See Smokeping::probes::passwordchecker(3pm) for the format
 
77
of this file (summary: colon-separated triplets of the form
 
78
`<host>:<bind-dn>:<password>')
 
79
 
 
80
The probe tries to be nice to the server and does not send authentication
 
81
requests more frequently than once every X seconds, where X is the value
 
82
of the target-specific "min_interval" variable (1 by default).
 
83
 
 
84
=head1 VARIABLES
 
85
 
 
86
Supported probe-specific variables:
 
87
 
 
88
=over
 
89
 
 
90
=item forks
 
91
 
 
92
Run this many concurrent processes at maximum
 
93
 
 
94
Example value: 5
 
95
 
 
96
Default value: 5
 
97
 
 
98
=item offset
 
99
 
 
100
If you run many probes concurrently you may want to prevent them from
 
101
hitting your network all at the same time. Using the probe-specific
 
102
offset parameter you can change the point in time when each probe will
 
103
be run. Offset is specified in % of total interval, or alternatively as
 
104
'random', and the offset from the 'General' section is used if nothing
 
105
is specified here. Note that this does NOT influence the rrds itself,
 
106
it is just a matter of when data acqusition is initiated.
 
107
(This variable is only applicable if the variable 'concurrentprobes' is set
 
108
in the 'General' section.)
 
109
 
 
110
Example value: 50%
 
111
 
 
112
=item passwordfile
 
113
 
 
114
Location of the file containing usernames and passwords.
 
115
 
 
116
Example value: /some/place/secret
 
117
 
 
118
=item step
 
119
 
 
120
Duration of the base interval that this probe should use, if different
 
121
from the one specified in the 'Database' section. Note that the step in
 
122
the RRD files is fixed when they are originally generated, and if you
 
123
change the step parameter afterwards, you'll have to delete the old RRD
 
124
files or somehow convert them. (This variable is only applicable if
 
125
the variable 'concurrentprobes' is set in the 'General' section.)
 
126
 
 
127
Example value: 300
 
128
 
 
129
=back
 
130
 
 
131
Supported target-specific variables:
 
132
 
 
133
=over
 
134
 
 
135
=item attrs
 
136
 
 
137
The attributes queried.
 
138
 
 
139
Example value: uid,someotherattr
 
140
 
 
141
=item base
 
142
 
 
143
The base to be used in the LDAP query
 
144
 
 
145
Example value: dc=foo,dc=bar
 
146
 
 
147
=item binddn
 
148
 
 
149
If present, authenticate the LDAP bind with this DN.
 
150
 
 
151
Example value: uid=testuser,dc=foo,dc=bar
 
152
 
 
153
=item filter
 
154
 
 
155
The actual search to be made
 
156
 
 
157
Example value: uid=testuser
 
158
 
 
159
This setting is mandatory.
 
160
 
 
161
=item mininterval
 
162
 
 
163
The minimum interval between each query sent, in (possibly fractional) second
 
164
s.
 
165
 
 
166
Default value: 1
 
167
 
 
168
=item password
 
169
 
 
170
The password to be used, if not present in <passwordfile>.
 
171
 
 
172
Example value: mypass
 
173
 
 
174
=item pings
 
175
 
 
176
How many pings should be sent to each target, if different from the global
 
177
value specified in the Database section. Note that the number of pings in
 
178
the RRD files is fixed when they are originally generated, and if you
 
179
change this parameter afterwards, you'll have to delete the old RRD
 
180
files or somehow convert them.
 
181
 
 
182
Example value: 5
 
183
 
 
184
=item port
 
185
 
 
186
TCP port of the LDAP server
 
187
 
 
188
Example value: 389
 
189
 
 
190
=item scope
 
191
 
 
192
The scope of the query. Can be either 'base', 'one' or 'sub'. See the Net::LDAP documentation for details.
 
193
 
 
194
Example value: one
 
195
 
 
196
Default value: sub
 
197
 
 
198
=item start_tls
 
199
 
 
200
If true, encrypt the connection with the starttls command. Disabled by default.
 
201
 
 
202
Example value: 1
 
203
 
 
204
=item timeout
 
205
 
 
206
LDAP query timeout in seconds.
 
207
 
 
208
Example value: 10
 
209
 
 
210
Default value: 5
 
211
 
 
212
=item version
 
213
 
 
214
The LDAP version to be used.
 
215
 
 
216
Example value: 3
 
217
 
 
218
=back
 
219
 
 
220
 
 
221
=head1 AUTHORS
 
222
 
 
223
Niko Tyni <ntyni@iki.fi>
 
224
 
 
225
=head1 BUGS
 
226
 
 
227
There should be a way of specifying TLS options, such as the certificates
 
228
involved etc.
 
229
 
 
230
The probe has an ugly way of working around the fact that the 
 
231
IO::Socket::SSL class complains if start_tls() is done more than once
 
232
in the same program. But It Works For Me (tm).
 
233
 
 
234
=cut
 
 
b'\\ No newline at end of file'