doc::Smokeping::probes::skel(3)    SmokePing   doc::Smokeping::probes::skel(3)



NAME
       Smokeping::probes::skel - a skeleton for Smokeping Probes

SYNOPSIS
        *** Probes ***

        +skel

        forks = 5
        offset = 50%
        step = 300
        timeout = 15

        # The following variables can be overridden in each target section
        pings = 5

        # [...]

        *** Targets ***

        probe = skel # if this should be the default probe

        # [...]

        + mytarget
        # probe = skel # if the default probe is something else
        host = my.host
        pings = 5

DESCRIPTION
       This is a non-functional module that is intended to act as a basis for
       creation of new probes. See the smokeping_extend document for more
       information.

VARIABLES
       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%

       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

       timeout
           How long a single 'ping' takes at maximum

           Example value: 15

           Default value: 5

       Supported target-specific variables:

       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

AUTHORS
        Niko Tyni <ntyni@iki.fi>,

SEE ALSO
       smokeping_extend



2.4.2                             2008-07-24   doc::Smokeping::probes::skel(3)
