dwww Home | Manual pages | Find package

Smokeping_probes_EchoPingWhois(3)  SmokePing  Smokeping_probes_EchoPingWhois(3)

NAME
       Smokeping::probes::EchoPingWhois - an echoping(1) probe for SmokePing

OVERVIEW
       Measures whois roundtrip times for SmokePing with the echoping_whois
       plugin.

SYNOPSIS
        *** Probes ***

        +EchoPingWhois

        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
        pings = 5
        plugin = /path/to/whois.so
        pluginargs = -p plugin_specific_arg
        priority = 6
        timeout = 1
        tos = 0xa0
        waittime = 1
        whois_request = example.org # mandatory

        # [...]

        *** Targets ***

        probe = EchoPingWhois # if this should be the default probe

        # [...]

        + mytarget
        # probe = EchoPingWhois # 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
        pings = 5
        plugin = /path/to/whois.so
        pluginargs = -p plugin_specific_arg
        priority = 6
        timeout = 1
        tos = 0xa0
        waittime = 1
        whois_request = example.org # mandatory

VARIABLES
       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

       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/whois.so

           Default value: whois

       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

       whois_request
           The request to the whois server (typically a domain name).

           Example value: example.org

           This setting is mandatory.

AUTHORS
       Niko Tyni <ntyni@iki.fi>

NOTES
       The fill, size and udp EchoPing variables are not valid.

       Plugins, including echoping_whois, are available starting with  echoping
       version 6.

SEE ALSO
       Smokeping::probes::EchoPing, Smokeping::probes::EchoPingPlugin

2.8.2                              2024-02-04 Smokeping_probes_EchoPingWhois(3)

Generated by dwww version 1.16 on Tue Dec 16 05:34:02 CET 2025.