SMOKEPING_CONFIG(5)

πŸŽ€ SMOKEPING_CONFIG(5) β€” smokeping_config πŸŽ€

okay bestie, quick vibe check: this is the manual page for smokeping_config, and it's literally the reference for the SmokePing Config File. πŸ’–

πŸ’– NAME πŸ’–

smokeping_config β€” reference for the SmokePing Config File.

🌈 OVERVIEW 🌈

okay so SmokePing takes its configuration from a single central configuration file. its location must be hardcoded in the smokeping script and smokeping.cgi. no cap.

the contents of this manual is generated directly from the configuration file parser.

the parser for the configuration file is written using David Schweikert's Config::Grammar module. read all about it in Config::Grammar. ✨

the configuration file has a tree-like structure with section headings at various levels. it also contains variable assignments and tables. it's giving organized chaos in the best way.

⚠️ warning: this manual is rather long. see smokeping_examples for simple configuration examples. 🫢

πŸ’… REFERENCE πŸ’…

✨ GENERAL SYNTAX ✨

the text below describes the general syntax of the SmokePing configuration file. it was copied from the Config::Grammar documentation. (yes, we're being transparent about the lore.)

  • # denotes a comment up to the end-of-line, empty lines are allowed, and space at the beginning and end of lines is trimmed. periodt.
  • \ at the end of the line marks a continued line on the next line. a single space will be inserted between the concatenated lines.
  • @include filename is used to include another file.
  • @define a some value will replace all occurrences of a in the following text with some value.
  • fields in tables that contain white space can be enclosed in either ' or ". whitespace can also be escaped with \. quotes inside quotes are allowed but must be escaped with a backslash as well.

πŸ¦‹ SPECIFIC SYNTAX πŸ¦‹

the text below describes the specific syntax of the SmokePing configuration file.

🌸 * General * (mandatory section) 🌸

general configuration values valid for the whole SmokePing setup.

the following variables can be set in this section:

  • owner (mandatory setting) β€” name of the person responsible for this smokeping installation.
  • imgcache (mandatory setting) β€” a directory which is visible on your webserver where SmokePing can cache graphs.
  • imgurl (mandatory setting) β€” either an absolute URL to the imgcache directory or one relative to the directory where you keep the SmokePing cgi.
  • datadir (mandatory setting) β€” the directory where SmokePing can keep its rrd files.
  • dyndir β€” the base directory where SmokePing keeps the files related to the DYNAMIC function. this directory must be writeable by the WWW server. it is also used for temporary storage of slave polling results by the master in the master/slave mode. if this variable is not specified, the value of datadir will be used instead.
  • pagedir β€” directory to store static representations of pages.
  • piddir (mandatory setting) β€” the directory where SmokePing keeps its pid when daemonized.
  • sendmail β€” path to your sendmail binary. it will be used for sending mails in connection with the support of DYNAMIC addresses.
  • offset β€” if you run many instances of smokeping you may want to prevent them from hitting your network all at the same time. using the offset parameter you can change the point in time when the probes are run. offset is specified in % of total interval, or alternatively as 'random'. the original author recommends 'random'. note that this does NOT influence the rrds itself; it's just a matter of when data acquisition is initiated. the default offset is 'random'.
  • smokemail (mandatory setting) β€” path to the mail template for DYNAMIC hosts. this mail template must contain keywords of the form <##keyword##>. there is a sample template included with SmokePing.
  • cgiurl (mandatory setting) β€” complete URL path of the SmokePing.cgi.
  • mailhost β€” instead of using sendmail, you can specify the name of an smtp server and use perl's Net::SMTP module to send mail (for alerts and DYNAMIC client script). several comma separated mailhosts can be specified. SmokePing will try one after the other if one does not answer for 5 seconds.
  • mailuser β€” username on mailhost, SmokePing will use this user to send mail (Net::SMTP).
  • mailpass β€” password of username on mailhost, SmokePing will use this password to send mail (Net::SMTP).
  • snpphost β€” if you have a SNPP (Simple Network Pager Protocol) server at hand, you can have alerts sent there too. use the syntax snpp:someaddress to use a snpp address in any place where you can use a mail address otherwise.
  • contact (mandatory setting) β€” mail address of the person responsible for this smokeping installation.
  • display_name β€” what should the master host be called when working in master/slave mode. this is used in the overview graph for example.
  • syslogfacility β€” the syslog facility to use, eg. local0...local7. note: syslog logging is only used if you specify this.
  • syslogpriority β€” the syslog priority to use, eg. debug, notice or info. default is info.
  • concurrentprobes β€” if you use multiple probes or multiple instances of the same probe and you want them to run concurrently in separate processes, set this to 'yes'. this gives you the possibility to specify probe-specific step and offset parameters (see the 'Probes' section) for each probe and makes the probes unable to block each other in cases of service outages. the default is 'yes', but if you for some reason want the old behaviour you can set this to 'no'.
  • changeprocessnames β€” when using 'concurrentprobes' (see above), this controls whether the probe subprocesses should change their argv string to indicate their probe in the process name. if set to 'yes' (the default), the probe name will be appended to the process name as '[probe]', eg. '/usr/bin/smokeping [FPing]'. if you don't like this behaviour, set this variable to 'no'. if 'concurrentprobes' is not set to 'yes', this variable has no effect.

Default value: changeprocessnames = yes

  • tmail β€” path to your tSmoke HTML mail template file. see the tSmoke documentation for details.
  • changecgiprogramname β€” usually the Smokeping CGI tries to log any possible errors with an extended program name that includes the IP address of the remote client for easier debugging. if this variable is set to 'no', the program name will not be modified. the only reason you would want this is if you have a very old version of the CGI::Carp module. see the installation document for details.

Default value: changecgiprogramname = yes

  • linkstyle β€” how the CGI self-referring links are created. the possible values are:
    • absolute β€” full hostname and path derived from the 'cgiurl' variable.
<a href="http://hostname/path/smokeping.cgi?foo=bar">
  • relative β€” only the parameter part is specified.
<a href="?foo=bar">
  • original β€” the way the links were generated before Smokeping version 2.0.4: no hostname, only the path.
<a href="/path/smokeping.cgi?foo=bar">

the default is "relative", which hopefully works for everybody. Default value: linkstyle = relative

  • precreateperms β€” if this variable is set, the Smokeping daemon will create its directory hierarchy under 'dyndir' (the CGI-writable tree) at startup with the specified directory permission bits. the value is interpreted as an octal value, eg. 775 for rwxrwxr-x etc. if unset, the directories will be created dynamically with umask 022.

example:

precreateperms = 2755

πŸ’Ύ * Database * (mandatory section) πŸ’Ύ

describes the properties of the round robin database for storing the SmokePing data. note that it is not possible to edit existing RRDs by changing the entries in the cfg file.

the following variables can be set in this section:

  • step (mandatory setting) β€” duration of the base operation interval of SmokePing in seconds. SmokePing will venture out every step seconds to ping your target hosts. if 'concurrentprobes' is set to 'yes' (see above), this variable can be overridden by each probe. 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.
  • pings (mandatory setting) β€” how many pings should be sent to each target. suggested: 20 pings. minimum value: 3 pings. this can be overridden by each probe. some probes (those derived from basefork.pm, ie. most except the FPing variants) will even let this be overridden target-specifically. 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.

this section also contains a table describing the setup of the SmokePing database. below are reasonable defaults. only change them if you know rrdtool and its workings. each row in the table describes one RRA.

 # cons   xff steps rows
 AVERAGE  0.5   1   1008
 AVERAGE  0.5  12   4320
     MIN  0.5  12   4320
     MAX  0.5  12   4320
 AVERAGE  0.5 144    720
     MAX  0.5 144    720
     MIN  0.5 144    720
  • column 0 β€” consolidation method.
  • column 1 β€” what part of the consolidated intervals must be known to warrant a known entry.
  • column 2 β€” how many steps to consolidate into for each RRA entry.
  • column 3 β€” how many rows this RRA should have.

🎨 * Presentation * (mandatory section) 🎨

defines how the SmokePing data should be presented.

the following variables can be set in this section:

  • template (mandatory setting) β€” the webpage template must contain keywords of the form <##keyword##>. there is a sample template included with SmokePing; use it as the basis for your experiments. the default template contains a pointer to the SmokePing counter and homepage. the author would be glad if you didn't remove this, because it gives an indication as to how widely used the tool is.
  • charset β€” by default, SmokePing assumes the 'utf-8' character set. if you use something else, this is the place to speak up.
  • htmltitle β€” by default, SmokePing will render the title of the graph in the image; when set to 'yes' the title is inserted in the html page.
  • graphborders β€” by default, SmokePing will render gray border on a light gray background; if set to 'no' borders will be hidden and the background and canvas will be transparent.
  • literalsearch β€” by default, SmokePing processes filter menu queries as regular expressions; set it to yes and searches get treated as literal strings instead. ✨
  • colortext, colorbackground β€” by default, SmokePing renders the background light gray, and you can override it here with your own RGB value.
  • colorborder β€” by default, SmokePing renders the border gray, and you can override it here with your own RGB value.

The following sections are valid on level 1:

🌸 +overview (mandatory section)

The Overview section defines how the Overview graphs should look.

The following variables can be set in this section:

  • width (mandatory setting) β€” width of the Overview Graphs.
  • height (mandatory setting) β€” height of the Overview Graphs.
  • range β€” how much time should be depicted in the Overview graph. Time must be specified as a number followed by a letter which specifies the unit of time. Known units are: seconds, minutes, hours, ddays, weeks, years.
  • max_rtt β€” any roundtrip time larger than this value will be cropped in the overview graph. Units is seconds (for example, 0.800).
  • median_color β€” by default the median line is drawn in red. Override it here with a hex color in the format rrggbb. Note that if you work with slaves, the slaves medians will be drawn in the slave color in the overview graph.
  • strftime β€” use posix strftime to format the timestamp in the left hand lower corner of the overview graph.

πŸŽ€ +detail (mandatory section)

The following variables can be set in this section:

  • width (mandatory setting) β€” how many pixels wide should detail graphs be.
  • height (mandatory setting) β€” how many pixels high should detail graphs be.
  • loss_background β€” should the graphs be shown with a background showing loss data for emphasis (yes/no)? If this option is enabled, uptime data is no longer displayed in the graph background.
  • logarithmic β€” should the graphs be shown in a logarithmic scale (yes/no).
  • unison_tolerance β€” if a graph is more than this factor of the median max it drops out of the unison scaling algorithm. A factor of two would mean that any graph with a max either less than half or more than twice the median max will be dropped from unison scaling.
  • max_rtt β€” any roundtrip time larger than this value will be cropped in the detail graph. Units is seconds (for example, 0.800).
  • strftime β€” use posix strftime to format the timestamp in the left hand lower corner of the detail graph.
  • nodata_color β€” paint the graph background in a special color when there is no data for this period because smokeping has not been running (#rrggbb).

The detailed display can contain several graphs of different resolution. In this table you can specify the resolution of each graph.

Example:

 "Last 3 Hours"    3h
 "Last 30 Hours"   30h
 "Last 10 Days"    10d
 "Last 400 Days"   400d
  • column 0 β€” description of the particular resolution.
  • column 1 β€” how much time should be depicted. The format is the same as for the age parameter of the Overview section.

The following sections are valid on level 2:

πŸ’€ ++loss_colors

In the Detail view, the color of the median line depends on the amount of lost packets. SmokePing comes with a reasonable default setting, but you may choose to disagree. The table below lets you specify your own coloring.

Example:

 Loss Color   Legend
 1    00ff00    "<1"
 3    0000ff    "<3"
 1000 ff0000    ">=3"
  • column 0 β€” activate when the number of lost pings is larger or equal to this number.
  • column 1 β€” color for this range.
  • column 2 β€” description for this range.

πŸ’™ ++uptime_colors

When monitoring a host with DYNAMIC addressing, SmokePing will keep track of how long the machine is able to keep the same IP address. This time is plotted as a color in the graph background. SmokePing comes with a reasonable default setting, but you may choose to disagree. The table below lets you specify your own coloring.

Example:

 # Uptime      Color     Legend
 3600          00ff00   "<1h"
 86400         0000ff   "<1d"
 604800        ff0000   "<1w"
 1000000000000 ffff00   ">1w"

Uptime is in days!

  • column 0 β€” activate when uptime in days is larger or equal to this number.
  • column 1 β€” color for this uptime range.
  • column 2 β€” description for this range.

πŸ¦‹ +charts

The SmokePing Charts feature allow you to have Top X lists created according to various criteria.

Each type of Chart must live in its own subsection.

 + charts
 menu = Charts
 title = The most interesting destinations
 ++ median
 sorter = Median(entries=>10)
 title = Sorted by Median Roundtrip Time
 menu = Top Median RTT
 format = Median RTT %e s

The following variables can be set in this section:

  • menu (mandatory setting) β€” menu entry for the Charts Section.
  • title (mandatory setting) β€” page title for the Charts Section.

The following sections are valid on level 2:

🎨 ++/[-_0-9a-zA-Z]+/

The following variables can be set in this section:

  • menu (mandatory setting) β€” menu entry.
  • title (mandatory setting) β€” page title.
  • sorter (mandatory setting) β€” sorter for this charts section.
  • format β€” sprintf format string to format current value.

πŸ’œ +multihost

Settings for the multihost graphs. At the moment this is only used for the color setting. Check the documentation on the host property of the target section for more.

The following variables can be set in this section:

  • colors β€” space separated list of colors for multihost graphs.

Example: colors = ff0000 00ff00 0000ff

🌈 +hierarchies

Provide an alternative presentation hierarchy for your smokeping data. After setting up a hierarchy in this section, you can use it in each target's parent property. A drop-down menu in the smokeping website lets the user switch presentation hierarchy.

The following sections are valid on level 2:

🧚 ++/[-_0-9a-zA-Z]+/

Identifier of the hierarchies. Use this as prefix in the targets parent property.

The following variables can be set in this section:

  • title (mandatory setting) β€” title for this hierarchy.

πŸ§ͺ *** Probes *** (mandatory section)

The Probes Section configures Probe modules. Probe modules integrate an external ping command into SmokePing. Check the documentation of each module for more information about it.

The following sections are valid on level 1:

πŸ”₯ +/[-_0-9a-zA-Z]+/

Each module can take specific configuration information from this area. The jumble of letters above is a regular expression defining legal module names.

See the documentation of each module for details about its variables.

The grammar of this section is dynamically modified based on its name.

The following sections are valid on level 2:

⭐ ++/[-_0-9a-zA-Z]+/

You can define multiple instances of the same probe with subsections. These instances can have different values for their variables, so you can eg. have one instance of the FPing probe with packet size 1000 and step 300 and another instance with packet size 64 and step 30. The name of the subsection determines what the probe will be called, so you can write descriptive names for the probes.

If there are any subsections defined, the main section for this probe will just provide default parameter values for the probe instances, ie. it will not become a probe instance itself.

The example above would be written like this:

 *** Probes ***

 + FPing
 # this value is common for the two subprobes
 binary = /usr/bin/fping

 ++ FPingLarge
 packetsize = 1000
 step = 300

 ++ FPingSmall
 packetsize = 64
 step = 30

Dynamical grammar changes for example instances of this section:

🫢 AnotherCurl

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary β€” see above.

Default value: binary = /usr/bin/curl

  • forks β€” see above.

Default value: forks = 5

  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • agent β€” (This variable can be overridden target-specifically in the Targets section.)
  • extraargs β€” (This variable can be overridden target-specifically in the Targets section.)
  • extrare β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: extrare = / /

  • follow_redirects β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: follow_redirects = no

  • include_redirects β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: include_redirects = no

  • insecure_ssl β€” (This variable can be overridden target-specifically in the Targets section.)
  • interface β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • ssl2 β€” same energy as above ✨ and yeah, this one can be overridden target-specifically in the Targets section, so per-target vibes are fully allowed.
  • timeout β€” also overridable target-specifically in the Targets section.
    • Default value: timeout = 10
  • urlformat β€” overridable target-specifically in the Targets section too, bestie.
    • Real talk though: this variable dynamically modifies the grammar based on whatever value it's got πŸ‘€ so it's not just a lil string, it's giving main-character-with-authorship.
  • write_out β€” yep, overridable target-specifically in the Targets section.

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

okay so inside one of these subsections, the grammar shifts a lil bit πŸŒ€ and here's the new roster of valid variables:

  • binary β€” see above.
    • Inherits its value from the parent section if nothing is specified here 🫢
    • Default value: binary = /usr/bin/curl
  • forks β€” see above.
    • Inherits its value from the parent section if nothing is specified here.
    • Default value: forks = 5
  • offset β€” see above.
    • Inherits its value from the parent section if nothing is specified here.
  • step β€” see above.
    • Inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” regex variable name, iconic behavior β€” inherits its value from the parent section if nothing is specified here.
  • agent β€” inherits its value from the parent section if nothing is specified here.
  • extraargs β€” inherits its value from the parent section if nothing is specified here.
  • extrare β€” inherits its value from the parent section if nothing is specified here.
    • Default value: extrare = / /
  • follow_redirects β€” inherits its value from the parent section if nothing is specified here.
    • Default value: follow_redirects = no
  • include_redirects β€” inherits its value from the parent section if nothing is specified here.
    • Default value: include_redirects = no
  • insecure_ssl β€” inherits its value from the parent section if nothing is specified here.
  • interface β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • ssl2 β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here.
    • Default value: timeout = 10
  • urlformat β€” inherits its value from the parent section if nothing is specified here.
  • write_out β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "AnotherCurl".)


πŸ¦‹ AnotherDNS πŸ¦‹

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • forks β€” see above.
    • Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” can be overridden target-specifically in the Targets section πŸ’…
  • authoritative β€” can be overridden target-specifically in the Targets section.
  • expect_text β€” can be overridden target-specifically in the Targets section.
  • ipversion β€” can be overridden target-specifically in the Targets section.
    • Default value: ipversion = 4
  • lookup β€” can be overridden target-specifically in the Targets section.
  • mininterval β€” can be overridden target-specifically in the Targets section.
    • Default value: mininterval = 0.5
  • pings β€” can be overridden target-specifically in the Targets section.
  • port β€” can be overridden target-specifically in the Targets section.
    • Default value: port = 53
  • protocol β€” can be overridden target-specifically in the Targets section.
    • Default value: protocol = udp
  • recordtype β€” can be overridden target-specifically in the Targets section.
    • Default value: recordtype = A
  • require_answers β€” can be overridden target-specifically in the Targets section.
  • require_noerror β€” can be overridden target-specifically in the Targets section.
  • require_nxdomain β€” can be overridden target-specifically in the Targets section.
  • timeout β€” can be overridden target-specifically in the Targets section.
    • Default value: timeout = 5

🌈 Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌈

The following new variables are valid:

  • forks β€” see above.
    • Inherits its value from the parent section if nothing is specified here.
    • Default value: forks = 5
  • offset β€” see above.
    • Inherits its value from the parent section if nothing is specified here.
  • step β€” see above.
    • Inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • authoritative β€” inherits its value from the parent section if nothing is specified here.
  • expect_text β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
    • Default value: ipversion = 4
  • lookup β€” inherits its value from the parent section if nothing is specified here.
  • mininterval β€” inherits its value from the parent section if nothing is specified here.
    • Default value: mininterval = 0.5
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • port β€” inherits its value from the parent section if nothing is specified here.
    • Default value: port = 53
  • protocol β€” inherits its value from the parent section if nothing is specified here.
    • Default value: protocol = udp
  • recordtype β€” inherits its value from the parent section if nothing is specified here.
    • Default value: recordtype = A
  • require_answers β€” inherits its value from the parent section if nothing is specified here.
  • require_noerror β€” inherits its value from the parent section if nothing is specified here.
  • require_nxdomain β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here.
    • Default value: timeout = 5

(End of dynamical grammar changes for example instance "AnotherDNS".)


πŸŽ€ AnotherSSH πŸŽ€

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • forks β€” see above.
    • Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” can be overridden target-specifically in the Targets section.
  • greeting β€” can be overridden target-specifically in the Targets section.
    • Default value: greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage
    • not the polite lil greeting you expected, but it's the one we got 😭
  • interval β€” can be overridden target-specifically in the Targets section.
    • Default value: interval = established
  • mininterval β€” can be overridden target-specifically in the Targets section.
    • Default value: mininterval = 0.5
  • pings β€” can be overridden target-specifically in the Targets section.
  • port β€” can be overridden target-specifically in the Targets section.
    • Default value: port = 22
  • timeout β€” can be overridden target-specifically in the Targets section.
    • Default value: timeout = 5

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

Okay so, when you've got a subsection matching that regex, these are the shiny new variables that are valid:

  • forks β€” see above. It inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. It inherits its value from the parent section if nothing is specified here.
  • step β€” see above. It inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • greeting β€” this variable inherits its value from the parent section if nothing is specified here. Default value: greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage
  • interval β€” this variable inherits its value from the parent section if nothing is specified here. Default value: interval = established
  • mininterval β€” this variable inherits its value from the parent section if nothing is specified here. Default value: mininterval = 0.5
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • port β€” this variable inherits its value from the parent section if nothing is specified here. Default value: port = 22
  • timeout β€” this variable inherits its value from the parent section if nothing is specified here. Default value: timeout = 5
(End of dynamical grammar changes for example instance "AnotherSSH".)

πŸ¦‹ CiscoRTTMonDNS πŸ¦‹

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • ioshost β€” (This variable can be overridden target-specifically in the Targets section.) This variable dynamically modifies the grammar based on its value.
  • iosint β€” (This variable can be overridden target-specifically in the Targets section.)
  • name β€” (This variable can be overridden target-specifically in the Targets section.) This variable dynamically modifies the grammar based on its value.
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.) Default value: timeout = 15

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • forks β€” see above. This variable inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • ioshost β€” this variable inherits its value from the parent section if nothing is specified here.
  • iosint β€” this variable inherits its value from the parent section if nothing is specified here.
  • name β€” this variable inherits its value from the parent section if nothing is specified here.
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” this variable inherits its value from the parent section if nothing is specified here. Default value: timeout = 15
(End of dynamical grammar changes for example instance "CiscoRTTMonDNS".)

