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