Smokeping_probes_EchoPingLDAP(3)

1Smokeping_probes_EchoPingLDAP(3)   SmokePing  Smokeping_probes_EchoPingLDAP(3)
2
3
4

NAME

6       Smokeping::probes::EchoPingLDAP - an echoping(1) probe for SmokePing
7

OVERVIEW

9       Measures LDAP roundtrip times for SmokePing with the echoping_ldap
10       plugin.
11

SYNOPSIS

13        *** Probes ***
14
15        +EchoPingLDAP
16
17        binary = /usr/bin/echoping
18        forks = 5
19        offset = 50%
20        step = 300
21
22        # The following variables can be overridden in each target section
23        extraopts = -some-letter-the-author-did-not-think-of
24        ipversion = 4
25        ldap_base = dc=current,dc=bugs,dc=debian,dc=org
26        ldap_request = (objectclass=*)
27        ldap_scope = one
28        pings = 5
29        plugin = /path/to/ldap.so
30        pluginargs = -p plugin_specific_arg
31        priority = 6
32        timeout = 1
33        tos = 0xa0
34        waittime = 1
35
36        # [...]
37
38        *** Targets ***
39
40        probe = EchoPingLDAP # if this should be the default probe
41
42        # [...]
43
44        + mytarget
45        # probe = EchoPingLDAP # if the default probe is something else
46        host = my.host
47        extraopts = -some-letter-the-author-did-not-think-of
48        ipversion = 4
49        ldap_base = dc=current,dc=bugs,dc=debian,dc=org
50        ldap_request = (objectclass=*)
51        ldap_scope = one
52        pings = 5
53        plugin = /path/to/ldap.so
54        pluginargs = -p plugin_specific_arg
55        priority = 6
56        timeout = 1
57        tos = 0xa0
58        waittime = 1
59

VARIABLES

61       Supported probe-specific variables:
62
63       binary
64           The location of your echoping binary.
65
66           Default value: /usr/bin/echoping
67
68       forks
69           Run this many concurrent processes at maximum
70
71           Example value: 5
72
73           Default value: 5
74
75       offset
76           If you run many probes concurrently you may want to prevent them
77           from hitting your network all at the same time. Using the probe-
78           specific offset parameter you can change the point in time when
79           each probe will be run. Offset is specified in % of total interval,
80           or alternatively as 'random', and the offset from the 'General'
81           section is used if nothing is specified here. Note that this does
82           NOT influence the rrds itself, it is just a matter of when data
83           acqusition is initiated.  (This variable is only applicable if the
84           variable 'concurrentprobes' is set in the 'General' section.)
85
86           Example value: 50%
87
88       step
89           Duration of the base interval that this probe should use, if
90           different from the one specified in the 'Database' section. Note
91           that the step in the RRD files is fixed when they are originally
92           generated, and if you change the step parameter afterwards, you'll
93           have to delete the old RRD files or somehow convert them. (This
94           variable is only applicable if the variable 'concurrentprobes' is
95           set in the 'General' section.)
96
97           Example value: 300
98
99       Supported target-specific variables:
100
101       extraopts
102           Any extra options specified here will be passed unmodified to
103           echoping(1).
104
105           Example value: -some-letter-the-author-did-not-think-of
106
107       ipversion
108           The IP protocol used. Possible values are "4" and "6".  Passed to
109           echoping(1) as the "-4" or "-6" options.
110
111           Example value: 4
112
113       ldap_base
114           The echoping_ldap '-b' option: base of the search.
115
116           Example value: dc=current,dc=bugs,dc=debian,dc=org
117
118       ldap_request
119           The echoping_ldap '-r' option: the request to the LDAP server, in
120           LDAP filter language.
121
122           Example value: (objectclass=*)
123
124       ldap_scope
125           The echoping_ldap '-s' option: scope of the search, "sub", "one" or
126           "base".
127
128           Example value: one
129
130       pings
131           How many pings should be sent to each target, if different from the
132           global value specified in the Database section. Note that the
133           number of pings in the RRD files is fixed when they are originally
134           generated, and if you change this parameter afterwards, you'll have
135           to delete the old RRD files or somehow convert them.
136
137           Example value: 5
138
139       plugin
140           The echoping plugin that will be used. See echoping(1) for details.
141           This can either be the name of the plugin or a full path to the
142           plugin shared object.
143
144           Example value: /path/to/ldap.so
145
146           Default value: ldap
147
148       pluginargs
149           Any extra arguments needed by the echoping plugin specified with
150           the pluginname variable. These are generally provided by the
151           subclass probe.
152
153           Example value: -p plugin_specific_arg
154
155       priority
156           The "-p" echoping(1) option.
157
158           Example value: 6
159
160       timeout
161           The "-t" echoping(1) option.
162
163           Example value: 1
164
165           Default value: 5
166
167       tos The "-P" echoping(1) option.
168
169           Example value: 0xa0
170
171       waittime
172           The "-w" echoping(1) option.
173
174           Example value: 1
175

AUTHORS

177       Niko Tyni <ntyni@iki.fi>
178

NOTES

180       The fill, size and udp EchoPing variables are not valid.
181
182       Plugins, including echoping_ldap, are available starting with echoping
183       version 6.
184

NAME

OVERVIEW

SYNOPSIS

VARIABLES

AUTHORS

NOTES

SEE ALSO