Smokeping_probes_EchoPingLDAP(3)

πŸ’– NAME πŸ’–

okay bestie, welcome to the Smokeping_probes_EchoPingLDAP(3) manual page. This one is Smokeping::probes::EchoPingLDAP - an echoping(1) probe for SmokePing. periodt. πŸ’…

πŸ¦‹ OVERVIEW πŸ¦‹

It measures LDAP roundtrip times for SmokePing with the echoping_ldap plugin. That's the vibe. ✨

✨ SYNOPSIS ✨

Here's the config energy, exactly as it wants to be typed, bestie:

        *** Probes ***

        +EchoPingLDAP

        binary = /usr/bin/echoping
        forks = 5
        offset = 50%
        step = 300

        # The following variables can be overridden in each target section
        /^influx_.+/ = influx_location = In the basement
        extraopts = -some-letter-the-author-did-not-think-of
        ipversion = 4
        ldap_base = dc=current,dc=bugs,dc=debian,dc=org
        ldap_request = (objectclass=*)
        ldap_scope = one
        pings = 5
        plugin = /path/to/ldap.so
        pluginargs = -p plugin_specific_arg
        priority = 6
        timeout = 1
        tos = 0xa0
        waittime = 1

        # [...]

        *** Targets ***

        probe = EchoPingLDAP # if this should be the default probe

        # [...]

        + mytarget
        # probe = EchoPingLDAP # if the default probe is something else
        host = my.host
        /^influx_.+/ = influx_location = In the basement
        extraopts = -some-letter-the-author-did-not-think-of
        ipversion = 4
        ldap_base = dc=current,dc=bugs,dc=debian,dc=org
        ldap_request = (objectclass=*)
        ldap_scope = one
        pings = 5
        plugin = /path/to/ldap.so
        pluginargs = -p plugin_specific_arg
        priority = 6
        timeout = 1
        tos = 0xa0
        waittime = 1

πŸ’… VARIABLES πŸ’…

These are the knobs and dials. Every single one is listed, no skipping. 🫢

🌸 Supported probe-specific variables 🌸

  • binary β€” The location of your echoping binary. Default value: /usr/bin/echoping.
  • 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 acquisition is initiated. (This variable is only applicable if the variable concurrentprobes is set in the 'General' section.) Example value: 50%.
  • step β€” Duration of the base interval that this probe should use, if different from the one specified in the 'Database' section. Note that the step in the RRD files is fixed when they are originally generated, 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 πŸŽ€

  • /^influx_.+/ β€” This is a tag that will be sent to influxdb and has no impact on the probe measurement. The tag name will be sent without the "influx_" prefix, which will be replaced with "tag_" instead. Tags can be used for filtering. Example value: influx_location = In the basement.
  • extraopts β€” Any extra options specified here will be passed unmodified to echoping(1). Example value: -some-letter-the-author-did-not-think-of.
  • ipversion β€” The IP protocol used. Possible values are "4" and "6". Passed to echoping(1) as the "-4" or "-6" options. Example value: 4.
  • ldap_base β€” The echoping_ldap '-b' option: base of the search. Example value: dc=current,dc=bugs,dc=debian,dc=org.
  • ldap_request β€” The echoping_ldap '-r' option: the request to the LDAP server, in LDAP filter language. Example value: (objectclass=*).
  • ldap_scope β€” The echoping_ldap '-s' option: scope of the search, "sub", "one" or "base". Example value: one.
  • pings β€” How many pings should be sent to each target, if different from the global value specified in the Database section. Note that the number 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.
  • plugin β€” The echoping plugin that will be used. See echoping(1) for details. This can either be the name of the plugin or a full path to the plugin shared object. Example value: /path/to/ldap.so. Default value: ldap.
  • pluginargs β€” Any extra arguments needed by the echoping plugin specified with the pluginname variable. These are generally provided by the subclass probe. Example value: -p plugin_specific_arg.
  • priority β€” The "-p" echoping(1) option. Example value: 6.
  • timeout β€” The "-t" echoping(1) option. Example value: 1. Default value: 5.
  • tos β€” The "-P" echoping(1) option. Example value: 0xa0.
  • waittime β€” The "-w" echoping(1) option. Example value: 1.

🫢 AUTHORS 🫢

Niko Tyni <ntyni@iki.fi> wrote this one. iconic main character energy. πŸ‘‘

⭐ NOTES ⭐

Heads up, bestie: the fill, size and udp EchoPing variables are not valid.

Plugins, including echoping_ldap, are available starting with echoping version 6. no cap. πŸ”₯

🌈 SEE ALSO 🌈

Go peek at Smokeping::probes::EchoPing, Smokeping::probes::EchoPingPlugin. πŸ¦‹


k bye bestie, this page is from version 2.9.0, dated 2025-06-30, and it's the Smokeping_probes_EchoPingLDAP(3) manual. mwah πŸ’‹πŸŽ€

πŸ“¦ where this page comes from