X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph_examples.pod;h=35301932a75e0d5be8a75735923ff468879bd505;hp=fbe2f16edaa0f4f10145c2a0f3364bcb3e8fce86;hb=ab6ae7ac6535c3181885ae50ab569fd24e34300e;hpb=342b22c3e74a10d7049285c2cea7383676bcfc95 diff --git a/doc/rrdgraph_examples.pod b/doc/rrdgraph_examples.pod index fbe2f16..3530193 100644 --- a/doc/rrdgraph_examples.pod +++ b/doc/rrdgraph_examples.pod @@ -4,7 +4,7 @@ rrdgraph_examples - Examples for rrdtool graph =head1 SYNOPSIS -B +B followed by any of the examples below @@ -22,9 +22,9 @@ ready because comments are intermixed with the examples. 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\n" - LINE1:ds0b#00CCFF:"resolution 1800 seconds per interval\n" - LINE1:ds0c#FF00FF:"resolution 7200 seconds per interval\n" + LINE1:ds0a#0000FF:"default resolution\l" + LINE1:ds0b#00CCFF:"resolution 1800 seconds per interval\l" + LINE1:ds0c#FF00FF:"resolution 7200 seconds per interval\l" =head2 Nicely formatted legend section @@ -54,25 +54,23 @@ Note: the column titles have to be as wide as the columns COMMENT:"Average " COMMENT:"Minimum " -Note: some lines contains the new-line character "\n" - - COMMENT:"95th percentile\n" + 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\n" + 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\n" + GPRINT:ds1pct:"%6.2lf %Sbps\l" =head2 Offsetting a line on the y-axis Depending on your needs you can do this in two ways: -=over 4 +=over =item * @@ -101,6 +99,22 @@ Note: the second line gets stacked on top of the first one =back +=head2 Drawing dashed lines + +Also works for HRULE and VRULE + +=over + +=item * + +default style: - - - - - + LINE1:data#FF0000:"dashed line":DASHED + +=item * + +more fancy style with offset: - - --- - --- - + LINE1:data#FF0000:"another dashed line":DASHED:dashes=15,5,5,10:dash-offset=10 + =head2 Time ranges Last four weeks: --start end-4w --end 00:00 @@ -123,11 +137,67 @@ Shift the data forward by one week (604800 seconds) AREA:lastweek#0000FF:Last\ week LINE1:thisweek#FF0000:This\ week +=head2 Aberrant Behaviour Detection + +If the specialized function B exist for aberrant behavior detection, they +can be used to generate the graph of a time series with confidence bands and +failures. + + 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" + +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). + +The raw data comes from an AVERAGE B, 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 B. The predicted deviations +(think standard deviation) values are stored in the DEVPREDICT B. Finally, +the FAILURES B contains indicators, with 1 denoting a potential failure. + +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 B 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. + +The choice of 2 deviations (a scaling factor) matches the default used internally +by the FAILURES B. If the internal value is changed (see L), this +graphing command should be changed to be consistent. + +=head3 A note on data reduction: + +The B I 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 B on a +coarser temporal scale, the I command tries to do something intelligent, +but the confidence bands and failures no longer have the same meaning and may +be misleading. + + =head1 SEE ALSO L gives an overview of how B works. L describes B,B and B in detail. -L describes the B language used in the B statements. +L describes the B language used in the B statements. L page describes all the graph and print functions. Make sure to read L for tipsEtricks.