← Back to branch summary

~ubuntu-branches/debian/lenny/smokeping/lenny

« back to all changes in this revision

Viewing changes to doc/matchers/avgratio.pm.html

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2006-10-26 21:45:56 UTC
  • mfrom: (1.2.2 upstream) (2.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061026214556-5jnpiesx4vdijmu6
http://bugs.debian.org/395056
* debian/patches/15_clean_makefile.dpatch:
  + remove unneeded and potentially unsecure include paths.
* debian/patches: selected patches from the upstream SVN repository
  + 40_password.dpatch: skip reading the password file when running as a CGI.
  + 50_ldap.dpatch: Make the 'scope' option in the LDAP probe actually work.
  + 60_fping.dpatch:
    * Support the '-S' (set source address, see #198486) fping option.
    * Don't try to execute fping when running as a CGI.
  + 70_syslog.dpatch: Don't die silently if syslogd is unavailable.
    (Closes: #395056)
* Remove all the autogenerated documentation at clean time, to properly
  undo the effects of the 'build' target.
* Install example configuration files for documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/matchers/avgratio.pm.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
 
<html xmlns="http://www.w3.org/1999/xhtml">
3
 
<head>
4
 
<title>matchers/avgratio.pm</title>
5
 
<link rev="made" href="mailto:dws@ee.ethz.ch" />
6
 
</head>
7
 
 
8
 
<body style="background-color: white">
9
 
 
10
 
<p><a name="__index__"></a></p>
11
 
<!-- INDEX BEGIN -->
12
 
<!--
13
 
 
14
 
<ul>
15
 
 
16
 
        <li><a href="#name">NAME</a></li>
17
 
        <li><a href="#overview">OVERVIEW</a></li>
18
 
        <li><a href="#description">DESCRIPTION</a></li>
19
 
        <li><a href="#example">EXAMPLE</a></li>
20
 
        <li><a href="#copyright">COPYRIGHT</a></li>
21
 
        <li><a href="#sponsorship">SPONSORSHIP</a></li>
22
 
        <li><a href="#license">LICENSE</a></li>
23
 
        <li><a href="#author">AUTHOR</a></li>
24
 
</ul>
25
 
-->
26
 
<!-- INDEX END -->
27
 
 
28
 
<p>
29
 
</p>
30
 
<h1><a name="name">NAME</a></h1>
31
 
<p>matchers::avgratio - detect changes in average median latency</p>
32
 
<p>
33
 
</p>
34
 
<hr />
35
 
<h1><a name="overview">OVERVIEW</a></h1>
36
 
<pre>
37
 
 
38
 
The avgratio matcher establishes a historic average median latency over
39
 
several measurement rounds. It compares this average, against a second
40
 
average latency value again build over several rounds of measurment.</pre>
41
 
<p>
42
 
</p>
43
 
<hr />
44
 
<h1><a name="description">DESCRIPTION</a></h1>
45
 
<p>Call the matcher with the following sequence:</p>
46
 
<pre>
47
 
 type = matcher
48
 
 pattern =  avgratio(historic=&gt;a,current=&gt;b,comparator=&gt;o,percentage=&gt;p)</pre>
49
 
<dl>
50
 
<dt><strong><a name="item_historic">historic</a></strong><br />
51
 
</dt>
52
 
<dd>
53
 
The number of median values to use for building the 'historic' average.
54
 
</dd>
55
 
<p></p>
56
 
<dt><strong><a name="item_current">current</a></strong><br />
57
 
</dt>
58
 
<dd>
59
 
The number of median values to use for building the 'current' average.
60
 
</dd>
61
 
<p></p>
62
 
<dt><strong><a name="item_comparator">comparator</a></strong><br />
63
 
</dt>
64
 
<dd>
65
 
Which comparison operator should be used to compare current/historic with percentage.
66
 
</dd>
67
 
<p></p>
68
 
<dt><strong><a name="item_percentage">percentage</a></strong><br />
69
 
</dt>
70
 
<dd>
71
 
Right hand side of the comparison.
72
 
</dd>
73
 
<p></p></dl>
74
 
<pre>
75
 
  old &lt;--- historic ---&gt;&lt;--- current ---&gt; now</pre>
76
 
<p>
77
 
</p>
78
 
<hr />
79
 
<h1><a name="example">EXAMPLE</a></h1>
80
 
<p>Take build the average median latency over 10 samples, use this to divid the
81
 
current average latency built over 2 samples and check if it is bigger than
82
 
150%.</p>
83
 
<pre>
84
 
 avgratio(historic=&gt;10,current=&gt;2,comparator=&gt;'&gt;',percentage=&gt;150);</pre>
85
 
<pre>
86
 
 avg(current)/avg(historic) &gt; 150/100</pre>
87
 
<p>This means the matcher will activate when the current latency average if
88
 
more than 1.5 times the historic latency average established over the last
89
 
10 rounds of measurement.</p>
90
 
<p>
91
 
</p>
92
 
<hr />
93
 
<h1><a name="copyright">COPYRIGHT</a></h1>
94
 
<p>Copyright (c) 2004 by OETIKER+PARTNER AG. All rights reserved.</p>
95
 
<p>
96
 
</p>
97
 
<hr />
98
 
<h1><a name="sponsorship">SPONSORSHIP</a></h1>
99
 
<p>The development of this matcher has been sponsored by Virtela Communications www.virtela.net.</p>
100
 
<p>
101
 
</p>
102
 
<hr />
103
 
<h1><a name="license">LICENSE</a></h1>
104
 
<p>This program is free software; you can redistribute it and/or modify
105
 
it under the terms of the GNU General Public License as published by
106
 
the Free Software Foundation; either version 2 of the License, or
107
 
(at your option) any later version.</p>
108
 
<p>This program is distributed in the hope that it will be useful,
109
 
but WITHOUT ANY WARRANTY; without even the implied warranty of
110
 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
111
 
GNU General Public License for more details.</p>
112
 
<p>You should have received a copy of the GNU General Public License
113
 
along with this program; if not, write to the Free Software
114
 
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
115
 
<p>
116
 
</p>
117
 
<hr />
118
 
<h1><a name="author">AUTHOR</a></h1>
119
 
<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
120
 
 
121
 
</body>
122
 
 
123
 
</html>