πŸŽ€ CiscoRTTMonEchoICMP πŸŽ€

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • ioshost β€” (This variable can be overridden target-specifically in the Targets section.) This variable dynamically modifies the grammar based on its value.
  • iosint β€” (This variable can be overridden target-specifically in the Targets section.)
  • packetsize β€” (This variable can be overridden target-specifically in the Targets section.) Default value: packetsize = 56
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.) Default value: timeout = 15
  • tos β€” (This variable can be overridden target-specifically in the Targets section.)
  • vrf β€” (This variable can be overridden target-specifically in the Targets section.)

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • forks β€” see above. This variable inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • ioshost β€” this variable inherits its value from the parent section if nothing is specified here.
  • iosint β€” this variable inherits its value from the parent section if nothing is specified here.
  • packetsize β€” this variable inherits its value from the parent section if nothing is specified here. Default value: packetsize = 56
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” this variable inherits its value from the parent section if nothing is specified here. Default value: timeout = 15
  • tos β€” this variable inherits its value from the parent section if nothing is specified here.
  • vrf β€” this variable inherits its value from the parent section if nothing is specified here.
(End of dynamical grammar changes for example instance "CiscoRTTMonEchoICMP".)

πŸ’… CiscoRTTMonTcpConnect πŸ’…

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • ioshost β€” (This variable can be overridden target-specifically in the Targets section.) This variable dynamically modifies the grammar based on its value.
  • iosint β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • port β€” (This variable can be overridden target-specifically in the Targets section.) Default value: port = 80
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.) Default value: timeout = 15
  • tos β€” (This variable can be overridden target-specifically in the Targets section.)

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • forks β€” see above. This variable inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • ioshost β€” this one just inherits its value from the parent section if nothing is specified here.
  • iosint β€” this one just inherits its value from the parent section if nothing is specified here.
  • pings β€” this one just inherits its value from the parent section if nothing is specified here.
  • port β€” this one just inherits its value from the parent section if nothing is specified here.

Default value: port = 80

  • timeout β€” this one just inherits its value from the parent section if nothing is specified here.

Default value: timeout = 15

  • tos β€” this one just inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "CiscoRTTMonTcpConnect".) ✨


πŸŒ€ Curl

(Peep the separate module documentation for the deets on each variable, bestie.)

The following new variables are valid:

  • binary β€” see above

Default value: binary = /usr/bin/curl

  • forks β€” see above

Default value: forks = 5

  • offset β€” see above
  • step β€” see above
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section.)
  • agent β€” (this variable can be overridden target-specifically in the Targets section.)
  • expect β€” (this variable can be overridden target-specifically in the Targets section.)
  • extraargs β€” (this variable can be overridden target-specifically in the Targets section.)
  • extrare β€” (this variable can be overridden target-specifically in the Targets section.)

Default value: extrare = / /

  • follow_redirects β€” (this variable can be overridden target-specifically in the Targets section.)

Default value: follow_redirects = no

  • include_redirects β€” (this variable can be overridden target-specifically in the Targets section.)

Default value: include_redirects = no

  • insecure_ssl β€” (this variable can be overridden target-specifically in the Targets section.)
  • interface β€” (this variable can be overridden target-specifically in the Targets section.)
  • pings β€” (this variable can be overridden target-specifically in the Targets section.)
  • require_zero_status β€” (this variable can be overridden target-specifically in the Targets section.)

Default value: require_zero_status = no

  • ssl2 β€” (this variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (this variable can be overridden target-specifically in the Targets section.)

Default value: timeout = 10

  • urlformat β€” (this variable can be overridden target-specifically in the Targets section.)

This variable dynamically modifies the grammar based on its value. πŸ’…

🌸 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/curl

  • forks β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • step β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • agent β€” this variable inherits its value from the parent section if nothing is specified here.
  • expect β€” this variable inherits its value from the parent section if nothing is specified here.
  • extraargs β€” this variable inherits its value from the parent section if nothing is specified here.
  • extrare β€” this variable inherits its value from the parent section if nothing is specified here.

Default value: extrare = / /

  • follow_redirects β€” this variable inherits its value from the parent section if nothing is specified here.

Default value: follow_redirects = no

  • include_redirects β€” this variable inherits its value from the parent section if nothing is specified here.

Default value: include_redirects = no

  • insecure_ssl β€” this variable inherits its value from the parent section if nothing is specified here.
  • interface β€” this variable inherits its value from the parent section if nothing is specified here.
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • require_zero_status β€” this variable inherits its value from the parent section if nothing is specified here.

Default value: require_zero_status = no

  • ssl2 β€” this variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” this variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 10

  • urlformat β€” this variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "Curl".) πŸ‘‘


πŸ¦‹ DNS

(Again β€” the separate module documentation has the full tea on every variable, go read it.)

The following new variables are valid:

  • binary (mandatory setting) β€” see above
  • forks β€” see above

Default value: forks = 5

  • offset β€” see above
  • step β€” see above
  • timeout β€” see above

Default value: timeout = 5

  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section.)
  • lookup β€” (this variable can be overridden target-specifically in the Targets section.)
  • pings β€” (this variable can be overridden target-specifically in the Targets section.)
  • server β€” (this variable can be overridden target-specifically in the Targets section.)

πŸ’œ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary (mandatory setting) β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • forks β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • step β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • timeout β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • lookup β€” this variable inherits its value from the parent section if nothing is specified here.
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • server β€” this variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "DNS".) πŸŽ€


🧚 DismanPing

(Yes, the separate module documentation still has the details for each variable, bestie, it's not going anywhere.)

The following new variables are valid:

  • offset β€” see above
  • pings β€” see above

Default value: pings = 15

  • step β€” see above
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section.)
  • ownerindex β€” (this variable can be overridden target-specifically in the Targets section.)
  • packetsize β€” (this variable can be overridden target-specifically in the Targets section.)

Default value: packetsize = 56

  • pinghost β€” (this variable can be overridden target-specifically in the Targets section.)

This variable dynamically modifies the grammar based on its value. 😭

  • pingsrc β€” (this variable can be overridden target-specifically in the Targets section.)

⭐ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • offset β€” see above πŸ‘† this one literally just inherits its value from the parent section if nothing is specified here. No drama, no extra config, it just vibes off the parent.
  • pings β€” see above πŸ‘† same inheritance situation. Inherits from the parent section if nothing is specified here. Default value: pings = 15
  • step β€” see above πŸ‘† inherits from the parent section if nothing is specified here.
  • /^influx_.+/ β€” this whole regex family inherits its value from the parent section if nothing is specified here.
  • ownerindex β€” inherits its value from the parent section if nothing is specified here.
  • packetsize β€” inherits its value from the parent section if nothing is specified here. Default value: packetsize = 56
  • pinghost β€” inherits its value from the parent section if nothing is specified here.
  • pingsrc β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "DismanPing".) 🫢


