Package smokeping

Latency Logging and Graphing System

http://oss.oetiker.ch/smokeping/

SmokePing is a latency logging and graphing system. It consists of a
daemon process which organizes the latency measurements and a CGI
which presents the graphs.

General Commands (Section 1)
smokeping
The smokeping tool is the commandline part of the SmokePing system. Its main function is to run as a daemon and send Pings to all the Targets you have specified...
smokeping_cgi
To get smokeping_cgi going, you need a webserver which allows you to run CGI or better FastCGI scripts. The system must be setup so that the cgi process is...
tSmoke
The tSmoke tool is a commandline tool which interfaces with the SmokePing system. Its main function is to send a message indicating the current status of the...
Library Functions (Section 3)
Smokeping_matchers_Avgratio
detect changes in average median latency
Smokeping_matchers_base
Every matcher must provide the following methods:new The new method expects hash elements as an argument eg new({x=>'\d+',y=>'\d+'},x=>1,y=>2). The first part...
Smokeping_matchers_CheckLatency
Edge triggered alert to check latency is under a value for x number of samples
Smokeping_matchers_CheckLoss
Edge triggered alert to check loss is under a value for x number of samples
Smokeping_matchers_ExpLoss
Match against exponential weighted average of last samples, thus new values are more valuable as old ones. Two thresholds - rising and falling - produce...
Smokeping_matchers_Median
Find persistant changes in latency
Smokeping_matchers_Medratio
detect changes in the latency median
Smokeping_probes_AnotherDNS
Like DNS, but uses Net::DNS and Time::HiRes instead of dig. This probe does *not* retry the request three times before it is considerd "lost", like dig and...
Smokeping_probes_AnotherSSH
Latency measurement using SSH. This generates Logfile messages on the other Host, so get permission from the owner first!
Smokeping_probes_base
For the time being, please use the Smokeping::probes::FPing for inspiration when implementing your own probes.
Smokeping_probes_basefork
Not all pinger programs support testing multiple hosts in a single go like fping(1). If the measurement takes long enough, there may be not enough time perform...
Smokeping_probes_basevars
Provides the method `targets' that returns a list of hashes.
Smokeping_probes_CiscoRTTMonDNS
A probe for smokeping, which uses the ciscoRttMon MIB functionality ("Service Assurance Agent", "SAA") of Cisco IOS to time ( recursive, type A) DNS queries to...
Smokeping_probes_CiscoRTTMonEchoICMP
A probe for smokeping, which uses the ciscoRttMon MIB functionality ("Service Assurance Agent", "SAA") of Cisco IOS to measure ICMP echo ("ping") roundtrip...
Smokeping_probes_CiscoRTTMonTcpConnect
A probe for smokeping, which uses the ciscoRttMon MIB functionality ("Service Assurance Agent", "SAA") of Cisco IOS to measure TCP connect times between a Cisco...
Smokeping_probes_Curl
(see curl(1) for details of the options below)
Smokeping_probes_DismanPing
Uses the DISMAN-PING-MIB to cause a remote system to send probes.
Smokeping_probes_DNS
Integrates dig as a probe into smokeping. The variable binary must point to your copy of the dig program. If it is not installed on your system yet, you should...
Smokeping_probes_EchoPing
See echoping(1) for details of the options below.
Smokeping_probes_EchoPingChargen
Measures TCP chargen (port 19) roundtrip times for SmokePing.
Smokeping_probes_EchoPingDiscard
Measures TCP or UDP discard (port 9) roundtrip times for SmokePing.
Smokeping_probes_EchoPingDNS
Measures DNS roundtrip times for SmokePing with the echoping_dns plugin.
Smokeping_probes_EchoPingHttp
Measures HTTP roundtrip times (web servers and caches) for SmokePing.
Smokeping_probes_EchoPingHttps
As EchoPingHttp(3pm), but SSL-enabled.
Smokeping_probes_EchoPingIcp
Measures ICP (Internet Cache Protocol, spoken by web caches) roundtrip times for SmokePing.
Smokeping_probes_EchoPingLDAP
Measures LDAP roundtrip times for SmokePing with the echoping_ldap plugin.
Smokeping_probes_EchoPingPlugin
Measures roundtrip times for SmokePing with an echoping(1) plugin. The plugins currently shipped with echoping are implemented as separate probes based on this...
Smokeping_probes_EchoPingSmtp
Measures SMTP roundtrip times (mail servers) for SmokePing.
Smokeping_probes_EchoPingWhois
Measures whois roundtrip times for SmokePing with the echoping_whois plugin.
Smokeping_probes_FPing
Integrates FPing as a probe into smokeping. The variable binary must point to your copy of the FPing program. If it is not installed on your system yet, you can...
Smokeping_probes_FPing6
Integrates FPing6 as a probe into smokeping. This probe is derived from FPing; the only difference is that the target host used for checking the fping command...
Smokeping_probes_FTPtransfer
The probe uses the Net::FTP perl client to run performance tests using an FTP server as a target. This probe is intrusive as it transfers real data. By using...
Smokeping_probes_IOSPing
Integrates Cisco IOS as a probe into smokeping. Uses the rsh / remsh protocol to run a ping from an IOS device.
Smokeping_probes_LDAP
This probe measures LDAP query latency for SmokePing. The query is specified by the target-specific variable `filter' and, optionally, by the target-specific...
Smokeping_probes_NFSping
Integrates NFSping as a probe into smokeping. The variable binary must point to your copy of the NFSping program. NFSping can be downloaded from...
Smokeping_probes_OpenSSHEOSPing
Connect to Arista EOS via OpenSSH to run ping commands. This probe uses the "ping" cli of the Arista EOS. You have the option to specify which interface the...
Smokeping_probes_OpenSSHJunOSPing
Connect to Juniper JunOS via OpenSSH to run ping commands. This probe uses the "extended ping" of the Juniper JunOS. You have the option to specify which...
Smokeping_probes_passwordchecker
synopsis with more detail SmokePing main configuration file:Actual description In implementing authentication probes, it might not be desirable to store the...
Smokeping_probes_Qstat
Integrates Qstat as a probe into smokeping. The variable binary must point to your copy of the Qstat program. Make sure to set your pings to 10, most Quake...
Smokeping_probes_Radius
This probe measures RADIUS (RFC 2865) authentication latency for SmokePing. The username to be tested is specified in either the probe-specific or the...
Smokeping_probes_RemoteFPing
Integrates the remote execution of FPing via ssh/rsh into smokeping. The variable binary must point to your copy of the ssh/rsh program. The variable rbinary...
Smokeping_probes_SendEmail
This probe actually send a mail to a MX server and measure time it took. You can choose the sender and recipient adress as well as the size of the mail.
Smokeping_probes_SipSak
The probe uses the sipsak <http://sipsak.org/> tool to measure sip server latency by sending an OPTIONS message. The sipsak command supports a large number of...
Smokeping_probes_skel
This is a non-functional module that is intended to act as a basis for creation of new probes. See the smokeping_extend document for more information.
Smokeping_probes_SSH
Integrates ssh-keyscan as a probe into smokeping. The variable binary must point to your copy of the ssh-keyscan program. If it is not installed on your system...
Smokeping_probes_TacacsPlus
This probe measures TacacsPlus authentication latency for SmokePing. The username to be tested is specified in either the probe-specific or the target-specific...
Smokeping_probes_TCPPing
Integrates TCPPing as a probe into smokeping. The variable binary must point to your copy of the TCPPing program. If it is not installed on your system yet, you...
Smokeping_probes_TelnetIOSPing
Integrates Cisco IOS as a probe into smokeping. Uses the telnet protocol to run a ping from an IOS device (source) to another device (host). This probe...
Smokeping_probes_TelnetJunOSPing
Integrates Juniper JunOS as a probe into smokeping. Uses the telnet protocol to run a ping from an JunOS device (source) to another device (host). This probe...
Smokeping_probes_WebProxyFilter
The probe uses the LWP::UserAgent module to retreive a series of wepages. It expects to get the firewalls 'site-prohibited' page. Any other response (or a real...
Smokeping_sorters_base
Every sorter must provide the following methods:new The new method expects hash elements as an argument eg new({x=>'\d+',y=>'\d+'},x=>1,y=>2). The first part is...
Smokeping_sorters_Loss
Call the sorter in the charts section of the config file
Smokeping_sorters_Max
Call the sorter in the charts section of the config file
Smokeping_sorters_Median
Call the sorter in the charts section of the config file
Smokeping_sorters_StdDev
Call the sorter in the charts section of the config file
File Formats (Section 5)
smokeping_config
SmokePing takes its configuration from a single central configuration file. Its location must be hardcoded in the smokeping script and smokeping.cgi. The...
smokeping_examples
Currently the examples differ only in the "Probes" and "Targets" sections. The other sections are taken from the "etc/config.dist" configuration template in the...
Miscellanea (Section 7)
smokeping_extend
This document is intended to guide prospective authors in writing new Smokeping probes. It mostly describes the interface between Smokeping and its probe...
smokeping_install
Prerequisites SmokePing does not stand alone. It relies on various other tools and services being present. Apart from a Unix OS and a working Perl installation...
smokeping_master_slave
Architecture The slaves communicate with the master smokeping server via the normal smokeping web interface. On initial startup each slave connects to the...
smokeping_upgrade
This document tries to list incompatible or otherwise user-visible changes in Smokeping versions, with instructions on how to fix any possible problems. It also...