.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "..::lib::Smokeping::matchers::Avgratio 3"
.TH ..::lib::Smokeping::matchers::Avgratio 3 2024-02-04 2.8.2 SmokePing
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Smokeping::matchers::Avgratio \- detect changes in average median latency
.SH OVERVIEW
.IX Header "OVERVIEW"
The Avgratio matcher establishes a historic average median latency over
several measurement rounds. It compares this average, against a second
average latency value again build over several rounds of measurement.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Call the matcher with the following sequence:
.PP
.Vb 2
\& type = matcher
\& pattern = Avgratio(historic=>a,current=>b,comparator=>o,percentage=>p)
.Ve
.IP historic 4
.IX Item "historic"
The number of median values to use for building the 'historic' average.
.IP current 4
.IX Item "current"
The number of median values to use for building the 'current' average.
.IP comparator 4
.IX Item "comparator"
Which comparison operator should be used to compare current/historic with percentage.
.IP percentage 4
.IX Item "percentage"
Right hand side of the comparison.
.PP
.Vb 1
\& old <\-\-\- historic \-\-\-><\-\-\- current \-\-\-> now
.Ve
.SH EXAMPLE
.IX Header "EXAMPLE"
Take build the average median latency over 10 samples, use this to divide the
current average latency built over 2 samples and check if it is bigger than
150%.
.PP
.Vb 1
\& Avgratio(historic=>10,current=>2,comparator=>\*(Aq>\*(Aq,percentage=>150);
\&
\& avg(current)/avg(historic) > 150/100
.Ve
.PP
This means the matcher will activate when the current latency average is
more than 1.5 times the historic latency average established over the last
10 rounds of measurement.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2004 by OETIKER+PARTNER AG. All rights reserved.
.SH SPONSORSHIP
.IX Header "SPONSORSHIP"
The development of this matcher has been sponsored by Virtela Communications, .
.SH LICENSE
.IX Header "LICENSE"
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.
.PP
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.
.PP
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.
.SH AUTHOR
.IX Header "AUTHOR"
Tobias Oetiker