Smokeping_probes_skel(3)

๐Ÿ’… NAME ๐Ÿ’…

okay so this is the Smokeping_probes_skel(3) page, and the module is Smokeping::probes::skel โ€” literally a skeleton for Smokeping Probes. Itโ€™s giving blueprint bestie, not a finished probe. ๐Ÿฆ‹

โœจ SYNOPSIS โœจ

Hereโ€™s the config vibe, copied exactly because we do not paraphrase config in this house:

*** Probes ***

+skel

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

# The following variables can be overridden in each target section
/^influx_.+/ = influx_location = In the basement
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
/^influx_.+/ = influx_location = In the basement
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. So like, if youโ€™re building a new probe, this is your starter skeleton โ€” itโ€™s not out here measuring stuff on its own, no cap.

โš ๏ธ Bestie, the key word is skeleton: this is a base for making new probes, not a functional probe you run for real measurements.

๐ŸŒธ VARIABLES ๐ŸŒธ

๐Ÿ’– Supported probe-specific variables

okay so these are the probe-specific knobs, and yes, every single one is here:

  • forks โ€” run this many concurrent processes at maximum.
    • Example value: 5
    • Default value: 5
  • offset โ€” okay so if youโ€™ve got a bunch of probes running concurrently, you might not want them all slamming your network at the exact same second. Thatโ€™s where the probe-specific offset parameter comes in: it moves the point in time when each probe runs. You can give the offset as a % of the total interval, or as 'random', and if you donโ€™t set anything here, the offset from the 'General' section is used. Big caveat: this does NOT touch the rrds themselves โ€” it only changes when data acquisition kicks off. (Only applies when 'concurrentprobes' is set in the 'General' section.)
    • Example value: 50%
  • step โ€” this sets the duration of the base interval this probe should use, if it needs to be different from the one in the 'Database' section. Important: the step inside the RRD files is locked in when theyโ€™re first generated, so if you change the step parameter later, youโ€™ll have to delete the old RRD files or somehow convert them. (Only applies when 'concurrentprobes' is set in the 'General' section.)
    • Example value: 300
  • timeout โ€” the maximum time a single 'ping' can take.
    • Example value: 15
    • Default value: 5

๐ŸŽฏ Supported target-specific variables

Now the target-specific ones, bestie:

  • /^influx_.+/ โ€” this is a tag sent to influxdb; it has zero impact on the probe measurement. The tag name goes out without the "influx_" prefix โ€” that gets replaced with "tag_" instead. Tags are useful for filtering.
    • Example value: influx_location = In the basement
  • pings โ€” how many pings go to each target, if you want a different number than the global value in the Database section. Same RRD caveat: the number of pings in the RRD files is fixed when theyโ€™re originally generated, so changing this parameter later means deleting the old RRD files or somehow converting them.
    • Example value: 5

๐Ÿ‘‘ AUTHORS ๐Ÿ‘‘

Niko Tyni <ntyni@iki.fi>, โ€” yes, the trailing comma is in there, because we keep the details, periodt. ๐Ÿ’…

๐Ÿ” SEE ALSO ๐Ÿ”

smokeping_extend โ€” thatโ€™s the doc to read next, bestie. ๐Ÿซถ


okay thatโ€™s the whole page, bestie ๐Ÿซถ โ€” this is Smokeping_probes_skel(3) from SmokePing 2.9.0, dated 2025-06-30. โœจ

๐Ÿ“ฆ where this page comes from