X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdcreate.pod;h=80f397087a9f0403925cb46f4db40a8d571fbf5e;hb=8cceed3785727034f3500e63f37304deaa160ea5;hp=91e63d6341edc96d175aed311dc43a2373d932db;hpb=d828f3eccac8dbad7bfc14812e406377669baaa4;p=rrdtool.git
diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod
index 91e63d6..80f3970 100644
--- a/doc/rrdcreate.pod
+++ b/doc/rrdcreate.pod
@@ -1,8 +1,6 @@
=head1 NAME
-rrdtool create - Set up a new Round Robin Database
-
-=for html
+rrdcreate - Set up a new Round Robin Database
=head1 SYNOPSIS
@@ -10,7 +8,6 @@ B B I
S<[B<--start>|B<-b> I]>
S<[B<--step>|B<-s> I]>
S<[BIB<:>IB<:>I]>
-IB<:>IB<:>I]>
S<[BIB<:>I]>
=head1 DESCRIPTION
@@ -190,24 +187,32 @@ I defines how many generations of data values are kept in an B.
=head1 Aberrant Behavior Detection with Holt-Winters Forecasting
-by Jake Brutlag Ejakeb@corp.webtv.netE
-
In addition to the aggregate functions, there are a set of specialized
functions that enable B to provide data smoothing (via the
Holt-Winters forecasting algorithm), confidence bands, and the flagging
aberrant behavior in the data source time series:
-=over 4
+=over
+
+=item *
+
+BIB<:>IB<:>IB<:>IB<:>IB<:>I
+
+=item *
+
+BIB<:>IB<:>IB<:>I
+
+=item *
-=item BIB<:>IB<:>IB<:>IB<:>IB<:>I
+BIB<:>IB<:>IB<:>I
-=item BIB<:>IB<:>IB<:>I
+=item *
-=item BIB<:>IB<:>IB<:>I
+BIB<:>IB<:>I
-=item BIB<:>IB<:>I
+=item *
-=item BIB<:>IB<:>IB<:>IB<:>I
+BIB<:>IB<:>IB<:>IB<:>I
=back
@@ -258,7 +263,7 @@ they are explicitly created, the creator should verify that all three
I arguments agree.
I is the adaption parameter of the intercept (or baseline)
-coefficient in the Holt-Winters forecasting algorithm. See L for a
+coefficient in the Holt-Winters forecasting algorithm. See L for a
description of this algorithm. I must lie between 0 and 1. A value
closer to 1 means that more recent observations carry greater weight in
predicting the baseline component of the forecast. A value closer to 0 mean
@@ -295,7 +300,7 @@ I argument is the 1-based index in the order of B creation
(that is, the order they appear in the I command). The dependent
B for each B requiring the I argument is listed here:
-=over 4
+=over
=item *
@@ -415,9 +420,12 @@ days on the x axis and one bar for each day).
=head1 EXAMPLE
-C
+ rrdtool create temperature.rrd --step 300 \
+ DS:temp:GAUGE:600:-273:5000 \
+ RRA:AVERAGE:0.5:1:1200 \
+ RRA:MIN:0.5:12:2400 \
+ RRA:MAX:0.5:12:2400 \
+ RRA:AVERAGE:0.5:12:2400
This sets up an B called F which accepts one
temperature value every 300 seconds. If no new data is supplied for
@@ -433,10 +441,10 @@ average temperature, respectively.
=head1 EXAMPLE 2
-C
+ rrdtool create monitor.rrd --step 300 \
+ DS:ifOutOctets:COUNTER:1800:0:4294967295 \
+ RRA:AVERAGE:0.5:1:2016 \
+ RRA:HWPREDICT:1440:0.1:0.0035:288
This example is a monitor of a router interface. The first B tracks the
traffic flow in octets; the second B generates the specialized
@@ -459,25 +467,25 @@ the FAILURES B.
The same RRD file and B are created with the following command, which explicitly
creates all specialized function B.
-C
+ rrdtool create monitor.rrd --step 300 \
+ DS:ifOutOctets:COUNTER:1800:0:4294967295 \
+ RRA:AVERAGE:0.5:1:2016 \
+ RRA:HWPREDICT:1440:0.1:0.0035:288:3 \
+ RRA:SEASONAL:288:0.1:2 \
+ RRA:DEVPREDICT:1440:5 \
+ RRA:DEVSEASONAL:288:0.1:2 \
+ RRA:FAILURES:288:7:9:5
Of course, explicit creation need not replicate implicit create, a number of arguments
could be changed.
=head1 EXAMPLE 3
-C
+ rrdtool create proxy.rrd --step 300 \
+ DS:Total:DERIVE:1800:0:U \
+ DS:Duration:DERIVE:1800:0:U \
+ DS:AvgReqDur:COMPUTE:Duration,Requests,0,EQ,1,Requests,IF,/ \
+ RRA:AVERAGE:0.5:1:2016
This example is monitoring the average request duration during each 300 sec
interval for requests processed by a web proxy during the interval.