Smokeping_probes_EchoPingIcp(3)

📦
version 2.9.0 · 12 versions
, in alpine 3.23, alpine 3.24

💅 Smokeping_probes_EchoPingIcp — from the SmokePing manual, section 3 ✨

Okay so bestie, welcome to Smokeping_probes_EchoPingIcp(3)</p> — yep, that's the manual name, it's giving "long and fancy" but it's literally just the SmokePing probe docs for talking ICP. Buckle up 🎀

🌸 NAME 🌸

Smokeping::probes::EchoPingIcp — an echoping(1) probe for SmokePing. That's it, that's the whole vibe. 💖

🦋 OVERVIEW 🦋

It measures ICP roundtrip times for SmokePing. And what is ICP, you ask? Internet Cache Protocol — the thing web caches speak to each other. So like, if you ever wanted to know how fast your caches are chatting, this is the probe. Slay. 🔥

✨ SYNOPSIS ✨

Here's the whole setup, verbatim, no cap:

 *** Probes ***

 +EchoPingIcp

 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
 priority = 6
 timeout = 1
 tos = 0xa0
 url = http://www.example.org/ # mandatory
 waittime = 1

 # [...]

 *** Targets ***

 probe = EchoPingIcp # if this should be the default probe

 # [...]

 + mytarget
 # probe = EchoPingIcp # 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
 priority = 6
 timeout = 1
 tos = 0xa0
 url = http://www.example.org/ # mandatory
 waittime = 1

Like, notice url is marked mandatory, okay? Don't forget it, I'm begging 🫶

👑 VARIABLES 👑

Two flavors here: probe-specific and target-specific. Let's get into it.

💜 Supported probe-specific variables 💜

  • binary — where your echoping binary lives on the filesystem. Default value: /usr/bin/echoping.
  • forks — run this many concurrent processes at maximum. Example value: 5. Default value: 5.
  • offset — okay so if you're running a ton of probes at once, they might all slam your network at the exact same moment, which is a whole mess. This param shifts when each probe fires. You give it a percentage of the total interval, or the word random, and if you don't set anything here it falls back to whatever's in the General section. Big important caveat: this does NOT touch the rrds themselves — it's purely about when data acquisition kicks off. (Only applicable if concurrentprobes is set in the General section, fyi.) Example value: 50%.
  • step — the duration of the base interval this probe should use, in case it's different from the one in the Database section. ⚠️ Real talk: the step inside the RRD files is baked in when they're originally generated, so if you change step afterwards you gotta delete the old RRD files or somehow convert them. No take-backsies. (Only applicable if concurrentprobes is set in the General section.) Example value: 300.

🎀 Supported target-specific variables 🎀

  • /^influx_.+/ — a tag that gets sent to influxdb, and it has zero impact on the actual probe measurement, it's just tagging. The tag name goes out without the influx_ prefix, which gets replaced with tag_ instead. Tags are for filtering, iykyk. Example value: influx_location = In the basement.
  • extraopts — any extra options you stick here get passed unmodified straight through to echoping(1). Example value: -some-letter-the-author-did-not-think-of.
  • ipversion — which IP protocol to use. Possible values are "4" and "6". It's passed to echoping(1) as the -4 or -6 options. Example value: 4.
  • pings — how many pings to send to each target, if it's different from the global value in the Database section. ⚠️ Same warning as before: the number of pings in the RRD files is fixed when they're originally generated, so if you change this later you'll have to delete the old RRD files or somehow convert them. Example value: 5.
  • priority — this is the -p echoping(1) option. Example value: 6.
  • timeout — this is the -t echoping(1) option. Example value: 1. Default value: 5.
  • tos — this is the -P echoping(1) option. Example value: 0xa0.
  • url — the URL to be requested from the web cache. Example value: http://www.example.org/. 💀 This setting is mandatory.
  • waittime — this is the -w echoping(1) option. Example value: 1.

🌈 AUTHORS 🌈

Niko Tyni <ntyni@iki.fi> — shoutout, legend behavior 👑💖

🙈 NOTES 🙈

Heads up: the fill, size and udp EchoPing variables are not valid here. Not applicable. Don't try it, bestie 💀

⭐ SEE ALSO ⭐

  • Smokeping::probes::EchoPing
  • Smokeping::probes::EchoPingHttp

Go read those too, they're lowkey part of the same friend group 💅

Okay that's the whole page!! Version 2.9.0, dated 2025-06-30 — the SmokePing girlies really said "documented" and ate. Periodt. 🦋🌸💖

📦 where this page comes from