πŸ¦‹ EchoPing: (See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary β€” see above. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.) πŸ‘€
  • extraopts β€” (This variable can be overridden target-specifically in the Targets section.)
  • fill β€” (This variable can be overridden target-specifically in the Targets section.)
  • ipversion β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • priority β€” (This variable can be overridden target-specifically in the Targets section.)
  • size β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.) Default value: timeout = 5
  • tos β€” (This variable can be overridden target-specifically in the Targets section.)
  • udp β€” (This variable can be overridden target-specifically in the Targets section.)
  • waittime β€” (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • binary β€” see above. This variable inherits its value from the parent section if nothing is specified here. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • step β€” see above. Inherits from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • extraopts β€” inherits its value from the parent section if nothing is specified here.
  • fill β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing is specified here.
  • size β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here. Default value: timeout = 5
  • tos β€” this variable inherits its value from the parent section if nothing is specified here.
  • udp β€” this variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPing".) πŸ’–


πŸŽ€ EchoPingChargen: (See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary β€” see above. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • extraopts β€” (This variable can be overridden target-specifically in the Targets section.)
  • fill β€” (This variable can be overridden target-specifically in the Targets section.)
  • ipversion β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • priority β€” (This variable can be overridden target-specifically in the Targets section.)
  • size β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.) Default value: timeout = 5
  • tos β€” (This variable can be overridden target-specifically in the Targets section.)
  • waittime β€” (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌸

The following new variables are valid:

  • binary β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • step β€” see above. Inherits from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • extraopts β€” inherits its value from the parent section if nothing is specified here.
  • fill β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing is specified here.
  • size β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here. Default value: timeout = 5
  • tos β€” this variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingChargen".) 🧚


πŸ’… EchoPingDNS: (See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary β€” see above. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • dns_request β€” (This variable can be overridden target-specifically in the Targets section.) πŸ¦‹

…and this variable dynamically modifies the grammar based on its value. πŸͺ„ that's the whole mood, bestie β€” moving on!

  • dns_tcp β€” πŸ¦‹ can be overridden target-specifically in the Targets section, iykyk.
  • dns_type β€” 🌸 also overridable target-specifically in Targets.
    • Default value: dns_type = A
  • extraopts β€” πŸ’… yep, overridable per-target in Targets too.
  • ipversion β€” ✨ overridable per-target in Targets, no cap.
  • pings β€” πŸŽ€ overridable per-target in Targets, periodt.
  • plugin β€” 🧚 overridable per-target in Targets.
    • Default value: plugin = dns
  • pluginargs β€” πŸ“ overridable per-target in Targets.
  • priority β€” ⭐ overridable per-target in Targets.
  • timeout β€” πŸ’œ overridable per-target in Targets.
    • Default value: timeout = 5
  • tos β€” 🌈 overridable target-specifically in the Targets section.
  • waittime β€” πŸ”₯ overridable per-target in Targets.

Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸŽ€

And the following new variables are valid in there, bestie:

  • binary
    • see above πŸ‘€
    • This one inherits its value from the parent section if nothing is specified here.
    • Default value: binary = /usr/bin/echoping
  • forks
    • see above
    • Inherits from the parent section if nothing is specified here.
    • Default value: forks = 5
  • offset
    • see above
    • Inherits from the parent section if nothing is specified here.
  • step
    • see above
    • Inherits from the parent section if nothing is specified here.
  • /^influx_.+/
    • Inherits from the parent section if nothing is specified here.
  • dns_request
    • Inherits from the parent section if nothing is specified here.
  • dns_tcp
    • Inherits from the parent section if nothing is specified here.
  • dns_type
    • Inherits from the parent section if nothing is specified here.
    • Default value: dns_type = A
  • extraopts
    • Inherits from the parent section if nothing is specified here.
  • ipversion
    • Inherits from the parent section if nothing is specified here.
  • pings
    • Inherits from the parent section if nothing is specified here.
  • plugin
    • Inherits from the parent section if nothing is specified here.
    • Default value: plugin = dns
  • pluginargs
    • Inherits from the parent section if nothing is specified here.
  • priority
    • Inherits from the parent section if nothing is specified here.
  • timeout
    • Inherits from the parent section if nothing is specified here.
    • Default value: timeout = 5
  • tos β€” inherits from the parent section if nothing is specified here.
  • waittime
    • Inherits from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingDNS".) 🫢


EchoPingDiscard πŸ’€

(See the separate module documentation for details about each variable.) β€” like, go read the module docs, they've got the deets.

The following new variables are valid:

  • binary
    • see above
    • Default value: binary = /usr/bin/echoping
  • forks
    • see above
    • Default value: forks = 5
  • offset
    • see above
  • step
    • see above
  • /^influx_.+/ β€” 🌸 overridable target-specifically in the Targets section.
  • extraopts β€” πŸ’… overridable per-target in Targets.
  • fill β€” πŸŽ€ overridable per-target in Targets.
  • ipversion β€” ✨ overridable per-target in Targets.
  • pings β€” πŸ¦‹ overridable per-target in Targets.
  • priority β€” ⭐ overridable per-target in Targets.
  • size β€” πŸ“ overridable per-target in Targets.
  • timeout β€” πŸ’œ overridable per-target in Targets.
    • Default value: timeout = 5
  • tos β€” 🌈 overridable target-specifically in the Targets section.
  • udp β€” πŸ”₯ overridable target-specifically in the Targets section.
  • waittime β€” πŸ‘‘ overridable per-target in Targets.

Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • binary
    • see above
    • Inherits its value from the parent section if nothing is specified here.
    • Default value: binary = /usr/bin/echoping
  • forks
    • see above
    • Inherits from the parent section if nothing is specified here.
    • Default value: forks = 5
  • offset
    • see above
    • Inherits from the parent section if nothing is specified here.
  • step
    • see above
    • Inherits from the parent section if nothing is specified here.
  • /^influx_.+/
    • Inherits from the parent section if nothing is specified here.
  • extraopts
    • Inherits from the parent section if nothing is specified here.
  • fill
    • Inherits from the parent section if nothing is specified here.
  • ipversion
    • Inherits from the parent section if nothing is specified here.
  • pings
    • Inherits from the parent section if nothing is specified here.
  • priority
    • Inherits from the parent section if nothing is specified here.
  • size
    • Inherits from the parent section if nothing is specified here.
  • timeout
    • Inherits from the parent section if nothing is specified here.
    • Default value: timeout = 5
  • tos β€” inherits its value from the parent section if nothing is specified here.
  • udp β€” inherits its value from the parent section if nothing is specified here.
  • waittime
    • Inherits from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingDiscard".) πŸ’–


EchoPingHttp 🌈

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary
    • see above
    • Default value: binary = /usr/bin/echoping
  • forks
    • see above
    • Default value: forks = 5
  • offset
    • see above
  • step
    • see above
  • /^influx_.+/ β€” πŸŽ€ overridable target-specifically in the Targets section.
  • accept_redirects β€” πŸ¦‹ overridable per-target in Targets.
  • extraopts β€” πŸ’… overridable per-target in Targets.
  • ignore_cache β€” ✨ overridable per-target in Targets.
  • ipversion β€” 🌸 overridable per-target in Targets.
  • pings β€” πŸ“ overridable per-target in Targets.
  • port β€” ⭐ overridable per-target in Targets.
  • priority β€” πŸ’œ overridable per-target in Targets.
  • revalidate_data β€” 🧚 overridable per-target in Targets.
  • timeout β€” πŸ”₯ overridable per-target in Targets.
    • Default value: timeout = 10 β€” yes bestie, ten, not five, don't come for me 😭
  • tos β€” (can be overridden per-target in the Targets section, iykyk)
  • url β€” (also target-overridable in Targets) Default value: url = /
  • waittime β€” (yep, target-overridable too)

πŸ¦‹ Syntax changes for subsection /[-_0-9a-zA-Z]+/

So when you drop into a subsection, these new variables become valid:

  • binary β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits its value from the parent section if nothing is specified here.
  • step β€” see above. Inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • accept_redirects β€” inherits its value from the parent section if nothing is specified here.
  • extraopts β€” inherits its value from the parent section if nothing is specified here.
  • ignore_cache β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • port β€” inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing is specified here.
  • revalidate_data β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here. Default value: timeout = 10
  • tos β€” inherits its value from the parent section if nothing is specified here.
  • url β€” inherits its value from the parent section if nothing is specified here. Default value: url = /
  • waittime β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingHttp".) ✨


πŸ’œ EchoPingHttps

(See the separate module documentation for details about each variable β€” she's got her own whole page, go read it 🫢)

The following new variables are valid:

  • binary β€” see above. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (can be overridden target-specifically in the Targets section)
  • accept_redirects β€” (target-specifically overridable in Targets)
  • extraopts β€” (target-specifically overridable in Targets)
  • ignore_cache β€” (target-specifically overridable in Targets)
  • ipversion β€” (target-specifically overridable in Targets)
  • pings β€” (target-specifically overridable in Targets)
  • port β€” (target-specifically overridable in Targets)
  • priority β€” (target-specifically overridable in Targets)
  • prot β€” (target-specifically overridable in Targets) Default value: prot = 443
  • revalidate_data β€” (target-specifically overridable in Targets)
  • timeout β€” (target-specifically overridable in Targets) Default value: timeout = 10
  • tos β€” (target-specifically overridable in Targets)
  • url β€” (target-specifically overridable in Targets) Default value: url = /
  • waittime β€” (target-specifically overridable in Targets)

🌈 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits its value from the parent section if nothing is specified here.
  • step β€” see above. Inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • accept_redirects β€” inherits its value from the parent section if nothing is specified here.
  • extraopts β€” inherits its value from the parent section if nothing is specified here.
  • ignore_cache β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • port β€” inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing is specified here.
  • prot β€” inherits its value from the parent section if nothing is specified here. Default value: prot = 443
  • revalidate_data β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here. Default value: timeout = 10
  • tos β€” inherits its value from the parent section if nothing is specified here.
  • url β€” inherits its value from the parent section if nothing is specified here. Default value: url = /
  • waittime β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingHttps".) πŸŽ€


πŸ“ EchoPingIcp

(See the separate module documentation for details about each variable β€” yes, this one has its own page too, she's thorough πŸ’…)

The following new variables are valid:

  • binary β€” see above. Default value: binary = /usr/bin/echoping
  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (can be overridden target-specifically in the Targets section)
  • extraopts β€” (target-specifically overridable in Targets)
  • ipversion β€” (target-specifically overridable in Targets)
  • pings β€” (target-specifically overridable in Targets)
  • priority β€” (target-specifically overridable in Targets)
  • timeout β€” (target-specifically overridable in Targets) Default value: timeout = 5
  • tos β€” (target-specifically overridable in Targets)
  • url β€” (target-specifically overridable in Targets)
Lowkey iconic behaviour: this variable dynamically modifies the grammar based on its value. πŸ‘€
  • waittime β€” (target-specifically overridable in Targets)

🧚 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: binary = /usr/bin/echoping
  • forks β€” see above ✨ this one inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above πŸ’« inherits its value from the parent section if nothing is specified here.
  • step β€” see above 🌸 inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • extraopts β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

  • tos β€” inherits its value from the parent section if nothing is specified here.
  • url β€” inherits its value from the parent section if nothing is specified here.
  • waittime β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingIcp".) πŸŽ€


πŸ¦‹ EchoPingLDAP

(See the separate module documentation for details about each variable, bestie β€” that's where the real lore lives πŸ‘€)

The following new variables are valid:

  • binary β€” see above

Default value: binary = /usr/bin/echoping

  • forks β€” see above

Default value: forks = 5

  • offset β€” see above
  • step β€” see above
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • extraopts β€” (This variable can be overridden target-specifically in the Targets section.)
  • ipversion β€” (This variable can be overridden target-specifically in the Targets section.)
  • ldap_base β€” (This variable can be overridden target-specifically in the Targets section.)
  • ldap_request β€” (This variable can be overridden target-specifically in the Targets section.)
  • ldap_scope β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • plugin β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: plugin = ldap

  • pluginargs β€” (This variable can be overridden target-specifically in the Targets section.)
  • priority β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: timeout = 5

  • tos β€” (This variable can be overridden target-specifically in the Targets section.)
  • waittime β€” (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸ’…

The following new variables are valid:

  • binary β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

  • forks β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • step β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • /^influx_.+/ β€” This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” This variable inherits its value from the parent section if nothing is specified here.
  • ldap_base β€” This variable inherits its value from the parent section if nothing is specified here.
  • ldap_request β€” This variable inherits its value from the parent section if nothing is specified here.
  • ldap_scope β€” This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” This variable inherits its value from the parent section if nothing is specified here.
  • plugin β€” This variable inherits its value from the parent section if nothing is specified here.

Default value: plugin = ldap

  • pluginargs β€” This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

  • tos β€” This variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingLDAP".) 🌈


πŸ’œ EchoPingPlugin

(See the separate module documentation for details about each variable β€” yes, again, go read it, it's giving required reading πŸ“š)

The following new variables are valid:

  • binary β€” see above

Default value: binary = /usr/bin/echoping

  • forks β€” see above

Default value: forks = 5

  • offset β€” see above
  • step β€” see above
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • extraopts β€” (This variable can be overridden target-specifically in the Targets section.)
  • ipversion β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • plugin β€” (This variable can be overridden target-specifically in the Targets section.)

This variable dynamically modifies the grammar based on its value. 🀯

  • pluginargs β€” (This variable can be overridden target-specifically in the Targets section.)
  • priority β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: timeout = 5

  • tos β€” (This variable can be overridden target-specifically in the Targets section.)
  • waittime β€” (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • binary β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

  • forks β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • step β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • /^influx_.+/ β€” This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” This variable inherits its value from the parent section if nothing is specified here.
  • plugin β€” This variable inherits its value from the parent section if nothing is specified here.
  • pluginargs β€” This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing's set here πŸ’…
  • timeout β€” inherits from the parent section if you don't say anything here

Default value: timeout = 5

  • tos β€” inherits from the parent section if nothing's specified here
  • waittime β€” inherits from the parent section if nothing's specified here

(End of dynamical grammar changes for example instance "EchoPingPlugin". πŸŽ€)


🌸 EchoPingSmtp 🌸

(Peep the separate module documentation for the deets on each variable, bestie.)

The following new variables are valid:

  • binary β€” see above

Default value: binary = /usr/bin/echoping

  • forks β€” see above

Default value: forks = 5

  • offset β€” see above
  • step β€” see above
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section)
  • extraopts β€” (this variable can be overridden target-specifically in the Targets section)
  • ipversion β€” (this variable can be overridden target-specifically in the Targets section)
  • pings β€” (this variable can be overridden target-specifically in the Targets section)
  • priority β€” (this variable can be overridden target-specifically in the Targets section)
  • timeout β€” (this variable can be overridden target-specifically in the Targets section)

Default value: timeout = 5

  • tos β€” (this variable can be overridden target-specifically in the Targets section)
  • waittime β€” (this variable can be overridden target-specifically in the Targets section)

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • binary β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

  • forks β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • step β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • extraopts β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

  • tos β€” inherits its value from the parent section if nothing is specified here.
  • waittime β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingSmtp". πŸ’–)


πŸ¦‹ EchoPingWhois πŸ¦‹

(Again β€” the separate module documentation has all the per-variable lore. Go read it, iykyk.)

The following new variables are valid:

  • binary β€” see above

Default value: binary = /usr/bin/echoping

  • forks β€” see above

Default value: forks = 5

  • offset β€” see above
  • step β€” see above
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section)
  • extraopts β€” (this variable can be overridden target-specifically in the Targets section)
  • ipversion β€” (this variable can be overridden target-specifically in the Targets section)
  • pings β€” (this variable can be overridden target-specifically in the Targets section)
  • plugin β€” (this variable can be overridden target-specifically in the Targets section)

Default value: plugin = whois

  • pluginargs β€” (this variable can be overridden target-specifically in the Targets section)
  • priority β€” (this variable can be overridden target-specifically in the Targets section)
  • timeout β€” (this variable can be overridden target-specifically in the Targets section)

Default value: timeout = 5

  • tos β€” (this variable can be overridden target-specifically in the Targets section)
  • waittime β€” (this variable can be overridden target-specifically in the Targets section)
  • whois_request β€” (this variable can be overridden target-specifically in the Targets section)
Heads up bestie: this variable dynamically modifies the grammar based on its value πŸ‘€ β€” like, the config language literally reshapes itself depending on what you put there. Iconic behaviour fr.

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • binary β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

  • forks β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • step β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • extraopts β€” inherits its value from the parent section if nothing is specified here.
  • ipversion β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • plugin β€” inherits its value from the parent section if nothing is specified here.

Default value: plugin = whois

  • pluginargs β€” inherits its value from the parent section if nothing is specified here.
  • priority β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

  • tos β€” inherits its value from the parent section if nothing is specified here.
  • waittime β€” inherits its value from the parent section if nothing is specified here.
  • whois_request β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingWhois". 🫢)


πŸ”₯ FPing πŸ”₯

(Yes, the separate module documentation still has the full breakdown per variable. Not me repeating that. πŸ’€)

The following new variables are valid:

  • binary (mandatory setting) β€” see above
  • blazemode β€” see above
  • hostinterval β€” see above
  • interface β€” see above
  • mininterval β€” see above

Default value: mininterval = 0.01

  • offset β€” see above
  • packetsize β€” see above
  • pings β€” see above
  • protocol β€” see above
  • sourceaddress β€” see above
  • step β€” see above
  • timeout β€” see above
  • tos β€” see above
  • usestdout β€” see above
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section)

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • binary (mandatory setting) β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • blazemode β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • hostinterval β€” see above

This variable inherits its value from the parent section if nothing is specified here.

  • interface β€” see above

This variable inherits its value from the parent section if nothing is specified here.

Okay so this variable inherits its value from the parent section if nothing is specified here. πŸ’…

  • mininterval β€” see above. Inherits from the parent section if nothing is specified here. Default value: mininterval = 0.01.
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • packetsize β€” see above. Inherits from the parent section if nothing is specified here.
  • pings β€” see above. Inherits from the parent section if nothing is specified here.
  • protocol β€” see above. Inherits from the parent section if nothing is specified here.
  • sourceaddress β€” see above. Inherits from the parent section if nothing is specified here.
  • step β€” see above. Inherits from the parent section if nothing is specified here.
  • timeout β€” see above. Inherits from the parent section if nothing is specified here.
  • tos β€” see above. Inherits from the parent section if nothing is specified here.
  • usestdout β€” see above. Inherits from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits from the parent section if nothing is specified here.
(End of dynamical grammar changes for example instance "FPing".) ✨

FPing6: πŸ’–

πŸ’– See the separate module documentation for details about each variable.

The following new variables are valid, bestie:

  • binary (mandatory setting) β€” see above.
  • blazemode β€” see above.
  • hostinterval β€” see above.
  • interface β€” see above.
  • mininterval β€” see above. Default value: mininterval = 0.01.
  • offset β€” see above.
  • packetsize β€” see above.
  • pings β€” see above.
  • protocol β€” see above. Default value: protocol = 6.
  • sourceaddress β€” see above.
  • step β€” see above.
  • timeout β€” see above.
  • tos β€” see above.
  • usestdout β€” see above.
  • /^influx_.+/ β€” this variable can be overridden target-specifically in the Targets section.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary (mandatory setting) β€” see above. Inherits from the parent section if nothing is specified here.
  • blazemode β€” see above. Inherits from the parent section if nothing is specified here.
  • hostinterval β€” see above. Inherits from the parent section if nothing is specified here.
  • interface β€” see above. Inherits from the parent section if nothing is specified here.
  • mininterval β€” see above. Inherits from the parent section if nothing is specified here. Default value: mininterval = 0.01.
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • packetsize β€” see above. Inherits from the parent section if nothing is specified here.
  • pings β€” see above. Inherits from the parent section if nothing is specified here.
  • protocol β€” see above. Inherits from the parent section if nothing is specified here. Default value: protocol = 6.
  • sourceaddress β€” see above. Inherits from the parent section if nothing is specified here.
  • step β€” see above. Inherits from the parent section if nothing is specified here.
  • timeout β€” see above. Inherits from the parent section if nothing is specified here.
  • tos β€” see above. Inherits from the parent section if nothing is specified here.
  • usestdout β€” see above. Inherits from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits from the parent section if nothing is specified here.
(End of dynamical grammar changes for example instance "FPing6".) 🌸

FPingContinuous: πŸ¦‹

πŸ¦‹ See the separate module documentation for details about each variable.

The following new variables are valid:

  • binary (mandatory setting) β€” see above.
  • hostinterval β€” see above.
  • offset β€” see above.
  • packetsize β€” see above.
  • pings β€” see above.
  • sourceaddress β€” see above.
  • step β€” see above.
  • timeout β€” see above.
  • tos β€” see above.
  • usestdout β€” see above.
  • /^influx_.+/ β€” this variable can be overridden target-specifically in the Targets section.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary (mandatory setting) β€” see above. Inherits from the parent section if nothing is specified here.
  • hostinterval β€” see above. Inherits from the parent section if nothing is specified here.
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • packetsize β€” see above. Inherits from the parent section if nothing is specified here.
  • pings β€” see above. Inherits from the parent section if nothing is specified here.
  • sourceaddress β€” see above. Inherits from the parent section if nothing is specified here.
  • step β€” see above. Inherits from the parent section if nothing is specified here.
  • timeout β€” see above. Inherits from the parent section if nothing is specified here.
  • tos β€” see above. Inherits from the parent section if nothing is specified here.
  • usestdout β€” see above. Inherits from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits from the parent section if nothing is specified here.
(End of dynamical grammar changes for example instance "FPingContinuous".) πŸŽ€

FTPtransfer: πŸ“

πŸ“ See the separate module documentation for details about each variable.

The following new variables are valid:

  • destfile β€” see above.
  • forks β€” see above. Default value: forks = 5.
  • min_interval β€” see above. Default value: min_interval = 1.
  • mode (mandatory setting) β€” see above.
  • offset β€” see above.
  • passwordfile β€” see above.
  • srcfile (mandatory setting) β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” this variable can be overridden target-specifically in the Targets section.
  • localaddr β€” this variable can be overridden target-specifically in the Targets section.
  • passive β€” this variable can be overridden target-specifically in the Targets section.
  • password β€” this variable can be overridden target-specifically in the Targets section.
  • pings β€” this variable can be overridden target-specifically in the Targets section.
  • port β€” this variable can be overridden target-specifically in the Targets section.
  • timeout (mandatory setting) β€” this variable can be overridden target-specifically in the Targets section.
  • username β€” this variable can be overridden target-specifically in the Targets section.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • destfile β€” see above ✨. Inherits its value from the parent section if nothing's specified here.
  • forks β€” see above ✨. Inherits from the parent section if nothing's set here. Default value: forks = 5.
  • min_interval β€” see above ✨. Inherits from the parent section if nothing's set here. Default value: min_interval = 1.
  • mode (mandatory setting) β€” see above ✨. Inherits from the parent section if nothing's set here.
  • offset β€” see above ✨. Inherits from the parent section if nothing's set here.
  • passwordfile β€” see above ✨. Inherits from the parent section if nothing's set here.
  • srcfile (mandatory setting) β€” see above ✨. Inherits from the parent section if nothing's set here.
  • step β€” see above ✨. Inherits from the parent section if nothing's set here.
  • /^influx_.+/ β€” inherits from the parent section if nothing's set here πŸ’….
  • localaddr β€” inherits from the parent section if nothing's set here πŸ’….
  • passive β€” inherits from the parent section if nothing's set here πŸ’….
  • password β€” inherits from the parent section if nothing's set here πŸ’….
  • pings β€” inherits from the parent section if nothing's set here πŸ’….
  • port β€” inherits from the parent section if nothing's set here πŸ’….
  • timeout (mandatory setting) β€” inherits from the parent section if nothing's set here πŸ’….
  • username β€” inherits from the parent section if nothing's set here πŸ’….
(End of dynamical grammar changes for example instance "FTPtransfer".) πŸŽ€

🌸 IOSPing 🌸

(Peep the separate module documentation for the deets on each variable, bestie 🫢)

The following new variables are valid:

  • binary (mandatory setting) β€” see above ✨.
  • forks β€” see above ✨. Default value: forks = 5.
  • offset β€” see above ✨.
  • packetsize β€” see above ✨. Default value: packetsize = 56.
  • step β€” see above ✨.
  • timeout β€” see above ✨. Default value: timeout = 5.
  • /^influx_.+/ β€” (this one can be overridden target-specifically in the Targets section πŸ‘€).
  • ioshost β€” (can be overridden target-specifically in the Targets section πŸ‘€). Heads up: this variable dynamically modifies the grammar based on its value β€” iconic, honestly πŸ’….
  • iosint β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • iosuser β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • pings β€” (can be overridden target-specifically in the Targets section πŸ‘€).

Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸ¦‹

The following new variables are valid:

  • binary (mandatory setting) β€” see above ✨. Inherits from the parent section if nothing's specified here.
  • forks β€” see above ✨. Inherits from the parent section if nothing's specified here. Default value: forks = 5.
  • offset β€” see above ✨. Inherits from the parent section if nothing's specified here.
  • packetsize β€” see above ✨. Inherits from the parent section if nothing's specified here. Default value: packetsize = 56.
  • step β€” see above ✨. Inherits from the parent section if nothing's specified here.
  • timeout β€” see above ✨. Inherits from the parent section if nothing's specified here. Default value: timeout = 5.
  • /^influx_.+/ β€” inherits from the parent section if nothing's specified here πŸ’….
  • ioshost β€” inherits from the parent section if nothing's specified here πŸ’….
  • iosint β€” inherits from the parent section if nothing's specified here πŸ’….
  • iosuser β€” inherits from the parent section if nothing's specified here πŸ’….
  • pings β€” inherits from the parent section if nothing's specified here πŸ’….
(End of dynamical grammar changes for example instance "IOSPing".) πŸŽ€

πŸ¦‹ IRTT πŸ¦‹

(Again β€” separate module documentation has the full rundown on each variable, go read it πŸ“–)

The following new variables are valid:

  • binary (mandatory setting) β€” see above ✨. Default value: binary = /usr/bin/irtt.
  • forks β€” see above ✨. Default value: forks = 5.
  • offset β€” see above ✨.
  • step β€” see above ✨.
  • timeout β€” see above ✨. Default value: timeout = 5.
  • tmpdir β€” see above ✨. Default value: tmpdir = /tmp/smokeping-irtt.
  • /^influx_.+/ β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • dscp β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • extraargs β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • fill β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • hmac β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • interval β€” (can be overridden target-specifically in the Targets section πŸ‘€). Default value: interval = 1.
  • ipversion β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • length β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • localaddr β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • metric β€” (can be overridden target-specifically in the Targets section πŸ‘€). Default value: metric = rtt.
  • pings β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • readfrom β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • readfrompollinterval β€” (can be overridden target-specifically in the Targets section πŸ‘€). Default value: readfrompollinterval = 5.
  • serverfill β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • sleep β€” (can be overridden target-specifically in the Targets section πŸ‘€).
  • writeto β€” (can be overridden target-specifically in the Targets section πŸ‘€).

Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌈

The following new variables are valid:

  • binary (mandatory setting) β€” see above ✨. Inherits from the parent section if nothing's specified here. Default value: binary = /usr/bin/irtt.
  • forks β€” see above ✨. Inherits from the parent section if nothing's specified here. Default value: forks = 5.
  • offset β€” see above ✨. Inherits from the parent section if nothing's specified here.
  • step β€” see above ✨. Inherits from the parent section if nothing's specified here.
  • timeout β€” see above ✨. Inherits from the parent section if nothing's specified here. Default value: timeout = 5.
  • tmpdir β€” see above ✨. Inherits from the parent section if nothing's specified here. Default value: tmpdir = /tmp/smokeping-irtt.
  • /^influx_.+/ β€” inherits from the parent section if nothing's specified here πŸ’….
  • dscp β€” inherits from the parent section if nothing's specified here πŸ’….
  • extraargs β€” inherits its value from the parent section if nothing is specified here. ✨
  • fill β€” inherits its value from the parent section if nothing is specified here. πŸ’–
  • hmac β€” inherits its value from the parent section if nothing is specified here. πŸŽ€
  • interval β€” inherits its value from the parent section if nothing is specified here. Default value: interval = 1. ⭐
  • ipversion β€” inherits its value from the parent section if nothing is specified here. πŸ¦‹
  • length β€” inherits its value from the parent section if nothing is specified here. 🌸
  • localaddr β€” inherits its value from the parent section if nothing is specified here. πŸ’…
  • metric β€” inherits its value from the parent section if nothing is specified here. Default value: metric = rtt. πŸ”₯
  • pings β€” inherits its value from the parent section if nothing is specified here. 🫢
  • readfrom β€” inherits its value from the parent section if nothing is specified here. 😭
  • readfrompollinterval β€” inherits its value from the parent section if nothing is specified here. Default value: readfrompollinterval = 5. πŸ‘‘
  • serverfill β€” inherits its value from the parent section if nothing is specified here. 🌈
  • sleep β€” inherits its value from the parent section if nothing is specified here. πŸ’€
  • writeto β€” inherits its value from the parent section if nothing is specified here. πŸ™ˆ
(End of dynamical grammar changes for example instance "IRTT".) πŸŽ€

πŸ¦‹ LDAP

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5.
  • offset β€” see above.
  • passwordfile β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.) πŸ‘€
  • attrs β€” (This variable can be overridden target-specifically in the Targets section.)
  • base β€” (This variable can be overridden target-specifically in the Targets section.)
  • binddn β€” (This variable can be overridden target-specifically in the Targets section.)
  • filter β€” (This variable can be overridden target-specifically in the Targets section.) This variable dynamically modifies the grammar based on its value. πŸͺ„
  • mininterval β€” (This variable can be overridden target-specifically in the Targets section.) Default value: mininterval = 1.
  • password β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • port β€” (This variable can be overridden target-specifically in the Targets section.)
  • scheme β€” (This variable can be overridden target-specifically in the Targets section.) Default value: scheme = ldap.
  • scope β€” (This variable can be overridden target-specifically in the Targets section.) Default value: scope = sub.
  • start_tls β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.) Default value: timeout = 5.
  • verify β€” (This variable can be overridden target-specifically in the Targets section.) Default value: verify = require.
  • version β€” (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌈

The following new variables are valid:

  • forks β€” see above. This variable inherits its value from the parent section if nothing is specified here. Default value: forks = 5.
  • offset β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • passwordfile β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” This variable inherits its value from the parent section if nothing is specified here.
  • attrs β€” This variable inherits its value from the parent section if nothing is specified here.
  • base β€” This variable inherits its value from the parent section if nothing is specified here.
  • binddn β€” This variable inherits its value from the parent section if nothing is specified here.
  • filter β€” This variable inherits its value from the parent section if nothing is specified here.
  • mininterval β€” This variable inherits its value from the parent section if nothing is specified here. Default value: mininterval = 1.
  • password β€” This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” This variable inherits its value from the parent section if nothing is specified here.
  • port β€” This variable inherits its value from the parent section if nothing is specified here.
  • scheme β€” This variable inherits its value from the parent section if nothing is specified here. Default value: scheme = ldap.
  • scope β€” This variable inherits its value from the parent section if nothing is specified here. Default value: scope = sub.
  • start_tls β€” This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” This variable inherits its value from the parent section if nothing is specified here. Default value: timeout = 5.
  • verify β€” This variable inherits its value from the parent section if nothing is specified here. Default value: verify = require.
  • version β€” This variable inherits its value from the parent section if nothing is specified here.
(End of dynamical grammar changes for example instance "LDAP".) ✨

πŸ“ NFSping

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary (mandatory setting) β€” see above. πŸ”₯
  • blazemode β€” see above.
  • hostinterval β€” see above.
  • mininterval β€” see above. Default value: mininterval = 0.01.
  • offset β€” see above.
  • pings β€” see above.
  • step β€” see above.
  • tcp β€” see above.
  • timeout β€” see above.
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.) πŸ‘‘

Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌸

The following new variables are valid:

  • binary (mandatory setting) β€” see above. This variable inherits its value from the parent section if nothing is specified here. 🫢
  • blazemode β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • hostinterval β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • mininterval β€” see above. This variable inherits its value from the parent section if nothing is specified here. Default value: mininterval = 0.01.
  • offset β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • tcp β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits from the parent section if nothing is specified here πŸ’–

_(End of dynamical grammar changes for example instance "NFSping".)_


OpenSSHEOSPing

Bestie, the separate module docs have the full tea on each variable β€” here’s what’s valid in this block. 🫢

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • packetsize β€” see above. Default value: packetsize = 100
  • step β€” see above.
  • timeout β€” see above. Default value: timeout = 5
  • /^influx_.+/ β€” can be overridden target-specifically in the Targets section.
  • eospass β€” can be overridden target-specifically in the Targets section. This variable dynamically modifies the grammar based on its value. πŸͺ„
  • eosuser β€” can be overridden target-specifically in the Targets section. This variable dynamically modifies the grammar based on its value. πŸͺ„
  • pings β€” can be overridden target-specifically in the Targets section.
  • psource β€” can be overridden target-specifically in the Targets section.
  • source β€” can be overridden target-specifically in the Targets section. This variable dynamically modifies the grammar based on its value. πŸͺ„
  • unpriv β€” can be overridden target-specifically in the Targets section.

Syntax changes for subsection /[-_0-9a-zA-Z]+/ β€” valid new variables:

  • forks β€” see above. Inherits from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • packetsize β€” see above. Inherits from the parent section if nothing is specified here. Default value: packetsize = 100
  • step β€” see above. Inherits from the parent section if nothing is specified here.
  • timeout β€” see above. Inherits from the parent section if nothing is specified here. Default value: timeout = 5
  • /^influx_.+/ β€” inherits from the parent section if nothing is specified here.
  • eospass β€” inherits from the parent section if nothing is specified here.
  • eosuser β€” inherits from the parent section if nothing is specified here.
  • pings β€” inherits from the parent section if nothing is specified here.
  • psource β€” inherits from the parent section if nothing is specified here.
  • source β€” inherits from the parent section if nothing is specified here.
  • unpriv β€” inherits from the parent section if nothing is specified here.

_(End of dynamical grammar changes for example instance "OpenSSHEOSPing".)_


OpenSSHJunOSPing

Separate module docs again for the full details, bestie β€” here’s the valid variable list. πŸ¦‹

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • packetsize β€” see above. Default value: packetsize = 100
  • step β€” see above.
  • timeout β€” see above. Default value: timeout = 5
  • tos β€” see above.
  • /^influx_.+/ β€” can be overridden target-specifically in the Targets section.
  • junospass β€” can be overridden target-specifically in the Targets section. This variable dynamically modifies the grammar based on its value. πŸͺ„
  • junosuser β€” can be overridden target-specifically in the Targets section. This variable dynamically modifies the grammar based on its value. πŸͺ„
  • pings β€” can be overridden target-specifically in the Targets section.
  • psource β€” can be overridden target-specifically in the Targets section.
  • source β€” can be overridden target-specifically in the Targets section. This variable dynamically modifies the grammar based on its value. πŸͺ„

Syntax changes for subsection /[-_0-9a-zA-Z]+/ β€” valid new variables:

  • forks β€” see above. Inherits from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • packetsize β€” see above. Inherits from the parent section if nothing is specified here. Default value: packetsize = 100
  • step β€” see above. Inherits from the parent section if nothing is specified here.
  • timeout β€” see above. Inherits from the parent section if nothing is specified here. Default value: timeout = 5
  • tos β€” see above. Inherits from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits from the parent section if nothing is specified here.
  • junospass β€” inherits from the parent section if nothing is specified here.
  • junosuser β€” inherits from the parent section if nothing is specified here.
  • pings β€” inherits from the parent section if nothing is specified here.
  • psource β€” inherits from the parent section if nothing is specified here.
  • source β€” inherits from the parent section if nothing is specified here.

_(End of dynamical grammar changes for example instance "OpenSSHJunOSPing".)_


Qstat

Same deal: the separate module docs have all the details on each variable. 🌸

  • binary (mandatory setting) β€” see above.
  • forks β€” see above. Default value: forks = 5
  • game β€” see above. Default value: game = q3s
  • mininterval β€” see above. Default value: mininterval = 0.5
  • offset β€” see above.
  • port β€” see above.
  • sourceaddress β€” see above.
  • sourceport β€” see above.
  • step β€” see above.
  • timeout β€” see above. Default value: timeout = 5
  • /^influx_.+/ β€” can be overridden target-specifically in the Targets section.
  • pings β€” can be overridden target-specifically in the Targets section.

Syntax changes for subsection /[-_0-9a-zA-Z]+/ β€” valid new variables:

  • binary (mandatory setting) β€” see above. Inherits from the parent section if nothing is specified here.
  • forks β€” see above. Inherits from the parent section if nothing is specified here. Default value: forks = 5
  • game β€” see above. Inherits from the parent section if nothing is specified here. Default value: game = q3s
  • mininterval β€” see above. Inherits from the parent section if nothing is specified here. Default value: mininterval = 0.5
  • offset β€” see above. Inherits from the parent section if nothing is specified here.
  • port β€” see above. Inherits from the parent section if nothing is specified here.
  • sourceaddress β€” see above. Inherits from the parent section if nothing is specified here.
  • sourceport β€” see above. Inherits from the parent section if nothing is specified here.
  • step β€” see above.
  • timeout β€” see above πŸ’«

no setting here? it just inherits its value from the parent section, easy peasy.

Default value: timeout = 5

  • /^influx_.+/ β€” this one inherits its value from the parent section too if you leave it blank here 🫢
  • pings β€” see above, and yeah β€” inherits from the parent section when nothing's specified here ✨

(End of dynamical grammar changes for example instance "Qstat".)


πŸ¦‹ Radius πŸ¦‹

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • forks β€” see above πŸ“

Default value: forks = 5

  • offset β€” see above
  • passwordfile β€” see above
  • secretfile β€” see above
  • step β€” see above
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)
  • allowreject β€” (This variable can be overridden target-specifically in the Targets section.)
  • mininterval β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: mininterval = 1

  • nas_ip_address β€” (This variable can be overridden target-specifically in the Targets section.)
  • password β€” (This variable can be overridden target-specifically in the Targets section.)
  • pings β€” (This variable can be overridden target-specifically in the Targets section.)
  • port β€” (This variable can be overridden target-specifically in the Targets section.)
  • secret β€” (This variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.)

Default value: timeout = 5

  • username β€” (This variable can be overridden target-specifically in the Targets section.)

🚨 heads up bestie: this variable dynamically modifies the grammar based on its value β€” it's literally out here rewriting the rules πŸ‘‘

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • forks β€” see above πŸ’–

inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

  • offset β€” see above

inherits from the parent section if nothing's set here.

  • passwordfile β€” see above

inherits from the parent section if nothing's set here.

  • secretfile β€” see above

inherits from the parent section if nothing's set here.

  • step β€” see above

inherits from the parent section if nothing's set here.

  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here 🌈
  • allowreject β€” inherits its value from the parent section if nothing is specified here 🌈
  • mininterval β€” inherits its value from the parent section if nothing is specified here 🌈

Default value: mininterval = 1

  • nas_ip_address β€” inherits its value from the parent section if nothing is specified here 🌈
  • password β€” inherits its value from the parent section if nothing is specified here 🌈
  • pings β€” inherits its value from the parent section if nothing is specified here 🌈
  • port β€” inherits its value from the parent section if nothing is specified here 🌈
  • secret β€” inherits its value from the parent section if nothing is specified here 🌈
  • timeout β€” inherits its value from the parent section if nothing is specified here 🌈

Default value: timeout = 5

  • username β€” inherits its value from the parent section if nothing is specified here 🌈

(End of dynamical grammar changes for example instance "Radius".)


πŸŽ€ RemoteFPing πŸŽ€

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary (mandatory setting) β€” see above πŸ”₯ like, you gotta set this one, no skipping
  • blazemode β€” see above
  • hostinterval β€” see above
  • interface β€” see above
  • mininterval β€” see above

Default value: mininterval = 0.01

  • offset β€” see above
  • packetsize β€” see above
  • pings β€” see above
  • protocol β€” see above
  • rbinary (mandatory setting) β€” see above ⭐ mandatory, bestie, don't forget
  • rhost (mandatory setting) β€” see above ⭐ mandatory too
  • rport β€” see above
  • ruser β€” see above
  • sourceaddress β€” see above
  • step β€” see above
  • timeout β€” see above
  • tos β€” see above
  • usestdout β€” see above
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.)

πŸ’œ Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸ’œ

The following new variables are valid:

  • binary (mandatory setting) β€” see above

inherits its value from the parent section if nothing is specified here.

  • blazemode β€” see above

inherits its value from the parent section if nothing is specified here.

  • hostinterval β€” see above

inherits its value from the parent section if nothing is specified here.

  • interface β€” see above

inherits its value from the parent section if nothing is specified here.

  • mininterval β€” see above

inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.01

  • offset β€” see above

inherits its value from the parent section if nothing is specified here.

  • packetsize β€” see above

inherits its value from the parent section if nothing is specified here.

  • pings β€” see above

inherits its value from the parent section if nothing is specified here.

  • protocol β€” see above

inherits its value from the parent section if nothing is specified here.

  • rbinary (mandatory setting) β€” see above

inherits its value from the parent section if nothing is specified here.

  • rhost (mandatory setting) β€” see above

inherits its value from the parent section if nothing is specified here.

  • rport β€” see above

inherits its value from the parent section if nothing is specified here.

  • ruser β€” see above

inherits its value from the parent section if nothing is specified here.

  • sourceaddress β€” see above

inherits its value from the parent section if nothing is specified here.

  • step β€” see above

inherits its value from the parent section if nothing is specified here.

  • timeout β€” see above

inherits its value from the parent section if nothing is specified here.

  • tos β€” see above

inherits its value from the parent section if nothing is specified here.

  • usestdout β€” see above

inherits its value from the parent section if nothing is specified here.

  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here 🌸

(End of dynamical grammar changes for example instance "RemoteFPing".)


🧚 SSH 🧚

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary (mandatory setting) β€” see above πŸ’€ mandatory, so like… set it
  • forks β€” see above

Default value: forks = 5

  • init_host β€” see above

Default value: init_host = 127.0.0.1

  • offset β€” see above
  • step β€” see above
  • timeout β€” see above

Default value: timeout = 5

  • /^influx_.+/ β€” target-specific override alert: this variable can be overridden target-specifically in the Targets section. πŸ’…
  • keytype β€” same target-specific override deal: it can be overridden target-specifically in the Targets section.
    • Default value: keytype = rsa
  • pings β€” yep, this one can also be overridden target-specifically in the Targets section.
  • port β€” target-specific override? Absolutely, in the Targets section.
    • Default value: port = 22
  • ssh_af β€” this one can be overridden target-specifically in the Targets section too. πŸ¦‹

🌸 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary (mandatory setting) β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • forks β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: forks = 5
  • init_host β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: init_host = 127.0.0.1
  • offset β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: timeout = 5
  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • keytype β€” this variable inherits its value from the parent section if nothing is specified here.
    • Default value: keytype = rsa
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • port β€” this variable inherits its value from the parent section if nothing is specified here.
    • Default value: port = 22
  • ssh_af β€” this variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "SSH".)

πŸ’Œ SendEmail

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • bodysize β€” see above.
  • forks β€” see above.
    • Default value: forks = 5
  • from (mandatory setting) β€” see above.
  • offset β€” see above.
  • step β€” see above.
  • subject β€” see above.
    • Default value: subject = Test
  • timeout β€” see above.
    • Default value: timeout = 5
  • to (mandatory setting) β€” see above.
  • /^influx_.+/ β€” this variable can be overridden target-specifically in the Targets section.
  • pings β€” this variable can be overridden target-specifically in the Targets section.
  • port β€” this variable can be overridden target-specifically in the Targets section.
    • Default value: port = 25

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • bodysize β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • forks β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: forks = 5
  • from (mandatory setting) β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • offset β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • subject β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: subject = Test
  • timeout β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: timeout = 5
  • to (mandatory setting) β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • port β€” this variable inherits its value from the parent section if nothing is specified here.
    • Default value: port = 25

(End of dynamical grammar changes for example instance "SendEmail".)

πŸŽ€ SipSak

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary β€” see above.
    • Default value: binary = /usr/bin/sipsak
  • forks β€” see above.
    • Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • timeout β€” see above.
    • Default value: timeout = 5
  • /^influx_.+/ β€” this variable can be overridden target-specifically in the Targets section.
  • keep_second β€” this variable can be overridden target-specifically in the Targets section.
  • params β€” this variable can be overridden target-specifically in the Targets section.
  • pings β€” this variable can be overridden target-specifically in the Targets section.
  • port β€” this variable can be overridden target-specifically in the Targets section.
  • sipsak_timeout β€” this variable can be overridden target-specifically in the Targets section.
    • Default value: sipsak_timeout = 2
  • user β€” this variable can be overridden target-specifically in the Targets section.

πŸ¦‹ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • binary β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: binary = /usr/bin/sipsak
  • forks β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: forks = 5
  • offset β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • step β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above.
    • This variable inherits its value from the parent section if nothing is specified here.
    • Default value: timeout = 5
  • /^influx_.+/ β€” this variable inherits its value from the parent section if nothing is specified here.
  • keep_second β€” this variable inherits its value from the parent section if nothing is specified here.
  • params β€” this variable inherits its value from the parent section if nothing is specified here.
  • pings β€” this variable inherits its value from the parent section if nothing is specified here.
  • port β€” this variable inherits its value from the parent section if nothing is specified here.
  • sipsak_timeout β€” this variable inherits its value from the parent section if nothing is specified here.
    • Default value: sipsak_timeout = 2
  • user β€” this variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "SipSak".)

