smokeping_probes_basevars(3) [debian man page]
Smokeping_probes_basevars(3) SmokePing Smokeping_probes_basevars(3) NAME
Smokeping::probes::basevars - Another Base Class for implementing SmokePing Probes OVERVIEW
Like Smokeping::probes::base, but supports host-specific variables for the probe. SYNOPSIS
*** Probes *** +basevars offset = 50% pings = 20 step = 300 # [...] *** Targets *** probe = basevars # if this should be the default probe # [...] + mytarget # probe = basevars # if the default probe is something else host = my.host DESCRIPTION
Provides the method `targets' that returns a list of hashes. The hashes contain the entries: addr The address of the target. vars A hash containing variables defined in the corresponding config section. tree The unique index that `probe::base' uses for targets. There's also the method 'vars' that returns the abovementioned hash corresponding to the 'tree' index parameter. VARIABLES
Supported probe-specific variables: offset If you run many probes concurrently you may want to prevent them from hitting your network all at the same time. Using the probe- specific offset parameter you can change the point in time when each probe will be run. Offset is specified in % of total interval, or alternatively as 'random', and the offset from the 'General' section is used if nothing is specified here. Note that this does NOT influence the rrds itself, it is just a matter of when data acqusition is initiated. (This variable is only applicable if the variable 'concurrentprobes' is set in the 'General' section.) Example value: 50% pings How many pings should be sent to each target, if different from the global value specified in the Database section. 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. Example value: 20 step Duration of the base interval that this probe should use, if different from the one specified in the 'Database' section. 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. (This variable is only applicable if the variable 'concurrentprobes' is set in the 'General' section.) Example value: 300 AUTHORS
Niko Tyni <ntyni@iki.fi> BUGS
Uses `Smokeping::probes::base' internals too much to be a derived class, but I didn't want to touch the base class directly. SEE ALSO
Smokeping::probes::base, Smokeping::probes::EchoPing 2.6.8 2013-03-17 Smokeping_probes_basevars(3)
Check Out this Related Man Page
Smokeping_probes_EchoPingSmtp(3) SmokePing Smokeping_probes_EchoPingSmtp(3) NAME
Smokeping::probes::EchoPingSmtp - an echoping(1) probe for SmokePing OVERVIEW
Measures SMTP roundtrip times (mail servers) for SmokePing. SYNOPSIS
*** Probes *** +EchoPingSmtp binary = /usr/bin/echoping forks = 5 offset = 50% step = 300 # The following variables can be overridden in each target section extraopts = -some-letter-the-author-did-not-think-of ipversion = 4 pings = 5 priority = 6 timeout = 1 tos = 0xa0 waittime = 1 # [...] *** Targets *** probe = EchoPingSmtp # if this should be the default probe # [...] + mytarget # probe = EchoPingSmtp # if the default probe is something else host = my.host extraopts = -some-letter-the-author-did-not-think-of ipversion = 4 pings = 5 priority = 6 timeout = 1 tos = 0xa0 waittime = 1 VARIABLES
Supported probe-specific variables: binary The location of your echoping binary. Default value: /usr/bin/echoping forks Run this many concurrent processes at maximum Example value: 5 Default value: 5 offset If you run many probes concurrently you may want to prevent them from hitting your network all at the same time. Using the probe- specific offset parameter you can change the point in time when each probe will be run. Offset is specified in % of total interval, or alternatively as 'random', and the offset from the 'General' section is used if nothing is specified here. Note that this does NOT influence the rrds itself, it is just a matter of when data acqusition is initiated. (This variable is only applicable if the variable 'concurrentprobes' is set in the 'General' section.) Example value: 50% step Duration of the base interval that this probe should use, if different from the one specified in the 'Database' section. 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. (This variable is only applicable if the variable 'concurrentprobes' is set in the 'General' section.) Example value: 300 Supported target-specific variables: extraopts Any extra options specified here will be passed unmodified to echoping(1). Example value: -some-letter-the-author-did-not-think-of ipversion The IP protocol used. Possible values are "4" and "6". Passed to echoping(1) as the "-4" or "-6" options. Example value: 4 pings How many pings should be sent to each target, if different from the global value specified in the Database section. 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. Example value: 5 priority The "-p" echoping(1) option. Example value: 6 timeout The "-t" echoping(1) option. Example value: 1 Default value: 5 tos The "-P" echoping(1) option. Example value: 0xa0 waittime The "-w" echoping(1) option. Example value: 1 AUTHORS
Niko Tyni <ntyni@iki.fi> NOTES
The fill, size and udp EchoPing variables are not valid. SEE ALSO
Smokeping::probes::EchoPing 2.6.8 2013-03-17 Smokeping_probes_EchoPingSmtp(3)