mirror of
https://github.com/ntop/ntopng.git
synced 2026-07-28 17:20:38 +00:00
252 lines
9.9 KiB
HTML
252 lines
9.9 KiB
HTML
<?xml version="1.0" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>rrdgraph_examples</title>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<link rev="made" href="mailto:root@localhost" />
|
|
</head>
|
|
|
|
<body style="background-color: white">
|
|
|
|
|
|
<!-- INDEX BEGIN -->
|
|
<div name="index">
|
|
<p><a name="__index__"></a></p>
|
|
<!--
|
|
|
|
<ul>
|
|
|
|
<li><a href="#name">NAME</a></li>
|
|
<li><a href="#synopsis">SYNOPSIS</a></li>
|
|
<li><a href="#description">DESCRIPTION</a></li>
|
|
<li><a href="#examples">EXAMPLES</a></li>
|
|
<ul>
|
|
|
|
<li><a href="#data_with_multiple_resolutions">Data with multiple resolutions</a></li>
|
|
<li><a href="#nicely_formatted_legend_section">Nicely formatted legend section</a></li>
|
|
<li><a href="#offsetting_a_line_on_the_y_axis">Offsetting a line on the y-axis</a></li>
|
|
<li><a href="#drawing_dashed_lines">Drawing dashed lines</a></li>
|
|
<li><a href="#time_ranges">Time ranges</a></li>
|
|
<li><a href="#viewing_the_current_and_previous_week_together">Viewing the current and previous week together</a></li>
|
|
<li><a href="#aberrant_behaviour_detection">Aberrant Behaviour Detection</a></li>
|
|
<ul>
|
|
|
|
<li><a href="#a_note_on_data_reduction_">A note on data reduction:</a></li>
|
|
</ul>
|
|
|
|
</ul>
|
|
|
|
<li><a href="#see_also">SEE ALSO</a></li>
|
|
<li><a href="#author">AUTHOR</a></li>
|
|
</ul>
|
|
|
|
-->
|
|
|
|
|
|
</div>
|
|
<!-- INDEX END -->
|
|
|
|
<p>
|
|
</p>
|
|
<h1><a name="name">NAME</a></h1>
|
|
<p>rrdgraph_examples - Examples for rrdtool graph</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="synopsis">SYNOPSIS</a></h1>
|
|
<p><strong>rrdtool graph /home/httpd/html/test.png --img-format PNG</strong></p>
|
|
<p>followed by any of the examples below</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="description">DESCRIPTION</a></h1>
|
|
<p>For your convenience some of the commands are explained here
|
|
by using detailed examples. They are not always cut-and-paste
|
|
ready because comments are intermixed with the examples.</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="examples">EXAMPLES</a></h1>
|
|
<p>
|
|
</p>
|
|
<h2><a name="data_with_multiple_resolutions">Data with multiple resolutions</a></h2>
|
|
<pre>
|
|
--end now --start end-120000s --width 400
|
|
DEF:ds0a=/home/rrdtool/data/router1.rrd:ds0:AVERAGE
|
|
DEF:ds0b=/home/rrdtool/data/router1.rrd:ds0:AVERAGE:step=1800
|
|
DEF:ds0c=/home/rrdtool/data/router1.rrd:ds0:AVERAGE:step=7200
|
|
LINE1:ds0a#0000FF:"default resolution\l"
|
|
LINE1:ds0b#00CCFF:"resolution 1800 seconds per interval\l"
|
|
LINE1:ds0c#FF00FF:"resolution 7200 seconds per interval\l"</pre>
|
|
<p>
|
|
</p>
|
|
<h2><a name="nicely_formatted_legend_section">Nicely formatted legend section</a></h2>
|
|
<pre>
|
|
DEF:ds0=/home/rrdtool/data/router1.rrd:ds0:AVERAGE
|
|
DEF:ds1=/home/rrdtool/data/router1.rrd:ds1:AVERAGE
|
|
VDEF:ds0max=ds0,MAXIMUM
|
|
VDEF:ds0avg=ds0,AVERAGE
|
|
VDEF:ds0min=ds0,MINIMUM
|
|
VDEF:ds0pct=ds0,95,PERCENT
|
|
VDEF:ds1max=ds1,MAXIMUM
|
|
VDEF:ds1avg=ds1,AVERAGE
|
|
VDEF:ds1min=ds1,MINIMUM
|
|
VDEF:ds1pct=ds1,95,PERCENT</pre>
|
|
<p>Note: consolidation occurs here.</p>
|
|
<pre>
|
|
CDEF:ds0bits=ds0,8,*
|
|
CDEF:ds1bits=ds1,8,*</pre>
|
|
<p>Note: 10 spaces to move text to the right</p>
|
|
<pre>
|
|
COMMENT:" "</pre>
|
|
<p>Note: the column titles have to be as wide as the columns</p>
|
|
<pre>
|
|
COMMENT:"Maximum "
|
|
COMMENT:"Average "
|
|
COMMENT:"Minimum "</pre>
|
|
<pre>
|
|
COMMENT:"95th percentile\l"
|
|
AREA:ds0bits#00C000:"Inbound "
|
|
GPRINT:ds0max:"%6.2lf %Sbps"
|
|
GPRINT:ds0avg:"%6.2lf %Sbps"
|
|
GPRINT:ds0min:"%6.2lf %Sbps"
|
|
GPRINT:ds0pct:"%6.2lf %Sbps\l"
|
|
LINE1:ds1bits#0000FF:"Outbound"
|
|
GPRINT:ds1max:"%6.2lf %Sbps"
|
|
GPRINT:ds1avg:"%6.2lf %Sbps"
|
|
GPRINT:ds1min:"%6.2lf %Sbps"
|
|
GPRINT:ds1pct:"%6.2lf %Sbps\l"</pre>
|
|
<p>
|
|
</p>
|
|
<h2><a name="offsetting_a_line_on_the_y_axis">Offsetting a line on the y-axis</a></h2>
|
|
<p>Depending on your needs you can do this in two ways:</p>
|
|
<ul>
|
|
<li>
|
|
<p>Offset the data, then graph this</p>
|
|
<pre>
|
|
DEF:mydata=my.rrd:ds:AVERAGE</pre>
|
|
<p>Note: this will also influence any other command that uses "data"</p>
|
|
<pre>
|
|
CDEF:data=mydata,100,+
|
|
LINE1:data#FF0000:"Data with offset"</pre>
|
|
</li>
|
|
<li>
|
|
<p>Graph the original data, with an offset</p>
|
|
<pre>
|
|
DEF:mydata=my.rrd:ds:AVERAGE</pre>
|
|
<p>Note: no color in the first line so it is not visible</p>
|
|
<pre>
|
|
LINE1:100</pre>
|
|
<p>Note: the second line gets stacked on top of the first one</p>
|
|
<pre>
|
|
LINE1:data#FF0000:"Data with offset":STACK</pre>
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
</p>
|
|
<h2><a name="drawing_dashed_lines">Drawing dashed lines</a></h2>
|
|
<p>Also works for HRULE and VRULE</p>
|
|
<ul>
|
|
<li>
|
|
<p>default style: - - - - -
|
|
LINE1:data#FF0000:"dashed line":dashes</p>
|
|
</li>
|
|
<li>
|
|
<p>more fancy style with offset: - - --- - --- -
|
|
LINE1:data#FF0000:"another dashed line":dashes=15,5,5,10:dash-offset=10</p>
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
</p>
|
|
<h2><a name="time_ranges">Time ranges</a></h2>
|
|
<pre>
|
|
Last four weeks: --start end-4w --end 00:00
|
|
January 2001: --start 20010101 --end start+31d
|
|
January 2001: --start 20010101 --end 20010201
|
|
Last hour: --start end-1h
|
|
Last 24 hours: <nothing at all>
|
|
Yesterday: --end 00:00</pre>
|
|
<p>
|
|
</p>
|
|
<h2><a name="viewing_the_current_and_previous_week_together">Viewing the current and previous week together</a></h2>
|
|
<pre>
|
|
--end now --start end-1w
|
|
DEF:thisweek=router.rrd:ds0:AVERAGE
|
|
DEF:lastweek=router.rrd:ds0:AVERAGE:end=now-1w:start=end-1w</pre>
|
|
<p>Shift the data forward by one week (604800 seconds)</p>
|
|
<pre>
|
|
SHIFT:lastweek:604800
|
|
[ more of the usual VDEF and CDEF stuff if you like ]
|
|
AREA:lastweek#0000FF:Last\ week
|
|
LINE1:thisweek#FF0000:This\ week</pre>
|
|
<p>
|
|
</p>
|
|
<h2><a name="aberrant_behaviour_detection">Aberrant Behaviour Detection</a></h2>
|
|
<p>If the specialized function <strong>RRAs</strong> exist for aberrant behavior detection, they
|
|
can be used to generate the graph of a time series with confidence bands and
|
|
failures.</p>
|
|
<pre>
|
|
rrdtool graph example.png \
|
|
DEF:obs=monitor.rrd:ifOutOctets:AVERAGE \
|
|
DEF:pred=monitor.rrd:ifOutOctets:HWPREDICT \
|
|
DEF:dev=monitor.rrd:ifOutOctets:DEVPREDICT \
|
|
DEF:fail=monitor.rrd:ifOutOctets:FAILURES \
|
|
TICK:fail#ffffa0:1.0:"Failures\: Average bits out" \
|
|
CDEF:scaledobs=obs,8,* \
|
|
CDEF:upper=pred,dev,2,*,+ \
|
|
CDEF:lower=pred,dev,2,*,- \
|
|
CDEF:scaledupper=upper,8,* \
|
|
CDEF:scaledlower=lower,8,* \
|
|
LINE2:scaledobs#0000ff:"Average bits out" \
|
|
LINE1:scaledupper#ff0000:"Upper Confidence Bound: Average bits out" \
|
|
LINE1:scaledlower#ff0000:"Lower Confidence Bound: Average bits out"</pre>
|
|
<p>This example generates a graph of the data series in blue (LINE2 with the scaledobs
|
|
virtual data source), confidence bounds in red (scaledupper and scaledlower virtual
|
|
data sources), and potential failures (i.e. potential aberrant aberrant behavior)
|
|
marked by vertical yellow lines (the fail data source).</p>
|
|
<p>The raw data comes from an AVERAGE <strong>RRA</strong>, the finest resolution of the observed
|
|
time series (one consolidated data point per primary data point). The predicted
|
|
(or smoothed) values are stored in the HWPREDICT <strong>RRA</strong>. The predicted deviations
|
|
(think standard deviation) values are stored in the DEVPREDICT <strong>RRA</strong>. Finally,
|
|
the FAILURES <strong>RRA</strong> contains indicators, with 1 denoting a potential failure.</p>
|
|
<p>All of the data is rescaled to bits (instead of Octets) by multiplying by 8.
|
|
The confidence bounds are computed by an offset of 2 deviations both above
|
|
and below the predicted values (the CDEFs upper and lower). Vertical lines
|
|
indicated potential failures are graphed via the TICK graph element, which
|
|
converts non-zero values in an <strong>RRA</strong> into tick marks. Here an axis-fraction
|
|
argument of 1.0 means the tick marks span the entire y-axis, and hence become
|
|
vertical lines on the graph.</p>
|
|
<p>The choice of 2 deviations (a scaling factor) matches the default used internally
|
|
by the FAILURES <strong>RRA</strong>. If the internal value is changed (see <a href="././rrdtune.html">the rrdtune manpage</a>), this
|
|
graphing command should be changed to be consistent.</p>
|
|
<p>
|
|
</p>
|
|
<h3><a name="a_note_on_data_reduction_">A note on data reduction:</a></h3>
|
|
<p>The <strong>rrdtool</strong> <em>graph</em> command is designed to plot data at a specified temporal
|
|
resolution, regardless of the actually resolution of the data in the RRD file.
|
|
This can present a problem for the specialized consolidation functions which
|
|
maintain a one-to-one mapping between primary data points and consolidated
|
|
data points. If a graph insists on viewing the contents of these <strong>RRAs</strong> on a
|
|
coarser temporal scale, the <em>graph</em> command tries to do something intelligent,
|
|
but the confidence bands and failures no longer have the same meaning and may
|
|
be misleading.</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="see_also">SEE ALSO</a></h1>
|
|
<p><a href="././rrdgraph.html">the rrdgraph manpage</a> gives an overview of how <strong>rrdtool graph</strong> works.
|
|
<a href="././rrdgraph_data.html">the rrdgraph_data manpage</a> describes <strong>DEF</strong>,<strong>CDEF</strong> and <strong>VDEF</strong> in detail.
|
|
<a href="././rrdgraph_rpn.html">the rrdgraph_rpn manpage</a> describes the <strong>RPN</strong> language used in the <strong>xDEF</strong> statements.
|
|
<a href="././rrdgraph_graph.html">the rrdgraph_graph manpage</a> page describes all the graph and print functions.</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="author">AUTHOR</a></h1>
|
|
<p>Program by Tobias Oetiker <<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>></p>
|
|
<p>This manual page by Alex van den Bogaerdt <<a href="mailto:alex@vandenbogaerdt.nl">alex@vandenbogaerdt.nl</a>>
|
|
with corrections and/or additions by several people</p>
|
|
|
|
</body>
|
|
|
|
</html>
|