🧚 TCPPing

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • binary (mandatory setting) β€” see above.
  • forks β€” see above.
    • Default value: forks = 5
  • offset β€” see above.
  • step β€” see above.
  • timeout β€” see above.
    • Default value: timeout = 5
  • /^influx_.+/ β€” this variable can be overridden target-specifically in the Targets section.
  • pings β€” this variable can be overridden target-specifically in the Targets section.
  • port β€” same deal as above, and yeah β€” this one can be overridden target-specifically in the Targets section. πŸ’…

(End of dynamical grammar changes for example instance "TCPPing".) 🎬✨


🌸 TacacsPlus

(See the separate module documentation for details about each variable.) πŸ“– Go read it bestie, this page is just the vibes-summary.

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • passwordfile β€” see above.
  • secretfile β€” see above.
  • step β€” see above.
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section.)
  • authtype β€” (this variable can be overridden target-specifically in the Targets section.) Default value: authtype = ASCII
  • mininterval β€” (this variable can be overridden target-specifically in the Targets section.) Default value: mininterval = 1
  • password β€” (this variable can be overridden target-specifically in the Targets section.)
  • pings β€” (this variable can be overridden target-specifically in the Targets section.)
  • port β€” (this variable can be overridden target-specifically in the Targets section.) Default value: port = 49
  • secret β€” (this variable can be overridden target-specifically in the Targets section.)
  • timeout β€” (this variable can be overridden target-specifically in the Targets section.) Default value: timeout = 5
  • username β€” (this variable can be overridden target-specifically in the Targets section.) πŸ‘€ Heads up: this variable dynamically modifies the grammar based on its value. The config literally reshapes itself depending on what you type here. Iconic behavior honestly.

Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸ¦‹

