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        /^influx_.+/ = influx_location = In the basement
24        extraopts = -some-letter-the-author-did-not-think-of
25        ipversion = 4
26        ldap_base = dc=current,dc=bugs,dc=debian,dc=org
27        ldap_request = (objectclass=*)
28        ldap_scope = one
29        pings = 5
30        plugin = /path/to/ldap.so
31        pluginargs = -p plugin_specific_arg
32        priority = 6
33        timeout = 1
34        tos = 0xa0
35        waittime = 1
36
37        # [...]
38
39        *** Targets ***
40
41        probe = EchoPingLDAP # if this should be the default probe
42
43        # [...]
44
45        + mytarget
46        # probe = EchoPingLDAP # if the default probe is something else
47        host = my.host
48        /^influx_.+/ = influx_location = In the basement
49        extraopts = -some-letter-the-author-did-not-think-of
50        ipversion = 4
51        ldap_base = dc=current,dc=bugs,dc=debian,dc=org
52        ldap_request = (objectclass=*)
53        ldap_scope = one
54        pings = 5
55        plugin = /path/to/ldap.so
56        pluginargs = -p plugin_specific_arg
57        priority = 6
58        timeout = 1
59        tos = 0xa0
60        waittime = 1
61

VARIABLES

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

AUTHORS

187       Niko Tyni <ntyni@iki.fi>
188

NOTES

190       The fill, size and udp EchoPing variables are not valid.
191
192       Plugins, including echoping_ldap, are available starting with echoping
193       version 6.
194

NAME

OVERVIEW

SYNOPSIS

VARIABLES

AUTHORS

NOTES

SEE ALSO