X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdcreate.pod;h=27ef702afd5097ca94e08e13c2b49cb01c3d0559;hb=127fb65e9cdbf2343344d1e9c1af9874cae8113e;hp=5c445621ab8844066e29bc53783b894c251a5a5a;hpb=7f4b880d9d5c7a48e273f52e8dfa54fae39006e3;p=rrdtool.git diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod index 5c44562..27ef702 100644 --- a/doc/rrdcreate.pod +++ b/doc/rrdcreate.pod @@ -4,9 +4,9 @@ rrdcreate - Set up a new Round Robin Database =head1 SYNOPSIS -B B I -S<[B<--start>|B<-b> I]> -S<[B<--step>|B<-s> I]> +B B I +S<[B<--start>|B<-b> I]> +S<[B<--step>|B<-s> I]> S<[BIB<:>IB<:>I]> S<[BIB<:>I]> @@ -65,7 +65,7 @@ for further insight. =over 4 -=item B +=item B is for things like temperatures or number of people in a room or the value of a RedHat share. @@ -112,7 +112,7 @@ wrap. =back -=item B +=item B is for counters which get reset upon reading. This is used for fast counters which tend to overflow. So instead of reading them normally you reset them @@ -134,16 +134,15 @@ to as "virtual" or "computed" columns. =back I defines the maximum number of seconds that may pass -between two updates of this data source before the value of the +between two updates of this data source before the value of the data source is assumed to be I<*UNKNOWN*>. -I and I are optional entries defining the expected range of -the data supplied by this data source. If I and/or I are -defined, any value outside the defined range will be regarded as -I<*UNKNOWN*>. If you do not know or care about min and max, set them -to U for unknown. Note that min and max always refer to the processed -values of the DS. For a traffic-B type DS this would be the -maximum and minimum data-rate expected from the device. +I and I define the expected range values for data supplied by a +data source. If I and/or I any value outside the defined range +will be regarded as I<*UNKNOWN*>. If you do not know or care about min and +max, set them to U for unknown. Note that min and max always refer to the +processed values of the DS. For a traffic-B type DS this would be +the maximum and minimum data-rate expected from the device. Is previously defined in the same graph command. The purpose of an B is to store data in the round robin archives -(B). An archive consists of a number of data values or statistics for +(B). An archive consists of a number of data values or statistics for each of the defined data-sources (B) and is defined with an B line. When data is entered into an B, it is first fit into time slots @@ -181,7 +180,9 @@ BIB<:>IB<:>IB<:>I I The xfiles factor defines what part of a consolidation interval may be made up from I<*UNKNOWN*> data while the consolidated value is still -regarded as known. +regarded as known. It is given as the ratio of allowed I<*UNKNOWN*> PDPs +to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive). + I defines how many of these I are used to build a I which then goes into the archive. @@ -201,7 +202,7 @@ flagging aberrant behavior in the data source time series: =item * -BIB<:>IB<:>IB<:>IB<:>IB<:>I +BIB<:>IB<:>IB<:>IB<:>I[B<:>I] =item * @@ -312,11 +313,11 @@ requiring the I argument is listed here: HWPREDICT I is the index of the SEASONAL B. -=item * +=item * SEASONAL I is the index of the HWPREDICT B. -=item * +=item * DEVPREDICT I is the index of the DEVSEASONAL B. @@ -324,7 +325,7 @@ DEVPREDICT I is the index of the DEVSEASONAL B. DEVSEASONAL I is the index of the HWPREDICT B. -=item * +=item * FAILURES I is the index of the DEVSEASONAL B. @@ -379,6 +380,44 @@ sample. An extreme example of this might be a "step" of 5 minutes and a result in all the PDPs for that entire day period being set to the same average rate. I<-- Don Baarda Edon.baarda@baesystems.comE> + time| + axis| + begin__|00| + |01| + u|02|----* sample1, restart "hb"-timer + u|03| / + u|04| / + u|05| / + u|06|/ "hbt" expired + u|07| + |08|----* sample2, restart "hb" + |09| / + |10| / + u|11|----* sample3, restart "hb" + u|12| / + u|13| / + step1_u|14| / + u|15|/ "swt" expired + u|16| + |17|----* sample4, restart "hb", create "pdp" for step1 = + |18| / = unknown due to 10 "u" labled secs > "hb" + |19| / + |20| / + |21|----* sample5, restart "hb" + |22| / + |23| / + |24|----* sample6, restart "hb" + |25| / + |26| / + |27|----* sample7, restart "hb" + step2__|28| / + |22| / + |23|----* sample8, restart "hb", create "pdp" for step1, create "cdp" + |24| / + |25| / + +graphics by I. + =head1 HOW TO MEASURE @@ -448,10 +487,10 @@ average temperature, respectively. =head1 EXAMPLE 2 - rrdtool create monitor.rrd --step 300 \ - DS:ifOutOctets:COUNTER:1800:0:4294967295 \ + 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 + 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 @@ -474,27 +513,27 @@ the FAILURES B. The same RRD file and B are created with the following command, which explicitly creates all specialized function B. - 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 + 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 - 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 + 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 +This example is monitoring the average request duration during each 300 sec interval for requests processed by a web proxy during the interval. In this case, the proxy exposes two counters, the number of requests processed since boot and the total cumulative duration of all processed @@ -511,4 +550,4 @@ RPN expression handles the divide by zero case. =head1 AUTHOR -Tobias Oetiker Eoetiker@ee.ethz.chE +Tobias Oetiker Etobi@oetiker.chE