The following new variables are valid:

  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits its value from the parent section if nothing is specified here.
  • passwordfile β€” see above. Inherits its value from the parent section if nothing is specified here.
  • secretfile β€” see above. Inherits its value from the parent section if nothing is specified here.
  • step β€” see above. Inherits its value from the parent section if nothing is specified here.
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • authtype β€” inherits its value from the parent section if nothing is specified here. Default value: authtype = ASCII
  • mininterval β€” inherits its value from the parent section if nothing is specified here. Default value: mininterval = 1
  • password β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • port β€” inherits its value from the parent section if nothing is specified here. Default value: port = 49
  • secret β€” inherits its value from the parent section if nothing is specified here.
  • timeout β€” inherits its value from the parent section if nothing is specified here. Default value: timeout = 5
  • username β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "TacacsPlus".) πŸ’«


πŸŽ€ TelnetIOSPing

(See the separate module documentation for details about each variable.) πŸ“– same deal, go check the module docs.

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • packetsize β€” see above. Default value: packetsize = 56
  • step β€” see above.
  • timeout β€” see above. Default value: timeout = 5
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section.)
  • iospass β€” (this variable can be overridden target-specifically in the Targets section.) Yep β€” this variable dynamically modifies the grammar based on its value. πŸͺ„
  • iosuser β€” (this variable can be overridden target-specifically in the Targets section.) Also dynamically modifies the grammar based on its value. 🀯
  • pings β€” (this variable can be overridden target-specifically in the Targets section.)
  • psource β€” (this variable can be overridden target-specifically in the Targets section.)
  • source β€” (this variable can be overridden target-specifically in the Targets section.) And this one too β€” dynamically modifies the grammar based on its value. The config is giving main character energy fr.
  • vrf β€” (this variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌈

The following new variables are valid:

  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits its value from the parent section if nothing is specified here.
  • packetsize β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: packetsize = 56
  • step β€” see above. Inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: timeout = 5
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here.
  • iospass β€” inherits its value from the parent section if nothing is specified here.
  • iosuser β€” inherits its value from the parent section if nothing is specified here.
  • pings β€” inherits its value from the parent section if nothing is specified here.
  • psource β€” inherits its value from the parent section if nothing is specified here.
  • source β€” inherits its value from the parent section if nothing is specified here.
  • vrf β€” inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "TelnetIOSPing".) ⭐


πŸ¦‹ TelnetJunOSPing

(See the separate module documentation for details about each variable.) πŸ“– yes bestie, another one β€” go peek at the module docs.

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5
  • offset β€” see above.
  • packetsize β€” see above. Default value: packetsize = 100 πŸ‘€ not 56 this time, watch out
  • step β€” see above.
  • timeout β€” see above. Default value: timeout = 5
  • /^influx_.+/ β€” (this variable can be overridden target-specifically in the Targets section.)
  • junospass β€” same deal, overridable target-specifically in the Targets section. Also this variable dynamically modifies the grammar based on whatever value you give it 🀯
  • junosuser β€” overridable target-specifically in the Targets section, and yes bestie, it also dynamically modifies the grammar based on its value ✨
  • pings β€” overridable target-specifically in the Targets section. That's it, that's the whole note πŸ’…
  • psource β€” overridable target-specifically in the Targets section 🫢
  • source β€” overridable target-specifically in the Targets section, and surprise πŸŽ€ it dynamically modifies the grammar based on its value too

✨ Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

okay so when you go a level deeper, these are the new variables that are valid πŸ‘‘

  • forks β€” see above. This variable inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits its value from the parent section if nothing is specified here πŸ¦‹
  • packetsize β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: packetsize = 100
  • step β€” see above. Inherits its value from the parent section if nothing is specified here ⭐
  • timeout β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: timeout = 5
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here πŸ“
  • junospass β€” inherits its value from the parent section if nothing is specified here πŸ’œ
  • junosuser β€” inherits its value from the parent section if nothing is specified here πŸ’œ
  • pings β€” inherits its value from the parent section if nothing is specified here 🌸
  • psource β€” inherits its value from the parent section if nothing is specified here 🌸
  • source β€” inherits its value from the parent section if nothing is specified here 🌈

(End of dynamical grammar changes for example instance "TelnetJunOSPing".) 🎬


πŸ›°οΈ TraceroutePing

