doc/rrdcreate.txt

   1 RRDCREATE(1)                        rrdtool                       RRDCREATE(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        rrdcreate - Set up a new Round Robin Database
   7
   8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   9        r\brr\brd\bdt\bto\boo\bol\bl c\bcr\bre\bea\bat\bte\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [-\b--\b-s\bst\bta\bar\brt\bt|-\b-b\bb _\bs_\bt_\ba_\br_\bt _\bt_\bi_\bm_\be] [-\b--\b-s\bst\bte\bep\bp|-\b-s\bs _\bs_\bt_\be_\bp]
  10        [-\b--\b-n\bno\bo-\b-o\bov\bve\ber\brw\bwr\bri\bit\bte\be] [D\bDS\bS:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bD_\bS_\bT:\b:_\bd_\bs_\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs] [R\bRR\bRA\bA:\b:_\bC_\bF:\b:_\bc_\bf _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs]
  11
  12 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  13        The create function of RRDtool lets you set up new Round Robin Database
  14        (R\bRR\bRD\bD) files.  The file is created at its final, full size and filled
  15        with _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data.
  16
  17    _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
  18        The name of the R\bRR\bRD\bD you want to create. R\bRR\bRD\bD files should end with the
  19        extension _\b._\br_\br_\bd. However, R\bRR\bRD\bDt\bto\boo\bol\bl will accept any filename.
  20
  21    -\b--\b-s\bst\bta\bar\brt\bt|\b|-\b-b\bb _\bs_\bt_\ba_\br_\bt _\bt_\bi_\bm_\be (\b(d\bde\bef\bfa\bau\bul\blt\bt:\b: n\bno\bow\bw -\b- 1\b10\b0s\bs)\b)
  22        Specifies the time in seconds since 1970-01-01 UTC when the first value
  23        should be added to the R\bRR\bRD\bD. R\bRR\bRD\bDt\bto\boo\bol\bl will not accept any data timed
  24        before or at the time specified.
  25
  26        See also AT-STYLE TIME SPECIFICATION section in the _\br_\br_\bd_\bf_\be_\bt_\bc_\bh
  27        documentation for other ways to specify time.
  28
  29    -\b--\b-s\bst\bte\bep\bp|\b|-\b-s\bs _\bs_\bt_\be_\bp (\b(d\bde\bef\bfa\bau\bul\blt\bt:\b: 3\b30\b00\b0 s\bse\bec\bco\bon\bnd\bds\bs)\b)
  30        Specifies the base interval in seconds with which data will be fed into
  31        the R\bRR\bRD\bD.
  32
  33    -\b--\b-n\bno\bo-\b-o\bov\bve\ber\brw\bwr\bri\bit\bte\be
  34        Do not clobber an existing file of the same name.
  35
  36    D\bDS\bS:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bD_\bS_\bT:\b:_\bd_\bs_\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs
  37        A single R\bRR\bRD\bD can accept input from several data sources (D\bDS\bS), for
  38        example incoming and outgoing traffic on a specific communication line.
  39        With the D\bDS\bS configuration option you must define some basic properties
  40        of each data source you want to store in the R\bRR\bRD\bD.
  41
  42        _\bd_\bs_\b-_\bn_\ba_\bm_\be is the name you will use to reference this particular data
  43        source from an R\bRR\bRD\bD. A _\bd_\bs_\b-_\bn_\ba_\bm_\be must be 1 to 19 characters long in the
  44        characters [a-zA-Z0-9_].
  45
  46        _\bD_\bS_\bT defines the Data Source Type. The remaining arguments of a data
  47        source entry depend on the data source type. For GAUGE, COUNTER,
  48        DERIVE, and ABSOLUTE the format for a data source entry is:
  49
  50        D\bDS\bS:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bG_\bA_\bU_\bG_\bE _\b| _\bC_\bO_\bU_\bN_\bT_\bE_\bR _\b| _\bD_\bE_\bR_\bI_\bV_\bE _\b| _\bA_\bB_\bS_\bO_\bL_\bU_\bT_\bE:\b:_\bh_\be_\ba_\br_\bt_\bb_\be_\ba_\bt:\b:_\bm_\bi_\bn:\b:_\bm_\ba_\bx
  51
  52        For COMPUTE data sources, the format is:
  53
  54        D\bDS\bS:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bC_\bO_\bM_\bP_\bU_\bT_\bE:\b:_\br_\bp_\bn_\b-_\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
  55
  56        In order to decide which data source type to use, review the
  57        definitions that follow. Also consult the section on "HOW TO MEASURE"
  58        for further insight.
  59
  60        G\bGA\bAU\bUG\bGE\bE
  61            is for things like temperatures or number of people in a room or
  62            the value of a RedHat share.
  63
  64        C\bCO\bOU\bUN\bNT\bTE\bER\bR
  65            is for continuous incrementing counters like the ifInOctets counter
  66            in a router. The C\bCO\bOU\bUN\bNT\bTE\bER\bR data source assumes that the counter never
  67            decreases, except when a counter overflows.  The update function
  68            takes the overflow into account.  The counter is stored as a per-
  69            second rate. When the counter overflows, RRDtool checks if the
  70            overflow happened at the 32bit or 64bit border and acts accordingly
  71            by adding an appropriate value to the result.
  72
  73        D\bDE\bER\bRI\bIV\bVE\bE
  74            will store the derivative of the line going from the last to the
  75            current value of the data source. This can be useful for gauges,
  76            for example, to measure the rate of people entering or leaving a
  77            room. Internally, derive works exactly like COUNTER but without
  78            overflow checks. So if your counter does not reset at 32 or 64 bit
  79            you might want to use DERIVE and combine it with a MIN value of 0.
  80
  81            N\bNO\bOT\bTE\bE o\bon\bn C\bCO\bOU\bUN\bNT\bTE\bER\bR v\bvs\bs D\bDE\bER\bRI\bIV\bVE\bE
  82
  83            by Don Baarda <don.baarda@baesystems.com>
  84
  85            If you cannot tolerate ever mistaking the occasional counter reset
  86            for a legitimate counter wrap, and would prefer "Unknowns" for all
  87            legitimate counter wraps and resets, always use DERIVE with min=0.
  88            Otherwise, using COUNTER with a suitable max will return correct
  89            values for all legitimate counter wraps, mark some counter resets
  90            as "Unknown", but can mistake some counter resets for a legitimate
  91            counter wrap.
  92
  93            For a 5 minute step and 32-bit counter, the probability of
  94            mistaking a counter reset for a legitimate wrap is arguably about
  95            0.8% per 1Mbps of maximum bandwidth. Note that this equates to 80%
  96            for 100Mbps interfaces, so for high bandwidth interfaces and a
  97            32bit counter, DERIVE with min=0 is probably preferable. If you are
  98            using a 64bit counter, just about any max setting will eliminate
  99            the possibility of mistaking a reset for a counter wrap.
 100
 101        A\bAB\bBS\bSO\bOL\bLU\bUT\bTE\bE
 102            is for counters which get reset upon reading. This is used for fast
 103            counters which tend to overflow. So instead of reading them
 104            normally you reset them after every read to make sure you have a
 105            maximum time available before the next overflow. Another usage is
 106            for things you count like number of messages since the last update.
 107
 108        C\bCO\bOM\bMP\bPU\bUT\bTE\bE
 109            is for storing the result of a formula applied to other data
 110            sources in the R\bRR\bRD\bD. This data source is not supplied a value on
 111            update, but rather its Primary Data Points (PDPs) are computed from
 112            the PDPs of the data sources according to the rpn-expression that
 113            defines the formula. Consolidation functions are then applied
 114            normally to the PDPs of the COMPUTE data source (that is the rpn-
 115            expression is only applied to generate PDPs). In database software,
 116            such data sets are referred to as "virtual" or "computed" columns.
 117
 118        _\bh_\be_\ba_\br_\bt_\bb_\be_\ba_\bt defines the maximum number of seconds that may pass between
 119        two updates of this data source before the value of the data source is
 120        assumed to be _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*.
 121
 122        _\bm_\bi_\bn and _\bm_\ba_\bx define the expected range values for data supplied by a
 123        data source. If _\bm_\bi_\bn and/or _\bm_\ba_\bx any value outside the defined range will
 124        be regarded as _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*. If you do not know or care about min and max,
 125        set them to U for unknown. Note that min and max always refer to the
 126        processed values of the DS. For a traffic-C\bCO\bOU\bUN\bNT\bTE\bER\bR type DS this would be
 127        the maximum and minimum data-rate expected from the device.
 128
 129        _\bI_\bf _\bi_\bn_\bf_\bo_\br_\bm_\ba_\bt_\bi_\bo_\bn _\bo_\bn _\bm_\bi_\bn_\bi_\bm_\ba_\bl_\b/_\bm_\ba_\bx_\bi_\bm_\ba_\bl _\be_\bx_\bp_\be_\bc_\bt_\be_\bd _\bv_\ba_\bl_\bu_\be_\bs _\bi_\bs _\ba_\bv_\ba_\bi_\bl_\ba_\bb_\bl_\be_\b, _\ba_\bl_\bw_\ba_\by_\bs
 130        _\bs_\be_\bt _\bt_\bh_\be _\bm_\bi_\bn _\ba_\bn_\bd_\b/_\bo_\br _\bm_\ba_\bx _\bp_\br_\bo_\bp_\be_\br_\bt_\bi_\be_\bs_\b. _\bT_\bh_\bi_\bs _\bw_\bi_\bl_\bl _\bh_\be_\bl_\bp _\bR_\bR_\bD_\bt_\bo_\bo_\bl _\bi_\bn _\bd_\bo_\bi_\bn_\bg _\ba
 131        _\bs_\bi_\bm_\bp_\bl_\be _\bs_\ba_\bn_\bi_\bt_\by _\bc_\bh_\be_\bc_\bk _\bo_\bn _\bt_\bh_\be _\bd_\ba_\bt_\ba _\bs_\bu_\bp_\bp_\bl_\bi_\be_\bd _\bw_\bh_\be_\bn _\br_\bu_\bn_\bn_\bi_\bn_\bg _\bu_\bp_\bd_\ba_\bt_\be_\b.
 132
 133        _\br_\bp_\bn_\b-_\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn defines the formula used to compute the PDPs of a
 134        COMPUTE data source from other data sources in the same <RRD>. It is
 135        similar to defining a C\bCD\bDE\bEF\bF argument for the graph command. Please refer
 136        to that manual page for a list and description of RPN operations
 137        supported. For COMPUTE data sources, the following RPN operations are
 138        not supported: COUNT, PREV, TIME, and LTIME. In addition, in defining
 139        the RPN expression, the COMPUTE data source may only refer to the names
 140        of data source listed previously in the create command. This is similar
 141        to the restriction that C\bCD\bDE\bEF\bFs must refer only to D\bDE\bEF\bFs and C\bCD\bDE\bEF\bFs
 142        previously defined in the same graph command.
 143
 144    R\bRR\bRA\bA:\b:_\bC_\bF:\b:_\bc_\bf _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs
 145        The purpose of an R\bRR\bRD\bD is to store data in the round robin archives
 146        (R\bRR\bRA\bA). An archive consists of a number of data values or statistics for
 147        each of the defined data-sources (D\bDS\bS) and is defined with an R\bRR\bRA\bA line.
 148
 149        When data is entered into an R\bRR\bRD\bD, it is first fit into time slots of
 150        the length defined with the -\b-s\bs option, thus becoming a _\bp_\br_\bi_\bm_\ba_\br_\by _\bd_\ba_\bt_\ba
 151        _\bp_\bo_\bi_\bn_\bt.
 152
 153        The data is also processed with the consolidation function (_\bC_\bF) of the
 154        archive. There are several consolidation functions that consolidate
 155        primary data points via an aggregate function: A\bAV\bVE\bER\bRA\bAG\bGE\bE, M\bMI\bIN\bN, M\bMA\bAX\bX, L\bLA\bAS\bST\bT.
 156
 157        AVERAGE
 158            the average of the data points is stored.
 159
 160        MIN the smallest of the data points is stored.
 161
 162        MAX the largest of the data points is stored.
 163
 164        LAST
 165            the last data points is used.
 166
 167        Note that data aggregation inevitably leads to loss of precision and
 168        information. The trick is to pick the aggregate function such that the
 169        _\bi_\bn_\bt_\be_\br_\be_\bs_\bt_\bi_\bn_\bg properties of your data is kept across the aggregation
 170        process.
 171
 172        The format of R\bRR\bRA\bA line for these consolidation functions is:
 173
 174        R\bRR\bRA\bA:\b:_\bA_\bV_\bE_\bR_\bA_\bG_\bE _\b| _\bM_\bI_\bN _\b| _\bM_\bA_\bX _\b| _\bL_\bA_\bS_\bT:\b:_\bx_\bf_\bf:\b:_\bs_\bt_\be_\bp_\bs:\b:_\br_\bo_\bw_\bs
 175
 176        _\bx_\bf_\bf The xfiles factor defines what part of a consolidation interval may
 177        be made up from _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data while the consolidated value is still
 178        regarded as known. It is given as the ratio of allowed _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* PDPs
 179        to the number of PDPs in the interval. Thus, it ranges from 0 to 1
 180        (exclusive).
 181
 182        _\bs_\bt_\be_\bp_\bs defines how many of these _\bp_\br_\bi_\bm_\ba_\br_\by _\bd_\ba_\bt_\ba _\bp_\bo_\bi_\bn_\bt_\bs are used to build a
 183        _\bc_\bo_\bn_\bs_\bo_\bl_\bi_\bd_\ba_\bt_\be_\bd _\bd_\ba_\bt_\ba _\bp_\bo_\bi_\bn_\bt which then goes into the archive.
 184
 185        _\br_\bo_\bw_\bs defines how many generations of data values are kept in an R\bRR\bRA\bA.
 186        Obviously, this has to be greater than zero.
 187
 188 A\bAb\bbe\ber\brr\bra\ban\bnt\bt B\bBe\beh\bha\bav\bvi\bio\bor\br D\bDe\bet\bte\bec\bct\bti\bio\bon\bn w\bwi\bit\bth\bh H\bHo\bol\blt\bt-\b-W\bWi\bin\bnt\bte\ber\brs\bs F\bFo\bor\bre\bec\bca\bas\bst\bti\bin\bng\bg
 189        In addition to the aggregate functions, there are a set of specialized
 190        functions that enable R\bRR\bRD\bDt\bto\boo\bol\bl to provide data smoothing (via the Holt-
 191        Winters forecasting algorithm), confidence bands, and the flagging
 192        aberrant behavior in the data source time series:
 193
 194        ·   R\bRR\bRA\bA:\b:_\bH_\bW_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\ba_\bl_\bp_\bh_\ba:\b:_\bb_\be_\bt_\ba:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd[:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm]
 195
 196        ·   R\bRR\bRA\bA:\b:_\bM_\bH_\bW_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\ba_\bl_\bp_\bh_\ba:\b:_\bb_\be_\bt_\ba:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd[:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm]
 197
 198        ·   R\bRR\bRA\bA:\b:_\bS_\bE_\bA_\bS_\bO_\bN_\bA_\bL:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd:\b:_\bg_\ba_\bm_\bm_\ba:\b:_\br_\br_\ba_\b-
 199            _\bn_\bu_\bm[:\b:s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw=\b=_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn]
 200
 201        ·   R\bRR\bRA\bA:\b:_\bD_\bE_\bV_\bS_\bE_\bA_\bS_\bO_\bN_\bA_\bL:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd:\b:_\bg_\ba_\bm_\bm_\ba:\b:_\br_\br_\ba_\b-
 202            _\bn_\bu_\bm[:\b:s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw=\b=_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn]
 203
 204        ·   R\bRR\bRA\bA:\b:_\bD_\bE_\bV_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm
 205
 206        ·   R\bRR\bRA\bA:\b:_\bF_\bA_\bI_\bL_\bU_\bR_\bE_\bS:\b:_\br_\bo_\bw_\bs:\b:_\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd:\b:_\bw_\bi_\bn_\bd_\bo_\bw _\bl_\be_\bn_\bg_\bt_\bh:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm
 207
 208        These R\bRR\bRA\bAs\bs differ from the true consolidation functions in several
 209        ways.  First, each of the R\bRR\bRA\bAs is updated once for every primary data
 210        point.  Second, these R\bRR\bRA\bAs\bs are interdependent. To generate real-time
 211        confidence bounds, a matched set of SEASONAL, DEVSEASONAL, DEVPREDICT,
 212        and either HWPREDICT or MHWPREDICT must exist. Generating smoothed
 213        values of the primary data points requires a SEASONAL R\bRR\bRA\bA and either an
 214        HWPREDICT or MHWPREDICT R\bRR\bRA\bA. Aberrant behavior detection requires
 215        FAILURES, DEVSEASONAL, SEASONAL, and either HWPREDICT or MHWPREDICT.
 216
 217        The predicted, or smoothed, values are stored in the HWPREDICT or
 218        MHWPREDICT R\bRR\bRA\bA. HWPREDICT and MHWPREDICT are actually two variations on
 219        the Holt-Winters method. They are interchangeable. Both attempt to
 220        decompose data into three components: a baseline, a trend, and a
 221        seasonal coefficient.  HWPREDICT adds its seasonal coefficient to the
 222        baseline to form a prediction, whereas MHWPREDICT multiplies its
 223        seasonal coefficient by the baseline to form a prediction. The
 224        difference is noticeable when the baseline changes significantly in the
 225        course of a season; HWPREDICT will predict the seasonality to stay
 226        constant as the baseline changes, but MHWPREDICT will predict the
 227        seasonality to grow or shrink in proportion to the baseline. The proper
 228        choice of method depends on the thing being modeled. For simplicity,
 229        the rest of this discussion will refer to HWPREDICT, but MHWPREDICT may
 230        be substituted in its place.
 231
 232        The predicted deviations are stored in DEVPREDICT (think a standard
 233        deviation which can be scaled to yield a confidence band). The FAILURES
 234        R\bRR\bRA\bA stores binary indicators. A 1 marks the indexed observation as
 235        failure; that is, the number of confidence bounds violations in the
 236        preceding window of observations met or exceeded a specified threshold.
 237        An example of using these R\bRR\bRA\bAs\bs to graph confidence bounds and failures
 238        appears in rrdgraph.
 239
 240        The SEASONAL and DEVSEASONAL R\bRR\bRA\bAs\bs store the seasonal coefficients for
 241        the Holt-Winters forecasting algorithm and the seasonal deviations,
 242        respectively.  There is one entry per observation time point in the
 243        seasonal cycle. For example, if primary data points are generated every
 244        five minutes and the seasonal cycle is 1 day, both SEASONAL and
 245        DEVSEASONAL will have 288 rows.
 246
 247        In order to simplify the creation for the novice user, in addition to
 248        supporting explicit creation of the HWPREDICT, SEASONAL, DEVPREDICT,
 249        DEVSEASONAL, and FAILURES R\bRR\bRA\bAs\bs, the R\bRR\bRD\bDt\bto\boo\bol\bl create command supports
 250        implicit creation of the other four when HWPREDICT is specified alone
 251        and the final argument _\br_\br_\ba_\b-_\bn_\bu_\bm is omitted.
 252
 253        _\br_\bo_\bw_\bs specifies the length of the R\bRR\bRA\bA prior to wrap around. Remember
 254        that there is a one-to-one correspondence between primary data points
 255        and entries in these RRAs. For the HWPREDICT CF, _\br_\bo_\bw_\bs should be larger
 256        than the _\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd. If the DEVPREDICT R\bRR\bRA\bA is implicitly created,
 257        the default number of rows is the same as the HWPREDICT _\br_\bo_\bw_\bs argument.
 258        If the FAILURES R\bRR\bRA\bA is implicitly created, _\br_\bo_\bw_\bs will be set to the
 259        _\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd argument of the HWPREDICT R\bRR\bRA\bA. Of course, the R\bRR\bRD\bDt\bto\boo\bol\bl
 260        _\br_\be_\bs_\bi_\bz_\be command is available if these defaults are not sufficient and
 261        the creator wishes to avoid explicit creations of the other specialized
 262        function R\bRR\bRA\bAs\bs.
 263
 264        _\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd specifies the number of primary data points in a
 265        seasonal cycle. If SEASONAL and DEVSEASONAL are implicitly created,
 266        this argument for those R\bRR\bRA\bAs\bs is set automatically to the value
 267        specified by HWPREDICT. If they are explicitly created, the creator
 268        should verify that all three _\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd arguments agree.
 269
 270        _\ba_\bl_\bp_\bh_\ba is the adaption parameter of the intercept (or baseline)
 271        coefficient in the Holt-Winters forecasting algorithm. See rrdtool for
 272        a description of this algorithm. _\ba_\bl_\bp_\bh_\ba must lie between 0 and 1. A
 273        value closer to 1 means that more recent observations carry greater
 274        weight in predicting the baseline component of the forecast. A value
 275        closer to 0 means that past history carries greater weight in
 276        predicting the baseline component.
 277
 278        _\bb_\be_\bt_\ba is the adaption parameter of the slope (or linear trend)
 279        coefficient in the Holt-Winters forecasting algorithm. _\bb_\be_\bt_\ba must lie
 280        between 0 and 1 and plays the same role as _\ba_\bl_\bp_\bh_\ba with respect to the
 281        predicted linear trend.
 282
 283        _\bg_\ba_\bm_\bm_\ba is the adaption parameter of the seasonal coefficients in the
 284        Holt-Winters forecasting algorithm (HWPREDICT) or the adaption
 285        parameter in the exponential smoothing update of the seasonal
 286        deviations. It must lie between 0 and 1. If the SEASONAL and
 287        DEVSEASONAL R\bRR\bRA\bAs\bs are created implicitly, they will both have the same
 288        value for _\bg_\ba_\bm_\bm_\ba: the value specified for the HWPREDICT _\ba_\bl_\bp_\bh_\ba argument.
 289        Note that because there is one seasonal coefficient (or deviation) for
 290        each time point during the seasonal cycle, the adaptation rate is much
 291        slower than the baseline. Each seasonal coefficient is only updated (or
 292        adapts) when the observed value occurs at the offset in the seasonal
 293        cycle corresponding to that coefficient.
 294
 295        If SEASONAL and DEVSEASONAL R\bRR\bRA\bAs\bs are created explicitly, _\bg_\ba_\bm_\bm_\ba need not
 296        be the same for both. Note that _\bg_\ba_\bm_\bm_\ba can also be changed via the
 297        R\bRR\bRD\bDt\bto\boo\bol\bl _\bt_\bu_\bn_\be command.
 298
 299        _\bs_\bm_\bo_\bo_\bt_\bh_\bi_\bn_\bg_\b-_\bw_\bi_\bn_\bd_\bo_\bw specifies the fraction of a season that should be
 300        averaged around each point. By default, the value of _\bs_\bm_\bo_\bo_\bt_\bh_\bi_\bn_\bg_\b-_\bw_\bi_\bn_\bd_\bo_\bw
 301        is 0.05, which means each value in SEASONAL and DEVSEASONAL will be
 302        occasionally replaced by averaging it with its (_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd*0.05)
 303        nearest neighbors.  Setting _\bs_\bm_\bo_\bo_\bt_\bh_\bi_\bn_\bg_\b-_\bw_\bi_\bn_\bd_\bo_\bw to zero will disable the
 304        running-average smoother altogether.
 305
 306        _\br_\br_\ba_\b-_\bn_\bu_\bm provides the links between related R\bRR\bRA\bAs\bs. If HWPREDICT is
 307        specified alone and the other R\bRR\bRA\bAs\bs are created implicitly, then there
 308        is no need to worry about this argument. If R\bRR\bRA\bAs\bs are created
 309        explicitly, then carefully pay attention to this argument. For each R\bRR\bRA\bA
 310        which includes this argument, there is a dependency between that R\bRR\bRA\bA
 311        and another R\bRR\bRA\bA. The _\br_\br_\ba_\b-_\bn_\bu_\bm argument is the 1-based index in the order
 312        of R\bRR\bRA\bA creation (that is, the order they appear in the _\bc_\br_\be_\ba_\bt_\be command).
 313        The dependent R\bRR\bRA\bA for each R\bRR\bRA\bA requiring the _\br_\br_\ba_\b-_\bn_\bu_\bm argument is listed
 314        here:
 315
 316        ·   HWPREDICT _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the SEASONAL R\bRR\bRA\bA.
 317
 318        ·   SEASONAL _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the HWPREDICT R\bRR\bRA\bA.
 319
 320        ·   DEVPREDICT _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the DEVSEASONAL R\bRR\bRA\bA.
 321
 322        ·   DEVSEASONAL _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the HWPREDICT R\bRR\bRA\bA.
 323
 324        ·   FAILURES _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the DEVSEASONAL R\bRR\bRA\bA.
 325
 326        _\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd is the minimum number of violations (observed values outside
 327        the confidence bounds) within a window that constitutes a failure. If
 328        the FAILURES R\bRR\bRA\bA is implicitly created, the default value is 7.
 329
 330        _\bw_\bi_\bn_\bd_\bo_\bw _\bl_\be_\bn_\bg_\bt_\bh is the number of time points in the window. Specify an
 331        integer greater than or equal to the threshold and less than or equal
 332        to 28.  The time interval this window represents depends on the
 333        interval between primary data points. If the FAILURES R\bRR\bRA\bA is implicitly
 334        created, the default value is 9.
 335
 336 T\bTh\bhe\be H\bHE\bEA\bAR\bRT\bTB\bBE\bEA\bAT\bT a\ban\bnd\bd t\bth\bhe\be S\bST\bTE\bEP\bP
 337        Here is an explanation by Don Baarda on the inner workings of RRDtool.
 338        It may help you to sort out why all this *UNKNOWN* data is popping up
 339        in your databases:
 340
 341        RRDtool gets fed samples/updates at arbitrary times. From these it
 342        builds Primary Data Points (PDPs) on every "step" interval. The PDPs
 343        are then accumulated into the RRAs.
 344
 345        The "heartbeat" defines the maximum acceptable interval between
 346        samples/updates. If the interval between samples is less than
 347        "heartbeat", then an average rate is calculated and applied for that
 348        interval. If the interval between samples is longer than "heartbeat",
 349        then that entire interval is considered "unknown". Note that there are
 350        other things that can make a sample interval "unknown", such as the
 351        rate exceeding limits, or a sample that was explicitly marked as
 352        unknown.
 353
 354        The known rates during a PDP's "step" interval are used to calculate an
 355        average rate for that PDP. If the total "unknown" time accounts for
 356        more than h\bha\bal\blf\bf the "step", the entire PDP is marked as "unknown". This
 357        means that a mixture of known and "unknown" sample times in a single
 358        PDP "step" may or may not add up to enough "known" time to warrant a
 359        known PDP.
 360
 361        The "heartbeat" can be short (unusual) or long (typical) relative to
 362        the "step" interval between PDPs. A short "heartbeat" means you require
 363        multiple samples per PDP, and if you don't get them mark the PDP
 364        unknown. A long heartbeat can span multiple "steps", which means it is
 365        acceptable to have multiple PDPs calculated from a single sample. An
 366        extreme example of this might be a "step" of 5 minutes and a
 367        "heartbeat" of one day, in which case a single sample every day will
 368        result in all the PDPs for that entire day period being set to the same
 369        average rate. _\b-_\b- _\bD_\bo_\bn _\bB_\ba_\ba_\br_\bd_\ba _\b<_\bd_\bo_\bn_\b._\bb_\ba_\ba_\br_\bd_\ba_\b@_\bb_\ba_\be_\bs_\by_\bs_\bt_\be_\bm_\bs_\b._\bc_\bo_\bm_\b>
 370
 371               time|
 372               axis|
 373         begin__|00|
 374                |01|
 375               u|02|----* sample1, restart "hb"-timer
 376               u|03|   /
 377               u|04|  /
 378               u|05| /
 379               u|06|/     "hbt" expired
 380               u|07|
 381                |08|----* sample2, restart "hb"
 382                |09|   /
 383                |10|  /
 384               u|11|----* sample3, restart "hb"
 385               u|12|   /
 386               u|13|  /
 387         step1_u|14| /
 388               u|15|/     "swt" expired
 389               u|16|
 390                |17|----* sample4, restart "hb", create "pdp" for step1 =
 391                |18|   /  = unknown due to 10 "u" labled secs > 0.5 * step
 392                |19|  /
 393                |20| /
 394                |21|----* sample5, restart "hb"
 395                |22|   /
 396                |23|  /
 397                |24|----* sample6, restart "hb"
 398                |25|   /
 399                |26|  /
 400                |27|----* sample7, restart "hb"
 401         step2__|28|   /
 402                |22|  /
 403                |23|----* sample8, restart "hb", create "pdp" for step1, create "cdp"
 404                |24|   /
 405                |25|  /
 406
 407        graphics by _\bv_\bl_\ba_\bd_\bi_\bm_\bi_\br_\b._\bl_\ba_\bv_\br_\bo_\bv_\b@_\bd_\be_\bs_\by_\b._\bd_\be.
 408
 409 H\bHO\bOW\bW T\bTO\bO M\bME\bEA\bAS\bSU\bUR\bRE\bE
 410        Here are a few hints on how to measure:
 411
 412        Temperature
 413            Usually you have some type of meter you can read to get the
 414            temperature.  The temperature is not really connected with a time.
 415            The only connection is that the temperature reading happened at a
 416            certain time. You can use the G\bGA\bAU\bUG\bGE\bE data source type for this.
 417            RRDtool will then record your reading together with the time.
 418
 419        Mail Messages
 420            Assume you have a method to count the number of messages
 421            transported by your mail server in a certain amount of time, giving
 422            you data like '5 messages in the last 65 seconds'. If you look at
 423            the count of 5 like an A\bAB\bBS\bSO\bOL\bLU\bUT\bTE\bE data type you can simply update the
 424            RRD with the number 5 and the end time of your monitoring period.
 425            RRDtool will then record the number of messages per second. If at
 426            some later stage you want to know the number of messages
 427            transported in a day, you can get the average messages per second
 428            from RRDtool for the day in question and multiply this number with
 429            the number of seconds in a day. Because all math is run with
 430            Doubles, the precision should be acceptable.
 431
 432        It's always a Rate
 433            RRDtool stores rates in amount/second for COUNTER, DERIVE and
 434            ABSOLUTE data.  When you plot the data, you will get on the y axis
 435            amount/second which you might be tempted to convert to an absolute
 436            amount by multiplying by the delta-time between the points. RRDtool
 437            plots continuous data, and as such is not appropriate for plotting
 438            absolute amounts as for example "total bytes" sent and received in
 439            a router. What you probably want is plot rates that you can scale
 440            to bytes/hour, for example, or plot absolute amounts with another
 441            tool that draws bar-plots, where the delta-time is clear on the
 442            plot for each point (such that when you read the graph you see for
 443            example GB on the y axis, days on the x axis and one bar for each
 444            day).
 445
 446 E\bEX\bXA\bAM\bMP\bPL\bLE\bE
 447         rrdtool create temperature.rrd --step 300 \
 448          DS:temp:GAUGE:600:-273:5000 \
 449          RRA:AVERAGE:0.5:1:1200 \
 450          RRA:MIN:0.5:12:2400 \
 451          RRA:MAX:0.5:12:2400 \
 452          RRA:AVERAGE:0.5:12:2400
 453
 454        This sets up an R\bRR\bRD\bD called _\bt_\be_\bm_\bp_\be_\br_\ba_\bt_\bu_\br_\be_\b._\br_\br_\bd which accepts one
 455        temperature value every 300 seconds. If no new data is supplied for
 456        more than 600 seconds, the temperature becomes _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*.  The minimum
 457        acceptable value is -273 and the maximum is 5'000.
 458
 459        A few archive areas are also defined. The first stores the temperatures
 460        supplied for 100 hours (1'200 * 300 seconds = 100 hours). The second
 461        RRA stores the minimum temperature recorded over every hour (12 * 300
 462        seconds = 1 hour), for 100 days (2'400 hours). The third and the fourth
 463        RRA's do the same for the maximum and average temperature,
 464        respectively.
 465
 466 E\bEX\bXA\bAM\bMP\bPL\bLE\bE 2\b2
 467         rrdtool create monitor.rrd --step 300        \
 468           DS:ifOutOctets:COUNTER:1800:0:4294967295   \
 469           RRA:AVERAGE:0.5:1:2016                     \
 470           RRA:HWPREDICT:1440:0.1:0.0035:288
 471
 472        This example is a monitor of a router interface. The first R\bRR\bRA\bA tracks
 473        the traffic flow in octets; the second R\bRR\bRA\bA generates the specialized
 474        functions R\bRR\bRA\bAs\bs for aberrant behavior detection. Note that the _\br_\br_\ba_\b-_\bn_\bu_\bm
 475        argument of HWPREDICT is missing, so the other R\bRR\bRA\bAs\bs will implicitly be
 476        created with default parameter values. In this example, the forecasting
 477        algorithm baseline adapts quickly; in fact the most recent one hour of
 478        observations (each at 5 minute intervals) accounts for 75% of the
 479        baseline prediction. The linear trend forecast adapts much more slowly.
 480        Observations made during the last day (at 288 observations per day)
 481        account for only 65% of the predicted linear trend. Note: these
 482        computations rely on an exponential smoothing formula described in the
 483        LISA 2000 paper.
 484
 485        The seasonal cycle is one day (288 data points at 300 second
 486        intervals), and the seasonal adaption parameter will be set to 0.1. The
 487        RRD file will store 5 days (1'440 data points) of forecasts and
 488        deviation predictions before wrap around. The file will store 1 day (a
 489        seasonal cycle) of 0-1 indicators in the FAILURES R\bRR\bRA\bA.
 490
 491        The same RRD file and R\bRR\bRA\bAs\bs are created with the following command,
 492        which explicitly creates all specialized function R\bRR\bRA\bAs\bs.
 493
 494         rrdtool create monitor.rrd --step 300 \
 495           DS:ifOutOctets:COUNTER:1800:0:4294967295 \
 496           RRA:AVERAGE:0.5:1:2016 \
 497           RRA:HWPREDICT:1440:0.1:0.0035:288:3 \
 498           RRA:SEASONAL:288:0.1:2 \
 499           RRA:DEVPREDICT:1440:5 \
 500           RRA:DEVSEASONAL:288:0.1:2 \
 501           RRA:FAILURES:288:7:9:5
 502
 503        Of course, explicit creation need not replicate implicit create, a
 504        number of arguments could be changed.
 505
 506 E\bEX\bXA\bAM\bMP\bPL\bLE\bE 3\b3
 507         rrdtool create proxy.rrd --step 300 \
 508           DS:Total:DERIVE:1800:0:U  \
 509           DS:Duration:DERIVE:1800:0:U  \
 510           DS:AvgReqDur:COMPUTE:Duration,Requests,0,EQ,1,Requests,IF,/ \
 511           RRA:AVERAGE:0.5:1:2016
 512
 513        This example is monitoring the average request duration during each 300
 514        sec interval for requests processed by a web proxy during the interval.
 515        In this case, the proxy exposes two counters, the number of requests
 516        processed since boot and the total cumulative duration of all processed
 517        requests. Clearly these counters both have some rollover point, but
 518        using the DERIVE data source also handles the reset that occurs when
 519        the web proxy is stopped and restarted.
 520
 521        In the R\bRR\bRD\bD, the first data source stores the requests per second rate
 522        during the interval. The second data source stores the total duration
 523        of all requests processed during the interval divided by 300. The
 524        COMPUTE data source divides each PDP of the AccumDuration by the
 525        corresponding PDP of TotalRequests and stores the average request
 526        duration. The remainder of the RPN expression handles the divide by
 527        zero case.
 528
 529 A\bAU\bUT\bTH\bHO\bOR\bR
 530        Tobias Oetiker <tobi@oetiker.ch>
 531
 532
 533
 534 1.4.3                             2010-03-08                      RRDCREATE(1)