Smokeping_probes_basevars(3)

🌸 NAME 🌸

okay so bestie, this is the Smokeping_probes_basevars(3) manual page, and the whole vibe is: Smokeping::probes::basevars β€” literally β€œAnother Base Class for implementing SmokePing Probes” πŸ’…

✨ OVERVIEW ✨

It’s giving β€œsame energy as Smokeping::probes::base,” but with host-specific variables for the probe. Periodt. πŸ¦‹

πŸŽ€ SYNOPSIS πŸŽ€

        *** Probes ***

        +basevars

        offset = 50%
        pings = 20
        step = 300

        # The following variables can be overridden in each target section
        /^influx_.+/ = influx_location = In the basement

        # [...]

        *** Targets ***

        probe = basevars # if this should be the default probe

        # [...]

        + mytarget
        # probe = basevars # if the default probe is something else
        host = my.host
        /^influx_.+/ = influx_location = In the basement

πŸ’… DESCRIPTION πŸ’…

So this class provides the method targets, which returns a list of hashes. The hashes contain these entries, bestie:

  • addr β€” the address of the target, obviously.
  • vars β€” a hash containing variables defined in the corresponding config section.
  • tree β€” the unique index that probe::base uses for targets.

There’s also the method vars that returns the above-mentioned hash corresponding to the 'tree' index parameter. iykyk ✨

🧚 VARIABLES 🧚

Supported probe-specific variables:

  • 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% πŸ•°οΈ
  • pings β€” how many pings should be sent to each target, if different from the global value specified in the Database section. Big caveat, bestie: 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: 20 πŸ’Œ
  • step β€” duration of the base interval that this probe should use, if different from the one specified in the 'Database' section. Another caveat: 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 ⏳

πŸ‘‘ AUTHORS πŸ‘‘

Niko Tyni <ntyni@iki.fi> β€” iconic behavior, honestly. 🫢

πŸ’€ BUGS πŸ’€

Uses Smokeping::probes::base internals too much to be a derived class, but β€œI didn’t want to touch the base class directly.” not me lowkey respecting the boundary 😭

πŸ¦‹ SEE ALSO πŸ¦‹

Smokeping::probes::base, Smokeping::probes::EchoPing β€” go read those too, bestie 🌈


mwah πŸ’‹ this page is from SmokePing version 2.9.0, dated 2025-06-30, and yes it’s the Smokeping_probes_basevars(3) manual β€” love u, bye πŸ«ΆπŸŽ€

πŸ“¦ where this page comes from