(See the separate module documentation for details about each variable.) β€” like, go read the module docs if you want the deep lore, bestie πŸ“š

The following new variables are valid:

  • binary (mandatory setting) β€” see above. non-negotiable, you have to set this one πŸ’€
  • binaryv6 β€” see above πŸ¦‹
  • forks β€” see above. Default value: forks = 5
  • offset β€” see above ⭐
  • step β€” see above ✨
  • timeout β€” see above. Default value: timeout = 5
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.) πŸ“Š
  • desthost β€” (overridable target-specifically in the Targets section.) This variable dynamically modifies the grammar based on its value πŸ‘€
  • host β€” (overridable target-specifically in the Targets section.) Also dynamically modifies the grammar based on its value πŸŽ€
  • maxttl β€” (overridable target-specifically in the Targets section.) πŸ”₯
  • minttl β€” (overridable target-specifically in the Targets section.) πŸ”₯
  • pings β€” (overridable target-specifically in the Targets section.) 🌸
  • wait β€” (overridable target-specifically in the Targets section.) ⏳

🌟 Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌟

The following new variables are valid:

  • binary (mandatory setting) β€” see above. Inherits its value from the parent section if nothing is specified here. (still mandatory tho 😭)
  • binaryv6 β€” see above. Inherits its value from the parent section if nothing is specified here πŸ¦‹
  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • offset β€” see above. Inherits its value from the parent section if nothing is specified here ⭐
  • step β€” see above. Inherits its value from the parent section if nothing is specified here ✨
  • timeout β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: timeout = 5
  • /^influx_.+/. β€” wait no, it's /^influx_.+/ πŸ’€ β€” inherits its value from the parent section if nothing is specified here πŸ“Š
  • desthost β€” inherits its value from the parent section if nothing is specified here πŸ‘‘
  • host β€” inherits its value from the parent section if nothing is specified here πŸ‘‘
  • maxttl β€” inherits its value from the parent section if nothing is specified here πŸ”₯
  • minttl β€” inherits its value from the parent section if nothing is specified here πŸ”₯
  • pings β€” inherits its value from the parent section if nothing is specified here 🌸
  • wait β€” inherits its value from the parent section if nothing is specified here ⏳

(End of dynamical grammar changes for example instance "TraceroutePing".) 🎬


πŸ•΅οΈ WebProxyFilter

(See the separate module documentation for details about each variable.) β€” same vibe, the module docs have the full tea πŸ“š

The following new variables are valid:

  • forks β€” see above. Default value: forks = 5
  • maxsize β€” see above. Default value: maxsize = 2000
  • min_interval β€” see above. Default value: min_interval = 1
  • offset β€” see above ⭐
  • step β€” see above ✨
  • useragent β€” see above. Default value: useragent = SmokePing/2.x (WebProxyFilter Probe)
  • /^influx_.+/ β€” (This variable can be overridden target-specifically in the Targets section.) πŸ“Š
  • deny_re (mandatory setting) β€” (This variable can be overridden target-specifically in the Targets section.) you literally cannot skip this one πŸ’€
  • more_hosts β€” (This variable can be overridden target-specifically in the Targets section.) 🫢
  • pings β€” (This variable can be overridden target-specifically in the Targets section.) 🌸
  • timeout β€” (This variable can be overridden target-specifically in the Targets section.) Default value: timeout = 2

πŸŽ€ Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸŽ€

The following new variables are valid:

  • forks β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: forks = 5
  • maxsize β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: maxsize = 2000
  • min_interval β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: min_interval = 1
  • offset β€” see above. Inherits its value from the parent section if nothing is specified here ⭐
  • step β€” see above. Inherits its value from the parent section if nothing is specified here ✨
  • useragent β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: useragent = SmokePing/2.x (WebProxyFilter Probe)
  • /^influx_.+/ β€” inherits its value from the parent section if nothing is specified here πŸ“Š
  • deny_re (mandatory setting) β€” inherits its value from the parent section if nothing is specified here πŸ’€
  • more_hosts β€” inherits its value from the parent section if nothing is specified here 🫢
  • pings β€” inherits its value from the parent section if nothing is specified here 🌸
  • timeout β€” see above. Inherits its value from the parent section if nothing is specified here. Default value: timeout = 2

(End of dynamical grammar changes for example instance "WebProxyFilter".) 🎬


(End of dynamical grammar changes for example instances of section /[-_0-9a-zA-Z]+/.) 🌈✨ and that's the whole nested-grammar situation, bestie β€” iconic, slightly unhinged, fully intentional πŸ‘‘

🎯 Targets 🎯 (mandatory section)

Okay bestie, this is the section that does the actual work. The Target Section is where SmokePing finds out what it's even supposed to be monitoring β€” it's a hierarchical list of hosts that mark the endpoints of the network connections the system should monitor. Each section can contain one host as well as other sections (nesting, we love her πŸ’…). And by adding slaves you can measure the connection to an endpoint from multiple locations. Iconic, truly.

The following variables can be set in this section:

  • probe (mandatory setting) β€” the name of the probe module to use for this host. The value of this variable gets propagated. This variable dynamically modifies the grammar based on its value. πŸŒ€
  • menu (mandatory setting) β€” the menu entry for this section. If you don't set it, it gets set to the hostname.
  • title (mandatory setting) β€” the title of the page when it's displayed. This gets set to the hostname if you leave it empty.
  • remark β€” an optional remark on the current section. It gets displayed on the webpage. πŸŽ€
  • alerts β€” a comma separated list of alerts to check for this target. The alerts have to be set up in the Alerts section (no freelancing, babe). Alerts are inherited by child nodes. Use an empty alerts definition to remove inherited alerts from the current target and its children. ✨
  • slaves β€” list of slave servers. It gets inherited by all targets.
  • menuextra β€” HTML String to be added to the end of each menu entry. The {HOST} entry will be replaced by the host property of the relevant section. The {CLASS} entry will be replaced by the same class as the other tags in the menu line.
  • parents β€” (that's it, that's the entry πŸ’€)

The following sections are valid on level 1:

🌸 /[-_0-9a-zA-Z]+/ 🌸

Each target section can contain information about a host to monitor as well as further target sections. Most variables have already been described above. That expression right there defines the legal names for target sections β€” so keep your names within that character set, mkay?

This section is recursive: it can contain subsection(s) with the same syntax. It's giving turtles all the way down 🐒

The following variables can be set in this section:

  • probe β€” this variable inherits its value from the parent section if nothing is specified here. This variable dynamically modifies the grammar based on its value.
  • menu β€” (see above, boo)
  • title β€” (see above)
  • alerts β€” comma separated list of alert names. This variable inherits its value from the parent section if nothing is specified here.
  • note β€” some information about this entry which does NOT get displayed on the web. Secret little diary entry, love that for you πŸ™ˆ
  • email β€” this is the contact address for the owner of the current host. In connection with the DYNAMIC hosts, the address will be used for sending the belowmentioned script.
  • host β€” okay so there are three types of "hosts" in smokeping, and you need to know all three:
    1. The hostname is a name of a host you want to target from smokeping.
    2. The string DYNAMIC. This one's for machines that have a dynamic IP address. These boxes are required to regularly contact the SmokePing server to confirm their IP address. When starting SmokePing with the commandline argument --email it will add a secret password to each of the DYNAMIC host lines and send a script to the owner of each host. This script must be started periodically (cron) on the host in question to let smokeping know where the host is currently located. If the target machine supports SNMP, SmokePing will also query the host's sysContact, sysName and sysLocation properties to make sure it is still the same host. πŸ‘‘
    3. A space separated list of target-path entries (multihost target). All targets mentioned in this list will be displayed in one graph. Note that the graph will look different from the normal smokeping graphs. The syntax for multihost targets is as follows:
 host = /world/town/host1 /world/town2/host33 /world/town2/host1~slave
  • remark β€” (see above 🌷)
  • rawlog β€” log the raw data, gathered for this target, in tab separated format, to a file with the same basename as the corresponding RRD file. Use posix strftime to format the timestamp to be put into the file name. The filename is built like this:
 basename.strftime.csv

Example:

 rawlog=%Y-%m-%d

this would create a new logfile every day with a name like this:

 targethost.2004-05-03.csv
  • alertee β€” if you want to have alerts for this target and all targets below it go to a particular address on top of the address already specified in the alert, you can add it here. This can be a comma separated list of items. This variable inherits its value from the parent section if nothing is specified here.
  • slaves β€” the slave names must match the slaves you have set up in the slaves section. No matching random names, bestie, it's a whole thing. This variable inherits its value from the parent section if nothing is specified here.
  • menuextra β€” HTML String to be added to the end of each menu entry. The following tags will be replaced:
   {HOST}     -> #$hostname
   {HOSTNAME} -> $hostname
   {CLASS}    -> same class as the other tags in the menu line
   {HASH}     -> #

This variable inherits its value from the parent section if nothing is specified here.

  • parents β€” after setting up a hierarchy in the Presentation section of the configuration file you can use this property to assign an entry to alternate hierarchies. The format for parent entries is:
 hierarchyA:/Node1/Node2 hierarchyB:/Node3

The entries from all parents properties together will build a new tree for each hierarchy. With this method it is possible to make a single target show up multiple times in a tree. If you think this is a good thing, go ahead, nothing is stopping you 😌 Since you do not only define the parent but the full path of the parent node, circular dependencies are not possible. Slay, structural safety.

  • hide β€” set the hide property to 'yes' to hide this host from the navigation menu and from search results. Note that if you set the hide property on a non leaf entry, all subordinate entries will also disappear in the menu structure. If you know a direct link to a page it is still accessible. Pages which are hidden from the menu due to a parent being hidden will still show up in search results and in alternate hierarchies where they are below a non hidden parent. Default value: hide = no
  • nomasterpoll β€” use this in a master/slave setup where the master must not poll a particular target. The master will now skip this entry in its polling cycle. Note that if you set the hide property on a non leaf entry all subordinate entries will also disappear in the menu structure. You can still access them via direct link or via an alternate hierarchy. If you have no master/slave setup this will have a similar effect to the hide property, except that the menu entry will still show up, but will not contain any graphs. This variable inherits its value from the parent section if nothing is specified here. Default value: nomasterpoll = no

The following sections are valid on level 2:

πŸ¦‹ ++/[-_0-9a-zA-Z]+/ πŸ¦‹

This section is recursive: it can contain subsection(s) with the same syntax. Yes, again. Deeply nested vibes πŸ’œ


⚑ Dynamical grammar changes for example values of variable "probe" ⚑

AnotherCurl: (See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • agent β€” see above
  • extraargs β€” see above
  • extrare β€” see above
  • follow_redirects β€” see above
  • include_redirects β€” see above
  • insecure_ssl β€” see above
  • interface β€” see above
  • pings β€” see above
  • ssl2 β€” see above
  • timeout β€” see above
  • urlformat β€” see above
  • write_out β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • agent β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • extraargs β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • extrare β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • follow_redirects β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • include_redirects β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • insecure_ssl β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • interface β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • ssl2 β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • urlformat β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • write_out β€” see above. This variable inherits its value from the parent section if nothing is specified here.

(End of the dynamical grammar changes for variable probe example value AnotherCurl.) β€” okay moving on, bestie πŸ’…


πŸ¦‹ AnotherDNS

(See the separate module documentation for details about each variable β€” that's where the deep lore lives ✨)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • authoritative β€” see above
  • expect_text β€” see above
  • ipversion β€” see above
  • lookup β€” see above
  • mininterval β€” see above
  • pings β€” see above
  • port β€” see above
  • protocol β€” see above
  • recordtype β€” see above
  • require_answers β€” see above
  • require_noerror β€” see above
  • require_nxdomain β€” see above
  • timeout β€” see above

🌸 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid in here, bestie:

  • /^influx_.+/ β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • authoritative β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • expect_text β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • ipversion β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • lookup β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • mininterval β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • pings β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • port β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • protocol β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • recordtype β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • require_answers β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • require_noerror β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • require_nxdomain β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘
  • timeout β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ‘‘

(End of the dynamical grammar changes for variable probe example value AnotherDNS.)


πŸŽ€ AnotherSSH

(See the separate module documentation for details about each variable πŸ’–)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • greeting β€” see above
  • interval β€” see above
  • mininterval β€” see above
  • pings β€” see above
  • port β€” see above
  • timeout β€” see above

🌈 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ’«
  • greeting β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ’«
  • interval β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ’«
  • mininterval β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ’«
  • pings β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ’«
  • port β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ’«
  • timeout β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ’«

(End of the dynamical grammar changes for variable probe example value AnotherSSH.)


🧚 CiscoRTTMonDNS

(See the separate module documentation for details about each variable 🫢)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • ioshost β€” see above
  • iosint β€” see above
  • name β€” see above
  • pings β€” see above
  • timeout β€” see above

⭐ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ”₯
  • ioshost β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ”₯
  • iosint β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ”₯
  • name β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ”₯
  • pings β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ”₯
  • timeout β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸ”₯

(End of the dynamical grammar changes for variable probe example value CiscoRTTMonDNS.)


πŸ’œ CiscoRTTMonEchoICMP

(See the separate module documentation for details about each variable 🌸)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • ioshost β€” see above
  • iosint β€” see above
  • packetsize β€” see above
  • pings β€” see above
  • timeout β€” see above
  • tos β€” see above
  • vrf β€” see above

πŸ“ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨
  • ioshost β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨
  • iosint β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨
  • packetsize β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨
  • pings β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨
  • timeout β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨
  • tos β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨
  • vrf β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. ✨

(End of the dynamical grammar changes for variable probe example value CiscoRTTMonEchoICMP.)


πŸ¦‹ CiscoRTTMonTcpConnect

(See the separate module documentation for details about each variable πŸ’€)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • ioshost β€” see above
  • iosint β€” see above
  • pings β€” see above
  • port β€” see above
  • timeout β€” see above
  • tos β€” see above

🐚 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸŽ€
  • ioshost β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸŽ€
  • iosint β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸŽ€
  • pings β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸŽ€
  • port β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸŽ€
  • timeout β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸŽ€
  • tos β€” see above. Also: this variable inherits its value from the parent section if nothing is specified here. πŸŽ€

(End of the dynamical grammar changes for variable probe example value CiscoRTTMonTcpConnect.)


🌈 Curl

(See the separate module documentation for details about each variable β€” yes, that's a whole other vibe check, go read it 🧚)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • agent β€” see above
  • expect β€” see above
  • extraargs β€” see above
  • extrare β€” see above
  • follow_redirects β€” see above
  • include_redirects β€” see above
  • insecure_ssl β€” see above
  • interface β€” see above
  • pings β€” see above πŸ‘†
  • require_zero_status β€” see above πŸ‘†
  • ssl2 β€” see above πŸ‘†
  • timeout β€” see above πŸ‘†
  • urlformat β€” see above πŸ‘†

✨ syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

okay so when you're inside one of those subsections, these are the new variables that are valid:

  • /^influx_.+/ β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • agent β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • expect β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • extraargs β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • extrare β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • follow_redirects β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • include_redirects β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • insecure_ssl β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • interface β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • require_zero_status β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • ssl2 β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • urlformat β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "Curl".)


🌈 DNS 🌈

(See the separate module documentation for details about each variable.) β€” like, genuinely go read that one bestie, this is just the grammar tea πŸ«–

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘†
  • lookup β€” see above πŸ‘†
  • pings β€” see above πŸ‘†
  • server β€” see above πŸ‘†

✨ syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • lookup β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • server β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "DNS".)


πŸ¦‹ DismanPing πŸ¦‹

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘†
  • ownerindex β€” see above πŸ‘†
  • packetsize β€” see above πŸ‘†
  • pinghost β€” see above πŸ‘†
  • pingsrc β€” see above πŸ‘†

✨ syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • ownerindex β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • packetsize β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • pinghost β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • pingsrc β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "DismanPing".)


πŸŽ€ EchoPing πŸŽ€

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘†
  • extraopts β€” see above πŸ‘†
  • fill β€” see above πŸ‘†
  • ipversion β€” see above πŸ‘†
  • pings β€” see above πŸ‘†
  • priority β€” see above πŸ‘†
  • size β€” see above πŸ‘†
  • timeout β€” see above πŸ‘†
  • tos β€” see above πŸ‘†
  • udp β€” see above πŸ‘†
  • waittime β€” see above πŸ‘†

✨ syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • fill β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • size β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • tos β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • udp β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPing".)


πŸ’œ EchoPingChargen πŸ’œ

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘†
  • extraopts β€” see above πŸ‘†
  • fill β€” see above πŸ‘†
  • ipversion β€” see above πŸ‘†
  • pings β€” see above πŸ‘†
  • priority β€” see above πŸ‘†
  • size β€” see above πŸ‘†
  • timeout β€” see above πŸ‘†
  • tos β€” see above πŸ‘†
  • waittime β€” see above πŸ‘†

✨ syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • fill β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • size β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • tos β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” see above πŸ‘† This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingChargen".)


🌸 EchoPingDNS 🌸

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ‘†
  • dns_request β€” see above πŸ‘†
  • dns_tcp β€” see above πŸ‘†
  • dns_type β€” see above πŸ‘†
  • extraopts β€” see above πŸ‘†
  • ipversion β€” see above πŸ‘†
  • pings β€” see above πŸ‘†
  • plugin β€” see above πŸ‘†
  • pluginargs β€” see above πŸ‘†
  • priority β€” see above πŸ‘†
  • timeout β€” see above πŸ‘†
  • tos β€” see above πŸ‘†
  • waittime β€” see above πŸ‘†

✨ syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • /^influx_.+ β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • dns_request β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • dns_tcp β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • dns_type β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • plugin β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • pluginargs β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • tos β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” see above This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingDNS".)


🫢 EchoPingDiscard (aka the "just yeet it into the void" probe)

Okay bestie, heads up: for this one you gotta go read the separate module documentation for the deets on each variable β€” this page is not the place. Here's the guest list of new variables that are valid:

  • /^influx_.+ β€” see above
  • extraopts β€” see above
  • fill β€” see above
  • ipversion β€” see above
  • pings β€” see above
  • priority β€” see above
  • size β€” see above
  • timeout β€” see above
  • tos β€” see above
  • udp β€” see above
  • waittime β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌈

The following new variables are valid:

  • /^influx_.+ β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • fill β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • size β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • tos β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • udp β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” see above This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingDiscard".)


🌸 EchoPingHttp (the classic, the icon, the moment)

Same deal, bestie: the separate module documentation has the full tea on each variable. The following new variables are valid:

  • /^influx_.+ β€” see above
  • accept_redirects β€” see above
  • extraopts β€” see above
  • ignore_cache β€” see above
  • ipversion β€” see above
  • pings β€” see above
  • port β€” see above
  • priority β€” see above
  • revalidate_data β€” see above
  • timeout β€” see above
  • tos β€” see above
  • url β€” see above
  • waittime β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸ¦‹

The following new variables are valid:

  • /^influx_.+ β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • accept_redirects β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • ignore_cache β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • port β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • revalidate_data β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • tos β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • url β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” see above This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingHttp".)


πŸ’… EchoPingHttps (same energy, but with a prot now, iykyk)

Yeah yeah, you know the drill: separate module documentation, each variable, details, go read it. The following new variables are valid:

  • /^influx_.+ β€” see above
  • accept_redirects β€” see above
  • extraopts β€” see above
  • ignore_cache β€” see above
  • ipversion β€” see above
  • pings β€” see above
  • port β€” see above
  • priority β€” see above
  • prot β€” see above
  • revalidate_data β€” see above
  • timeout β€” see above
  • tos β€” see above
  • url β€” see above
  • waittime β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸŽ€

The following new variables are valid:

  • /^influx_.+ β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • accept_redirects β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • extraopts β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • ignore_cache β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • ipversion β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • port β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • prot β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • revalidate_data β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • tos β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • url β€” see above This variable inherits its value from the parent section if nothing is specified here.
  • waittime β€” see above This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingHttps".)


Not me having typed "see above" like forty times πŸ’€ but that's literally the whole bit β€” if a variable isn't set in the subsection, it inherits its value from the parent section. Every time. No cap.

πŸ’… EchoPingIcp

(peep the separate module documentation for the deets on each variable, bestie πŸ’–)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • extraopts β€” see above
  • ipversion β€” see above
  • pings β€” see above
  • priority β€” see above
  • timeout β€” see above
  • tos β€” see above
  • url β€” see above
  • waittime β€” see above

πŸ¦‹ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above
    • this one inherits its value from the parent section if nothing is specified here πŸ’«
  • extraopts β€” see above
    • inherits from the parent section if you don't specify anything here
  • ipversion β€” see above
    • inherits from the parent section if nothing's set here
  • pings β€” see above
    • inherits from the parent section if nothing's set here
  • priority β€” see above
    • inherits from the parent section if nothing's set here
  • timeout β€” see above
    • inherits from the parent section if nothing's set here
  • tos β€” see above
    • inherits from the parent section if nothing's set here
  • url β€” see above
    • inherits from the parent section if nothing's set here
  • waittime β€” see above
    • inherits from the parent section if nothing's set here
(End of dynamical grammar changes for variable probe example value EchoPingIcp.)

🌸 EchoPingLDAP

(again β€” the separate module documentation has the full breakdown of every variable, go read it 🫢)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • extraopts β€” see above
  • ipversion β€” see above
  • ldap_base β€” see above
  • ldap_request β€” see above
  • ldap_scope β€” see above
  • pings β€” see above
  • plugin β€” see above
  • pluginargs β€” see above
  • priority β€” see above
  • timeout β€” see above
  • tos β€” see above
  • waittime β€” see above

πŸŽ€ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above
    • inherits its value from the parent section if nothing is specified here
  • extraopts β€” see above
    • inherits its value from the parent section if nothing is specified here
  • ipversion β€” see above
    • inherits its value from the parent section if nothing is specified here
  • ldap_base β€” see above
    • inherits its value from the parent section if nothing is specified here
  • ldap_request β€” see above
    • inherits its value from the parent section if nothing is specified here
  • ldap_scope β€” see above
    • inherits its value from the parent section if nothing is specified here
  • pings β€” see above
    • inherits its value from the parent section if nothing is specified here
  • plugin β€” see above
    • inherits its value from the parent section if nothing is specified here
  • pluginargs β€” see above
    • inherits its value from the parent section if nothing is specified here
  • priority β€” see above
    • inherits its value from the parent section if nothing is specified here
  • timeout β€” see above
    • inherits its value from the parent section if nothing is specified here
  • tos β€” see above
    • inherits its value from the parent section if nothing is specified here
  • waittime β€” see above
    • inherits its value from the parent section if nothing is specified here
(End of dynamical grammar changes for variable probe example value EchoPingLDAP.)

✨ EchoPingPlugin

(yes, another one β€” separate module documentation has the variable-by-variable tea β˜•)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • extraopts β€” see above
  • ipversion β€” see above
  • pings β€” see above
  • plugin β€” see above
  • pluginargs β€” see above
  • priority β€” see above
  • timeout β€” see above
  • tos β€” see above
  • waittime β€” see above

πŸ’œ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above
    • inherits its value from the parent section if nothing is specified here
  • extraopts β€” see above
    • inherits its value from the parent section if nothing is specified here
  • ipversion β€” see above
    • inherits its value from the parent section if nothing is specified here
  • pings β€” see above
    • inherits its value from the parent section if nothing is specified here
  • plugin β€” see above
    • inherits its value from the parent section if nothing is specified here
  • pluginargs β€” see above
    • inherits its value from the parent section if nothing is specified here
  • priority β€” see above
    • inherits its value from the parent section if nothing is specified here
  • timeout β€” see above
    • inherits its value from the parent section if nothing is specified here
  • tos β€” see above
    • inherits its value from the parent section if nothing is specified here
  • waittime β€” see above
    • inherits its value from the parent section if nothing is specified here
(End of dynamical grammar changes for variable probe example value EchoPingPlugin.)

πŸ“ EchoPingSmtp

(separate module documentation, again, has every variable explained β€” go look πŸ‘€)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • extraopts β€” see above
  • ipversion β€” see above
  • pings β€” see above
  • priority β€” see above
  • timeout β€” see above
  • tos β€” see above
  • waittime β€” see above

🌈 Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above
    • inherits its value from the parent section if nothing is specified here
  • extraopts β€” see above
    • inherits its value from the parent section if nothing is specified here
  • ipversion β€” see above
    • inherits its value from the parent section if nothing is specified here
  • pings β€” see above
    • inherits its value from the parent section if nothing is specified here
  • priority β€” see above
    • inherits its value from the parent section if nothing is specified here
  • timeout β€” see above
    • inherits its value from the parent section if nothing is specified here
  • tos β€” see above
    • inherits its value from the parent section if nothing is specified here
  • waittime β€” see above
    • inherits its value from the parent section if nothing is specified here
(End of dynamical grammar changes for variable probe example value EchoPingSmtp.)

🧚 EchoPingWhois

(you already know β€” separate module documentation, details, every variable, go πŸƒβ€β™€οΈ)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • extraopts β€” see above
  • ipversion β€” see above
  • pings β€” see above
  • plugin β€” see above
  • pluginargs β€” see above
  • priority β€” see above
  • timeout β€” see above
  • tos β€” see above
  • waittime β€” see above
  • whois_request β€” see above

⭐ Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above
    • inherits its value from the parent section if nothing is specified here
  • extraopts β€” see above
    • inherits its value from the parent section if nothing is specified here
  • ipversion β€” see above
    • inherits its value from the parent section if nothing is specified here
  • pings β€” see above
    • inherits its value from the parent section if nothing is specified here
  • plugin β€” see above
⬆️ okay so that last one up there? if you don't set anything for it, it just inherits its value from the parent section. no extra work, we love that 🫢
  • pluginargs β€” see above 🌸
  • priority β€” see above; leave it empty and it inherits its value from the parent section, zero drama πŸ’…
  • timeout β€” see above. nothing here? inherits its value from the parent section, periodt
  • tos β€” see above ⭐ (same inherit-from-parent-section deal if you don't specify it here)
  • waittime β€” see above πŸ¦‹ inherits its value from the parent section when nothing's specified here
  • whois_request β€” see above; unset means it inherits its value from the parent section, iykyk

(End of dynamical grammar changes for variable probe example value EchoPingWhois.) ✨


πŸ‘‘ FPing

(See the separate module documentation for details about each variable.) β€” seriously bestie, go read it, it's giving thorough πŸ“š

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ’–

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. nothing set here? it inherits its value from the parent section πŸŽ€

(End of dynamical grammar changes for variable probe example value FPing.) ⭐


πŸ¦‹ FPing6

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ’œ

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and if you skip it here it inherits its value from the parent section 🫢

(End of dynamical grammar changes for variable probe example value FPing6.) 🌈


🧚 FPingContinuous

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above πŸ”₯

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above; unspecified here means it inherits its value from the parent section πŸ’«

(End of dynamical grammar changes for variable probe example value FPingContinuous.) πŸŽ€


πŸ“ FTPtransfer

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • localaddr β€” see above
  • passive β€” see above
  • password β€” see above
  • pings β€” see above
  • port β€” see above
  • timeout β€” see above
  • username β€” see above

yes bestie that's eight of them, all "see above", all iconic πŸ’…

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. inherits its value from the parent section if nothing is specified here πŸ¦‹
  • localaddr β€” see above. inherits its value from the parent section if there's nothing here 🌸
  • passive β€” see above. nothing here = inherits its value from the parent section πŸ’–
  • password β€” see above. leave it blank and it inherits its value from the parent section, no cap
  • pings β€” see above. inherits its value from the parent section when unspecified πŸŽ€
  • port β€” see above. inherits its value from the parent section if you don't say otherwise ⭐
  • timeout β€” see above. same deal β€” inherits its value from the parent section πŸ™ˆ
  • username β€” see above. inherits its value from the parent section if nothing's specified here 🫢

(End of dynamical grammar changes for variable probe example value FTPtransfer.) πŸ’œ


🌟 IOSPing

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • ioshost β€” see above
  • iosint β€” see above
  • iosuser β€” see above
  • pings β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. inherits its value from the parent section if nothing is specified here 🌈
  • ioshost β€” see above. inherits its value from the parent section if nothing is specified here πŸ¦‹
  • iosint β€” see above. inherits its value from the parent section if nothing is specified here πŸ”₯
  • iosuser β€” see above. inherits its value from the parent section if nothing is specified here 🧚
  • pings β€” see above. inherits its value from the parent section if nothing is specified here πŸ“

(End of dynamical grammar changes for variable probe example value IOSPing.) ✨


πŸ’€ IRTT

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • dscp β€” see above
  • extraargs β€” see above
  • fill β€” see above
  • hmac β€” see above
  • interval β€” see above
  • ipversion β€” see above
  • length β€” see above
  • localaddr β€” see above
  • metric β€” see above
  • pings β€” see above
  • readfrom β€” see above
  • readfrompollinterval β€” see above
  • serverfill β€” see above
  • sleep β€” see above
  • writeto β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. inherits its value from the parent section if nothing is specified here πŸ’«
  • dscp β€” see above. inherits its value from the parent section if nothing is specified here πŸŽ€
  • extraargs β€” see above. inherits its value from the parent section if nothing is specified here 🌸
  • fill β€” see above. inherits its value from the parent section if nothing is specified here πŸ’–
  • hmac β€” see above. inherits its value from the parent section if nothing is specified here ⭐
  • interval β€” see above. inherits its value from the parent section if nothing is specified here πŸ¦‹
  • ipversion β€” see above. inherits its value from the parent section if nothing is specified here πŸ”₯
  • length β€” see above. inherits its value from the parent section if nothing is specified here 🌈
  • localaddr β€” see above. inherits its value from the parent section if nothing is specified here 🧚
  • metric β€” see above. inherits its value from the parent section if nothing is specified here πŸ“
  • pings β€” see above. inherits its value from the parent section if nothing is specified here πŸ‘‘
  • readfrom β€” see above. inherits its value from the parent section if nothing is specified here πŸ’œ
  • readfrompollinterval β€” see above. inherits its value from the parent section if nothing is specified here πŸ™ˆ
  • serverfill β€” see above. inherits its value from the parent section if nothing is specified here 🫢
  • sleep β€” see above. inherits its value from the parent section if nothing is specified here ✨
  • writeto β€” see above. inherits its value from the parent section if nothing is specified here πŸ’…

(End of dynamical grammar changes for variable probe example value IRTT.) 🌟


🌸 LDAP

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • attrs β€” see above
  • base β€” see above
  • binddn β€” see above
  • filter β€” see above
  • mininterval β€” see above
  • password β€” see above
  • pings β€” see above
  • port β€” see above
  • scheme β€” see above
  • scope β€” see above
  • start_tls β€” see above
  • timeout β€” see above
  • verify β€” see above
  • version β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above. inherits its value from the parent section if nothing is specified here πŸŽ€
  • attrs β€” see above. inherits its value from the parent section if nothing is specified here 🌸

…and one more entry was still finishing its sentence before we could escape LDAP land, so real quick:

  • it β€” obviously still inherits its value from the parent section if nothing is specified here πŸ’…

(End of dynamical grammar changes for variable probe example value LDAP.)


🧚 NFS ping: the NFSping era

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and yes: this variable inherits its value from the parent section if nothing is specified here 🫢

(End of dynamical grammar changes for variable probe example value NFSping.)


🌈 OpenSSHEOSPing β€” EOS girlies rise

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • eospass β€” see above
  • eosuser β€” see above
  • pings β€” see above
  • psource β€” see above
  • source β€” see above
  • unpriv β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • eospass β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • eosuser β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • pings β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • psource β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • source β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • unpriv β€” see above, and this variable inherits its value from the parent section if nothing is specified here

(End of dynamical grammar changes for variable probe example value OpenSSHEOSPing.)


πŸ¦‹ OpenSSHJunOSPing β€” same energy, Juniper flavour

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • junospass β€” see above
  • junosuser β€” see above
  • pings β€” see above
  • psource β€” see above
  • source β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • junospass β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • junosuser β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • pings β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • psource β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • source β€” see above, and this variable inherits its value from the parent section if nothing is specified here

(End of dynamical grammar changes for variable probe example value OpenSSHJunOSPing.)


πŸŽ€ Qstat β€” short and sweet, honestly iconic

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • pings β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • pings β€” see above, and this variable inherits its value from the parent section if nothing is specified here

(End of dynamical grammar changes for variable probe example value Qstat.)


πŸ’œ Radius β€” the long list, buckle up bestie

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • allowreject β€” see above
  • mininterval β€” see above
  • nas_ip_address β€” see above
  • password β€” see above
  • pings β€” see above
  • port β€” see above
  • secret β€” see above
  • timeout β€” see above
  • username β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • allowreject β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • mininterval β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • nas_ip_address β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • password β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • pings β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • port β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • secret β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • timeout β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • username β€” see above, and this variable inherits its value from the parent section if nothing is specified here

(End of dynamical grammar changes for variable probe example value Radius.)


⭐ RemoteFPing β€” minimal queen

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and this variable inherits its value from the parent section if nothing is specified here

(End of dynamical grammar changes for variable probe example value RemoteFPing.)


πŸ’€ SSH β€” the classic, we love her

(See the separate module documentation for details about each variable.)

The following new variables are valid:

  • /^influx_.+/ β€” see above
  • keytype β€” see above
  • pings β€” see above
  • port β€” see above
  • ssh_af β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

  • /^influx_.+/ β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • keytype β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • pings β€” see above, and this variable inherits its value from the parent section if nothing is specified here
  • port β€” see above…

…and that list is literally mid-sentence, so hold that thought 🫢✨

  • user β€” see above.

(End of dynamical grammar changes for variable probe example value SipSak.)

TCPPing: (peep the separate module docs for the full tea on each variable β˜•) The following new variables are valid:

  • /^influx_.+/ β€” see above
  • pings β€” see above
  • port β€” see above

### Syntax changes for subsection /[-_0-9a-zA-Z]+/ ✨

The following new variables are valid:

  • /^influx_.+/ β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • pings β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • port β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable probe example value TCPPing.)

TacacsPlus: (the separate module docs have the full breakdown for every single variable, go check 'em πŸ’–) The following new variables are valid:

  • /^influx_.+/ β€” see above
  • authtype β€” see above
  • mininterval β€” see above
  • password β€” see above
  • pings β€” see above
  • port β€” see above
  • secret β€” see above
  • timeout β€” see above
  • username β€” see above

### Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸ¦‹

The following new variables are valid:

  • /^influx_.+/ β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • authtype β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • mininterval β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • password β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • pings β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • port β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • secret β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • timeout β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • username β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable probe example value TacacsPlus.)

TelnetIOSPing: (again β€” separate module docs, one page per variable, it's giving thorough πŸ’…) The following new variables are valid:

  • /^influx_.+/ β€” see above
  • iospass β€” see above
  • iosuser β€” see above
  • pings β€” see above
  • psource β€” see above
  • source β€” see above
  • vrf see above

### Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸŽ€

The following new variables are valid:

  • /^influx_.+/ β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • iospass β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • iosuser β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • pings β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • psource β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • source β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • vrf see above.

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable probe example value TelnetIOSPing.)

TelnetJunOSPing: (yup, separate module docs, every variable explained in its own little home 🏠) The following new variables are valid:

  • /^influx_.+/ β€” see above
  • junospass β€” see above
  • junosuser β€” see above
  • pings β€” see above
  • psource β€” see above
  • source β€” see above

### Syntax changes for subsection /[-_0-9a-zA-Z]+/ 🌸

The following new variables are valid:

  • /^influx_.+/ β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • junospass β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • junosuser β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • pings β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • psource β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • source β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable probe example value TelnetJunOSPing.)

TraceroutePing: (once more with feeling β€” separate module docs, per-variable details, you know the drill 🫢) The following new variables are valid:

  • /^influx_.+/ β€” see above
  • desthost β€” see above
  • host β€” see above
  • maxttl β€” see above
  • minttl β€” see above
  • pings β€” see above
  • wait β€” see above

### Syntax changes for subsection /[-_0-9a-zA-Z]+/ πŸ’œ

The following new variables are valid:

  • /^influx_.+/ β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • desthost β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • maxttl β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • minttl β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • pings β€” see above.

This variable inherits its value from the parent section if nothing is specified here.

  • wait β€” see above.

And the inheritance tea is: this variable inherits its value from the parent section if nothing is specified here. πŸ’…

✨ (End of dynamical grammar changes for variable probe example value TraceroutePing.) ✨

πŸ¦‹ WebProxyFilter πŸ¦‹

(See the separate module documentation for details about each variable.) The following new variables are valid:

  • /^influx_.+/ β€” see above
  • deny_re β€” see above
  • more_hosts β€” see above
  • pings β€” see above
  • timeout β€” see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/ β€” the following new variables are valid:

  • /^influx_.+/ β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • deny_re β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • more_hosts β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • pings β€” see above. This variable inherits its value from the parent section if nothing is specified here.
  • timeout β€” see above. This variable inherits its value from the parent section if nothing is specified here.
✨ (End of dynamical grammar changes for variable probe example value WebProxyFilter.) ✨
πŸ’€ (End of dynamical grammar changes for example values of variable probe.) πŸ’€

πŸ’– * Alerts * πŸ’–

The Alert section is where you set up loss and RTT pattern detectors. After each round of polling, SmokePing will examine its data and determine which detectors match. Detectors are enabled per target and get inherited by the targets children. πŸ‘‘

Detectors are not just simple thresholds that go off at first sight of a problem. They are configurable to detect special loss or RTT patterns. They let you look at a number of past readings to make a more educated decision on what kind of alert should be sent, or if an alert should be sent at all. It’s giving β€œdata-driven decisions, bestie.” πŸ’…

The patterns are numbers prefixed with an operator indicating the type of comparison required for a match.

The following RTT pattern detects if a target’s RTT goes from constantly below 10ms to constantly 100ms and more:

 old ------------------------------> new
 <10,<10,<10,<10,<10,>10,>100,>100,>100

Loss patterns work in a similar way, except that the loss is defined as the percentage the total number of received packets is of the total number of packets sent. 🫢

 old ------------------------------> new
 ==0%,==0%,==0%,==0%,>20%,>20%,>=20%

Apart from normal numbers, patterns can also contain the values * which is true for all values regardless of the operator. And U which is true for unknown data together with the == and =! operators. 🧚

Detectors normally act on state changes. This has the disadvantage, that they will fail to find conditions which were already present when launching smokeping. For this it is possible to write detectors that begin with the special value ==S it is inserted whenever smokeping is started up.

You can write:

 ==S,>20%,>20%

to detect lines that have been losing more than 20% of the packets for two periods after startup.

If you want to make sure a value within a certain range you can use two conditions in one element:

 >45%<=55%

Sometimes it may be that conditions occur at irregular intervals. But still you only want to throw an alert if they occur several times within a certain time period. The operator *X* will ignore up to X values and still let the pattern match:

 >10%,*10*,>10%

will fire if more than 10% of the packets have been lost at least twice over the last 10 samples.

A complete example, periodt:

 *** Alerts ***
 to = admin@company.xy,peter@home.xy
 from = smokealert@company.xy

 +lossdetect
 type = loss
 # in percent
 pattern = ==0%,==0%,==0%,==0%,>20%,>20%,>20%
 comment = suddenly there is packet loss

 +miniloss
 type = loss
 # in percent
 pattern = >0%,*12*,>0%,*12*,>0%
 comment = detected loss 3 times over the last two hours

 +rttdetect
 type = rtt
 # in milliseconds
 pattern = <10,<10,<10,<10,<10,<100,>100,>100,>100
 comment = routing messed up again ?

 +rttbadstart
 type = rtt
 # in milliseconds
 pattern = ==S,==U
 comment = offline at startup

The following variables can be set in this section:

  • to β€” (mandatory setting) Either an email address to send alerts to, or the name of a program to execute when an alert matches. To call a program, the first character of the to value must be a pipe symbol "|". The program will the be called whenever an alert matches, using the following 5 arguments (except if edgetrigger is 'yes'; see below): name-of-alert, target, loss-pattern, rtt-pattern, hostname. You can also provide a comma separated list of addresses and programs. πŸ’Œ
  • from β€” (mandatory setting) who should alerts appear to be coming from ?
  • edgetrigger β€” The alert notifications and/or the programs executed are normally triggered every time the alert matches. If this variable is set to 'yes', they will be triggered only when the alert’s state is changed, ie. when it’s raised and when it’s cleared. Subsequent matches of the same alert will thus not trigger a notification.

When this variable is set to 'yes', a notification program (see the to variable documentation above) will get a sixth argument, raise, which has the value 1 if the alert was just raised and 0 if it was cleared.

Default value: edgetrigger = no

  • mailtemplate β€” When sending out mails for alerts, smokeping normally uses an internally generated message. With the mailtemplate you can specify a filename for a custom template. The file should contain a 'Subject: ...' line. The rest of the file should contain text. The all <##keyword##> type strings will get replaced in the template before it is sent out. the following keywords are supported:
    • <##ALERT##> β€” target name
    • <##WHAT##> β€” status (is active, was raised, was cleared)
    • <##LINE##> β€” path in the config tree
    • <##URL##> β€” webpage for graph
    • <##STAMP##> β€” date and time
    • <##PAT##> β€” pattern that matched the alert
    • <##LOSS##> β€” loss history
    • <##RTT##> β€” rtt history
    • <##COMMENT##> β€” comment

The following sections are valid on level 1:

  • +/[^\s,]+/ β€” The following variables can be set in this section:
    • type β€” (mandatory setting) Currently the pattern types rtt and loss and matcher are known.

Matchers are plugin modules that extend the alert conditions. Known matchers are Avgratio, CheckLatency, CheckLoss, ConsecutiveLoss, ExpLoss, Median, Medratio.

See the documentation of the corresponding matcher module (eg. Smokeping::matchers::Avgratio) for instructions on configuring it.

  • pattern β€” (mandatory setting) a comma separated list of comparison operators and numbers. rtt patterns are in milliseconds, loss patterns are in percents.
  • comment β€” (mandatory setting)
  • to β€” Similar to the "to" parameter on the top-level except that it will only be used IN ADDITION to the value of the toplevel parameter. Same rules apply.
  • edgetrigger β€” This variable inherits its value from the parent section if nothing is specified here.

Default value: edgetrigger = no

  • mailtemplate β€” This variable inherits its value from the parent section if nothing is specified here.
  • priority β€” if multiple alerts 'match' only the one with the highest priority (lowest number) will cause and alert to be sent. Alerts without priority will be sent in any case.

πŸŽ€ * Slaves * πŸŽ€

Your smokeping can remote control other smokeping instances running in slave mode on different hosts. Use this section to tell your master smokeping about the slaves you are going to use. 🫑

The following variables can be set in this section:

  • secrets β€” (mandatory setting) The slave secrets file contains one line per slave with the name of the slave followed by a colon and the secret:
 slave1:secret1
 slave2:secret2
 ...
⚠️ Note that these secrets combined with a man-in-the-middle attack effectively give shell access to the corresponding slaves (see smokeping_master_slave), so the file should be appropriately protected and the secrets should not be easily crackable. πŸ’€

The following sections are valid on level 1:

  • +/[-_0-9a-zA-Z.]+/ β€” Define some basic properties for the slave.

The following variables can be set in this section:

  • display_name β€” (mandatory setting) Name of the Slave host.
  • location β€” Where is the slave located.
  • color β€” (mandatory setting) Color for the slave in graphs where input from multiple hosts is presented.

The following sections are valid on level 2:

  • ++override β€” If part of the configuration information must be overwritten to match the settings of the you can specify this in this section. A setting is overwritten by giving the full path of the configuration variable. If you have this configuration in the Probes section:
 *** Probes ***
 +FPing
 binary = /usr/sepp/bin/fping

You can override it for a particular slave like this:

 ++override
 Probes.FPing.binary = /usr/bin/fping

The following variables can be set in this section:

  • /\S+/ β€” ✨

🌈 * InfluxDB * 🌈

If you want to export data to an InfluxDB database, fill in this section.

The following variables can be set in this section:

  • host β€” (mandatory setting) The FQDN or IP address of your InfluxDB server. For example 'localhost', 'influx.example.org' or '127.0.0.1'
  • port β€” The port of your InfluxDB server. Default is 8086.

Default value: port = 8086

  • timeout β€” Connection timeout to InfluxDB in seconds. Default is 15s. Too big of a timeout will cause polling errors when InfluxDB is down. 😭

Default value: timeout = 15

  • database β€” (mandatory setting) Database name (where to write the data) within InfluxDB. If it doesn’t exist, it will be created when writing data. πŸ¦‹
  • username β€” the username for authentication to InfluxDB. If you don't supply it, no authentication is attempted at all. Simple as that πŸ’…
  • password β€” the password for authentication to InfluxDB. Not supplied? Then again, no authentication is attempted. They come as a pair, bestie 🫢

🌈 SEE ALSO

The core crew, go say hi:

smokeping(1), smokeping_master_slave(7), smokeping_cgi(1)

πŸŽ€ Matchers

Smokeping_matchers_Avgratio(3), Smokeping_matchers_CheckLatency(3), Smokeping_matchers_CheckLoss(3), Smokeping_matchers_ExpLoss(3), Smokeping_matchers_Median(3), Smokeping_matchers_Medratio(3), Smokeping_matchers_base(3)

πŸ¦‹ Probes

Okay this is the whole friend group, no one gets left out:

Smokeping_probes_CiscoRTTMonDNS(3), Smokeping_probes_CiscoRTTMonEchoICMP(3), Smokeping_probes_CiscoRTTMonTcpConnect(3), Smokeping_probes_Curl(3), Smokeping_probes_DNS(3), Smokeping_probes_DismanPing(3), Smokeping_probes_EchoPing(3), Smokeping_probes_EchoPingChargen(3), Smokeping_probes_EchoPingDNS(3), Smokeping_probes_EchoPingDiscard(3), Smokeping_probes_EchoPingHttp(3), Smokeping_probes_EchoPingHttps(3), Smokeping_probes_EchoPingIcp(3), Smokeping_probes_EchoPingLDAP(3), Smokeping_probes_EchoPingPlugin(3), Smokeping_probes_EchoPingSmtp(3), Smokeping_probes_EchoPingWhois(3), Smokeping_probes_FPing(3), Smokeping_probes_FPing6(3), Smokeping_probes_FPingContinuous(3), Smokeping_probes_FTPtransfer(3), Smokeping_probes_IOSPing(3), Smokeping_probes_IRTT(3), Smokeping_probes_LDAP(3), Smokeping_probes_NFSping(3), Smokeping_probes_OpenSSHEOSPing(3), Smokeping_probes_OpenSSHJunOSPing(3), Smokeping_probes_Qstat(3), Smokeping_probes_Radius(3), Smokeping_probes_RemoteFPing(3), Smokeping_probes_SSH(3), Smokeping_probes_SendEmail(3), Smokeping_probes_SipSak(3), Smokeping_probes_TCPPing(3), Smokeping_probes_TacacsPlus(3), Smokeping_probes_TelnetIOSPing(3), Smokeping_probes_TelnetJunOSPing(3), Smokeping_probes_TraceroutePing(3), Smokeping_probes_WebProxyFilter(3), Smokeping_probes_base(3), Smokeping_probes_basefork(3), Smokeping_probes_basevars(3), Smokeping_probes_passwordchecker(3), Smokeping_probes_skel(3)

⭐ Sorters

Smokeping_sorters_Loss(3), Smokeping_sorters_Max(3), Smokeping_sorters_Median(3), Smokeping_sorters_StdDev(3), Smokeping_sorters_base(3)


Copyright (c) 2001-2007 by Tobias Oetiker. All right reserved.

(Yes, "All right reserved" β€” that's literally how it's written, we're keeping it exactly, no cap πŸ’€)


πŸ“œ LICENSE

Okay so legally speaking, here's the whole vibe:

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

And the disclaimer, which is real important, bestie β€” read it:

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Also this bit, because paperwork never sleeps:

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

🧚 AUTHOR

Tobias Oetiker <tobi@oetiker.ch> β€” the icon, the legend, the main character of this whole manpage 🌟


And that's a wrap on SMOKEPING_CONFIG(5), bestie! πŸŽ€ This one's from smokeping 2.9.0, dated 2025-06-30 β€” go forth and configure slayfully πŸ’–βœ¨

πŸ“¦ where this page comes from