doc/rrdcreate.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>rrdcreate</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:root@localhost" />
   8 </head>
   9
  10 <body style="background-color: white">
  11
  12 <p><a name="__index__"></a></p>
  13 <!-- INDEX BEGIN -->
  14 <!--
  15
  16 <ul>
  17
  18         <li><a href="#name">NAME</a></li>
  19         <li><a href="#synopsis">SYNOPSIS</a></li>
  20         <li><a href="#description">DESCRIPTION</a></li>
  21         <ul>
  22
  23                 <li><a href="#filename"><em>filename</em></a></li>
  24                 <li><a href="#start_b_start_time__default__now__10s_"><strong>-start</strong>|<strong>-b</strong> <em>start time</em> (default: now - 10s)</a></li>
  25                 <li><a href="#step_s_step__default__300_seconds_"><strong>-step</strong>|<strong>-s</strong> <em>step</em> (default: 300 seconds)</a></li>
  26                 <li><a href="#ds_dsname_dst_dst_arguments"><strong>DS:</strong><em>ds-name</em><strong>:</strong><em>DST</em><strong>:</strong><em>dst arguments</em></a></li>
  27                 <li><a href="#rra_cf_cf_arguments"><strong>RRA:</strong><em>CF</em><strong>:</strong><em>cf arguments</em></a></li>
  28         </ul>
  29
  30         <li><a href="#aberrant_behavior_detection_with_holtwinters_forecasting">Aberrant Behavior Detection with Holt-Winters Forecasting</a></li>
  31         <li><a href="#the_heartbeat_and_the_step">The HEARTBEAT and the STEP</a></li>
  32         <li><a href="#how_to_measure">HOW TO MEASURE</a></li>
  33         <li><a href="#example">EXAMPLE</a></li>
  34         <li><a href="#example_2">EXAMPLE 2</a></li>
  35         <li><a href="#example_3">EXAMPLE 3</a></li>
  36         <li><a href="#author">AUTHOR</a></li>
  37 </ul>
  38 -->
  39 <!-- INDEX END -->
  40
  41 <p>
  42 </p>
  43 <h1><a name="name">NAME</a></h1>
  44 <p>rrdcreate - Set up a new Round Robin Database</p>
  45 <p>
  46 </p>
  47 <hr />
  48 <h1><a name="synopsis">SYNOPSIS</a></h1>
  49 <p><strong>rrdtool</strong> <strong>create</strong> <em>filename</em>
  50 [<strong>--start</strong>|<strong>-b</strong>&nbsp;<em>start&nbsp;time</em>]
  51 [<strong>--step</strong>|<strong>-s</strong>&nbsp;<em>step</em>]
  52 [<strong>DS:</strong><em>ds-name</em><strong>:</strong><em>DST</em><strong>:</strong><em>dst&nbsp;arguments</em>]
  53 [<strong>RRA:</strong><em>CF</em><strong>:</strong><em>cf&nbsp;arguments</em>]</p>
  54 <p>
  55 </p>
  56 <hr />
  57 <h1><a name="description">DESCRIPTION</a></h1>
  58 <p>The create function of RRDtool lets you set up new Round Robin
  59 Database (<strong>RRD</strong>) files.  The file is created at its final, full size
  60 and filled with <em>*UNKNOWN*</em> data.</p>
  61 <p>
  62 </p>
  63 <h2><a name="filename"><em>filename</em></a></h2>
  64 <p>The name of the <strong>RRD</strong> you want to create. <strong>RRD</strong> files should end
  65 with the extension <em>.rrd</em>. However, <strong>RRDtool</strong> will accept any
  66 filename.</p>
  67 <p>
  68 </p>
  69 <h2><a name="start_b_start_time__default__now__10s_"><strong>--start</strong>|<strong>-b</strong> <em>start time</em> (default: now - 10s)</a></h2>
  70 <p>Specifies the time in seconds since 1970-01-01 UTC when the first
  71 value should be added to the <strong>RRD</strong>. <strong>RRDtool</strong> will not accept
  72 any data timed before or at the time specified.</p>
  73 <p>See also AT-STYLE TIME SPECIFICATION section in the
  74 <em>rrdfetch</em> documentation for other ways to specify time.</p>
  75 <p>
  76 </p>
  77 <h2><a name="step_s_step__default__300_seconds_"><strong>--step</strong>|<strong>-s</strong> <em>step</em> (default: 300 seconds)</a></h2>
  78 <p>Specifies the base interval in seconds with which data will be fed
  79 into the <strong>RRD</strong>.</p>
  80 <p>
  81 </p>
  82 <h2><a name="ds_dsname_dst_dst_arguments"><strong>DS:</strong><em>ds-name</em><strong>:</strong><em>DST</em><strong>:</strong><em>dst arguments</em></a></h2>
  83 <p>A single <strong>RRD</strong> can accept input from several data sources (<strong>DS</strong>),
  84 for example incoming and outgoing traffic on a specific communication
  85 line. With the <strong>DS</strong> configuration option you must define some basic
  86 properties of each data source you want to store in the <strong>RRD</strong>.</p>
  87 <p><em>ds-name</em> is the name you will use to reference this particular data
  88 source from an <strong>RRD</strong>. A <em>ds-name</em> must be 1 to 19 characters long in
  89 the characters [a-zA-Z0-9_].</p>
  90 <p><em>DST</em> defines the Data Source Type. The remaining arguments of a
  91 data source entry depend on the data source type. For GAUGE, COUNTER,
  92 DERIVE, and ABSOLUTE the format for a data source entry is:</p>
  93 <p><strong>DS:</strong><em>ds-name</em><strong>:</strong><em>GAUGE | COUNTER | DERIVE | ABSOLUTE</em><strong>:</strong><em>heartbeat</em><strong>:</strong><em>min</em><strong>:</strong><em>max</em></p>
  94 <p>For COMPUTE data sources, the format is:</p>
  95 <p><strong>DS:</strong><em>ds-name</em><strong>:</strong><em>COMPUTE</em><strong>:</strong><em>rpn-expression</em></p>
  96 <p>In order to decide which data source type to use, review the
  97 definitions that follow. Also consult the section on ``HOW TO MEASURE''
  98 for further insight.</p>
  99 <dl>
 100 <dt><strong><a name="item_gauge"><strong>GAUGE</strong></a></strong></dt>
 101
 102 <dd>
 103 <p>is for things like temperatures or number of people in a room or the
 104 value of a RedHat share.</p>
 105 </dd>
 106 <dt><strong><a name="item_counter"><strong>COUNTER</strong></a></strong></dt>
 107
 108 <dd>
 109 <p>is for continuous incrementing counters like the ifInOctets counter in
 110 a router. The <strong>COUNTER</strong> data source assumes that the counter never
 111 decreases, except when a counter overflows.  The update function takes
 112 the overflow into account.  The counter is stored as a per-second
 113 rate. When the counter overflows, RRDtool checks if the overflow
 114 happened at the 32bit or 64bit border and acts accordingly by adding
 115 an appropriate value to the result.</p>
 116 </dd>
 117 <dt><strong><a name="item_derive"><strong>DERIVE</strong></a></strong></dt>
 118
 119 <dd>
 120 <p>will store the derivative of the line going from the last to the
 121 current value of the data source. This can be useful for gauges, for
 122 example, to measure the rate of people entering or leaving a
 123 room. Internally, derive works exactly like COUNTER but without
 124 overflow checks. So if your counter does not reset at 32 or 64 bit you
 125 might want to use DERIVE and combine it with a MIN value of 0.</p>
 126 <p><strong>NOTE on COUNTER vs DERIVE</strong></p>
 127 <p>by Don Baarda &lt;<a href="mailto:don.baarda@baesystems.com">don.baarda@baesystems.com</a>&gt;</p>
 128 <p>If you cannot tolerate ever mistaking the occasional counter reset for a
 129 legitimate counter wrap, and would prefer ``Unknowns'' for all legitimate
 130 counter wraps and resets, always use DERIVE with min=0. Otherwise, using
 131 COUNTER with a suitable max will return correct values for all legitimate
 132 counter wraps, mark some counter resets as ``Unknown'', but can mistake some
 133 counter resets for a legitimate counter wrap.</p>
 134 <p>For a 5 minute step and 32-bit counter, the probability of mistaking a
 135 counter reset for a legitimate wrap is arguably about 0.8% per 1Mbps of
 136 maximum bandwidth. Note that this equates to 80% for 100Mbps interfaces, so
 137 for high bandwidth interfaces and a 32bit counter, DERIVE with min=0 is
 138 probably preferable. If you are using a 64bit counter, just about any max
 139 setting will eliminate the possibility of mistaking a reset for a counter
 140 wrap.</p>
 141 </dd>
 142 <dt><strong><a name="item_absolute"><strong>ABSOLUTE</strong></a></strong></dt>
 143
 144 <dd>
 145 <p>is for counters which get reset upon reading. This is used for fast counters
 146 which tend to overflow. So instead of reading them normally you reset them
 147 after every read to make sure you have a maximum time available before the
 148 next overflow. Another usage is for things you count like number of messages
 149 since the last update.</p>
 150 </dd>
 151 <dt><strong><a name="item_compute"><strong>COMPUTE</strong></a></strong></dt>
 152
 153 <dd>
 154 <p>is for storing the result of a formula applied to other data sources
 155 in the <strong>RRD</strong>. This data source is not supplied a value on update, but
 156 rather its Primary Data Points (PDPs) are computed from the PDPs of
 157 the data sources according to the rpn-expression that defines the
 158 formula. Consolidation functions are then applied normally to the PDPs
 159 of the COMPUTE data source (that is the rpn-expression is only applied
 160 to generate PDPs). In database software, such data sets are referred
 161 to as ``virtual'' or ``computed'' columns.</p>
 162 </dd>
 163 </dl>
 164 <p><em>heartbeat</em> defines the maximum number of seconds that may pass
 165 between two updates of this data source before the value of the
 166 data source is assumed to be <em>*UNKNOWN*</em>.</p>
 167 <p><em>min</em> and <em>max</em> define the expected range values for data supplied by a
 168 data source. If <em>min</em> and/or <em>max</em> any value outside the defined range
 169 will be regarded as <em>*UNKNOWN*</em>. If you do not know or care about min and
 170 max, set them to U for unknown. Note that min and max always refer to the
 171 processed values of the DS. For a traffic-<strong>COUNTER</strong> type DS this would be
 172 the maximum and minimum data-rate expected from the device.</p>
 173 <p><em>If information on minimal/maximal expected values is available,
 174 always set the min and/or max properties. This will help RRDtool in
 175 doing a simple sanity check on the data supplied when running update.</em></p>
 176 <p><em>rpn-expression</em> defines the formula used to compute the PDPs of a
 177 COMPUTE data source from other data sources in the same &lt;RRD&gt;. It is
 178 similar to defining a <strong>CDEF</strong> argument for the graph command. Please
 179 refer to that manual page for a list and description of RPN operations
 180 supported. For COMPUTE data sources, the following RPN operations are
 181 not supported: COUNT, PREV, TIME, and LTIME. In addition, in defining
 182 the RPN expression, the COMPUTE data source may only refer to the
 183 names of data source listed previously in the create command. This is
 184 similar to the restriction that <strong>CDEF</strong>s must refer only to <strong>DEF</strong>s
 185 and <strong>CDEF</strong>s previously defined in the same graph command.</p>
 186 <p>
 187 </p>
 188 <h2><a name="rra_cf_cf_arguments"><strong>RRA:</strong><em>CF</em><strong>:</strong><em>cf arguments</em></a></h2>
 189 <p>The purpose of an <strong>RRD</strong> is to store data in the round robin archives
 190 (<strong>RRA</strong>). An archive consists of a number of data values or statistics for
 191 each of the defined data-sources (<strong>DS</strong>) and is defined with an <strong>RRA</strong> line.</p>
 192 <p>When data is entered into an <strong>RRD</strong>, it is first fit into time slots
 193 of the length defined with the <strong>-s</strong> option, thus becoming a <em>primary
 194 data point</em>.</p>
 195 <p>The data is also processed with the consolidation function (<em>CF</em>) of
 196 the archive. There are several consolidation functions that
 197 consolidate primary data points via an aggregate function: <strong>AVERAGE</strong>,
 198 <strong>MIN</strong>, <strong>MAX</strong>, <strong>LAST</strong>.</p>
 199 <dl>
 200 <dt><strong><a name="item_average">AVERAGE</a></strong></dt>
 201
 202 <dd>
 203 <p>the average of the data points is stored.</p>
 204 </dd>
 205 <dt><strong><a name="item_min">MIN</a></strong></dt>
 206
 207 <dd>
 208 <p>the smallest of the data points is stored.</p>
 209 </dd>
 210 <dt><strong><a name="item_max">MAX</a></strong></dt>
 211
 212 <dd>
 213 <p>the largest of the data points is stored.</p>
 214 </dd>
 215 <dt><strong><a name="item_last">LAST</a></strong></dt>
 216
 217 <dd>
 218 <p>the last data points is used.</p>
 219 </dd>
 220 </dl>
 221 <p>Note that data aggregation inevitably leads to loss of precision and
 222 information. The trick is to pick the aggregate function such that the
 223 <em>interesting</em> properties of your data is kept across the aggregation
 224 process.</p>
 225 <p>The format of <strong>RRA</strong> line for these
 226 consolidation functions is:</p>
 227 <p><strong>RRA:</strong><em>AVERAGE | MIN | MAX | LAST</em><strong>:</strong><em>xff</em><strong>:</strong><em>steps</em><strong>:</strong><em>rows</em></p>
 228 <p><em>xff</em> The xfiles factor defines what part of a consolidation interval may
 229 be made up from <em>*UNKNOWN*</em> data while the consolidated value is still
 230 regarded as known. It is given as the ratio of allowed <em>*UNKNOWN*</em> PDPs
 231 to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive).</p>
 232 <p><em>steps</em> defines how many of these <em>primary data points</em> are used to build
 233 a <em>consolidated data point</em> which then goes into the archive.</p>
 234 <p><em>rows</em> defines how many generations of data values are kept in an <strong>RRA</strong>.
 235 Obviously, this has to be greater than zero.</p>
 236 <p>
 237 </p>
 238 <hr />
 239 <h1><a name="aberrant_behavior_detection_with_holtwinters_forecasting">Aberrant Behavior Detection with Holt-Winters Forecasting</a></h1>
 240 <p>In addition to the aggregate functions, there are a set of specialized
 241 functions that enable <strong>RRDtool</strong> to provide data smoothing (via the
 242 Holt-Winters forecasting algorithm), confidence bands, and the
 243 flagging aberrant behavior in the data source time series:</p>
 244 <ul>
 245 <li>
 246 <p><strong>RRA:</strong><em>HWPREDICT</em><strong>:</strong><em>rows</em><strong>:</strong><em>alpha</em><strong>:</strong><em>beta</em><strong>:</strong><em>seasonal period</em>[<strong>:</strong><em>rra-num</em>]</p>
 247 </li>
 248 <li>
 249 <p><strong>RRA:</strong><em>MHWPREDICT</em><strong>:</strong><em>rows</em><strong>:</strong><em>alpha</em><strong>:</strong><em>beta</em><strong>:</strong><em>seasonal period</em>[<strong>:</strong><em>rra-num</em>]</p>
 250 </li>
 251 <li>
 252 <p><strong>RRA:</strong><em>SEASONAL</em><strong>:</strong><em>seasonal period</em><strong>:</strong><em>gamma</em><strong>:</strong><em>rra-num</em>[<strong>:smoothing-window=</strong><em>fraction</em>]</p>
 253 </li>
 254 <li>
 255 <p><strong>RRA:</strong><em>DEVSEASONAL</em><strong>:</strong><em>seasonal period</em><strong>:</strong><em>gamma</em><strong>:</strong><em>rra-num</em>[<strong>:smoothing-window=</strong><em>fraction</em>]</p>
 256 </li>
 257 <li>
 258 <p><strong>RRA:</strong><em>DEVPREDICT</em><strong>:</strong><em>rows</em><strong>:</strong><em>rra-num</em></p>
 259 </li>
 260 <li>
 261 <p><strong>RRA:</strong><em>FAILURES</em><strong>:</strong><em>rows</em><strong>:</strong><em>threshold</em><strong>:</strong><em>window length</em><strong>:</strong><em>rra-num</em></p>
 262 </li>
 263 </ul>
 264 <p>These <strong>RRAs</strong> differ from the true consolidation functions in several ways.
 265 First, each of the <strong>RRA</strong>s is updated once for every primary data point.
 266 Second, these <strong>RRAs</strong> are interdependent. To generate real-time confidence
 267 bounds, a matched set of SEASONAL, DEVSEASONAL, DEVPREDICT, and either
 268 HWPREDICT or MHWPREDICT must exist. Generating smoothed values of the primary
 269 data points requires a SEASONAL <strong>RRA</strong> and either an HWPREDICT or MHWPREDICT
 270 <strong>RRA</strong>. Aberrant behavior detection requires FAILURES, DEVSEASONAL, SEASONAL,
 271 and either HWPREDICT or MHWPREDICT.</p>
 272 <p>The predicted, or smoothed, values are stored in the HWPREDICT or MHWPREDICT
 273 <strong>RRA</strong>. HWPREDICT and MHWPREDICT are actually two variations on the
 274 Holt-Winters method. They are interchangeable. Both attempt to decompose data
 275 into three components: a baseline, a trend, and a seasonal coefficient.
 276 HWPREDICT adds its seasonal coefficient to the baseline to form a prediction, whereas
 277 MHWPREDICT multiplies its seasonal coefficient by the baseline to form a
 278 prediction. The difference is noticeable when the baseline changes
 279 significantly in the course of a season; HWPREDICT will predict the seasonality
 280 to stay constant as the baseline changes, but MHWPREDICT will predict the
 281 seasonality to grow or shrink in proportion to the baseline. The proper choice
 282 of method depends on the thing being modeled. For simplicity, the rest of this
 283 discussion will refer to HWPREDICT, but MHWPREDICT may be substituted in its
 284 place.</p>
 285 <p>The predicted deviations are stored in DEVPREDICT (think a standard deviation
 286 which can be scaled to yield a confidence band). The FAILURES <strong>RRA</strong> stores
 287 binary indicators. A 1 marks the indexed observation as failure; that is, the
 288 number of confidence bounds violations in the preceding window of observations
 289 met or exceeded a specified threshold. An example of using these <strong>RRAs</strong> to graph
 290 confidence bounds and failures appears in <a href="././rrdgraph.html">the rrdgraph manpage</a>.</p>
 291 <p>The SEASONAL and DEVSEASONAL <strong>RRAs</strong> store the seasonal coefficients for the
 292 Holt-Winters forecasting algorithm and the seasonal deviations, respectively.
 293 There is one entry per observation time point in the seasonal cycle. For
 294 example, if primary data points are generated every five minutes and the
 295 seasonal cycle is 1 day, both SEASONAL and DEVSEASONAL will have 288 rows.</p>
 296 <p>In order to simplify the creation for the novice user, in addition to
 297 supporting explicit creation of the HWPREDICT, SEASONAL, DEVPREDICT,
 298 DEVSEASONAL, and FAILURES <strong>RRAs</strong>, the <strong>RRDtool</strong> create command supports
 299 implicit creation of the other four when HWPREDICT is specified alone and
 300 the final argument <em>rra-num</em> is omitted.</p>
 301 <p><em>rows</em> specifies the length of the <strong>RRA</strong> prior to wrap around. Remember
 302 that there is a one-to-one correspondence between primary data points and
 303 entries in these RRAs. For the HWPREDICT CF, <em>rows</em> should be larger than
 304 the <em>seasonal period</em>. If the DEVPREDICT <strong>RRA</strong> is implicitly created, the
 305 default number of rows is the same as the HWPREDICT <em>rows</em> argument. If the
 306 FAILURES <strong>RRA</strong> is implicitly created, <em>rows</em> will be set to the <em>seasonal
 307 period</em> argument of the HWPREDICT <strong>RRA</strong>. Of course, the <strong>RRDtool</strong>
 308 <em>resize</em> command is available if these defaults are not sufficient and the
 309 creator wishes to avoid explicit creations of the other specialized function
 310 <strong>RRAs</strong>.</p>
 311 <p><em>seasonal period</em> specifies the number of primary data points in a seasonal
 312 cycle. If SEASONAL and DEVSEASONAL are implicitly created, this argument for
 313 those <strong>RRAs</strong> is set automatically to the value specified by HWPREDICT. If
 314 they are explicitly created, the creator should verify that all three
 315 <em>seasonal period</em> arguments agree.</p>
 316 <p><em>alpha</em> is the adaption parameter of the intercept (or baseline)
 317 coefficient in the Holt-Winters forecasting algorithm. See <a href="././rrdtool.html">the rrdtool manpage</a> for a
 318 description of this algorithm. <em>alpha</em> must lie between 0 and 1. A value
 319 closer to 1 means that more recent observations carry greater weight in
 320 predicting the baseline component of the forecast. A value closer to 0 means
 321 that past history carries greater weight in predicting the baseline
 322 component.</p>
 323 <p><em>beta</em> is the adaption parameter of the slope (or linear trend) coefficient
 324 in the Holt-Winters forecasting algorithm. <em>beta</em> must lie between 0 and 1
 325 and plays the same role as <em>alpha</em> with respect to the predicted linear
 326 trend.</p>
 327 <p><em>gamma</em> is the adaption parameter of the seasonal coefficients in the
 328 Holt-Winters forecasting algorithm (HWPREDICT) or the adaption parameter in
 329 the exponential smoothing update of the seasonal deviations. It must lie
 330 between 0 and 1. If the SEASONAL and DEVSEASONAL <strong>RRAs</strong> are created
 331 implicitly, they will both have the same value for <em>gamma</em>: the value
 332 specified for the HWPREDICT <em>alpha</em> argument. Note that because there is
 333 one seasonal coefficient (or deviation) for each time point during the
 334 seasonal cycle, the adaptation rate is much slower than the baseline. Each
 335 seasonal coefficient is only updated (or adapts) when the observed value
 336 occurs at the offset in the seasonal cycle corresponding to that
 337 coefficient.</p>
 338 <p>If SEASONAL and DEVSEASONAL <strong>RRAs</strong> are created explicitly, <em>gamma</em> need not
 339 be the same for both. Note that <em>gamma</em> can also be changed via the
 340 <strong>RRDtool</strong> <em>tune</em> command.</p>
 341 <p><em>smoothing-window</em> specifies the fraction of a season that should be
 342 averaged around each point. By default, the value of <em>smoothing-window</em> is
 343 0.05, which means each value in SEASONAL and DEVSEASONAL will be occasionally
 344 replaced by averaging it with its (<em>seasonal period</em>*0.05) nearest neighbors.
 345 Setting <em>smoothing-window</em> to zero will disable the running-average smoother
 346 altogether.</p>
 347 <p><em>rra-num</em> provides the links between related <strong>RRAs</strong>. If HWPREDICT is
 348 specified alone and the other <strong>RRAs</strong> are created implicitly, then
 349 there is no need to worry about this argument. If <strong>RRAs</strong> are created
 350 explicitly, then carefully pay attention to this argument. For each
 351 <strong>RRA</strong> which includes this argument, there is a dependency between
 352 that <strong>RRA</strong> and another <strong>RRA</strong>. The <em>rra-num</em> argument is the 1-based
 353 index in the order of <strong>RRA</strong> creation (that is, the order they appear
 354 in the <em>create</em> command). The dependent <strong>RRA</strong> for each <strong>RRA</strong>
 355 requiring the <em>rra-num</em> argument is listed here:</p>
 356 <ul>
 357 <li>
 358 <p>HWPREDICT <em>rra-num</em> is the index of the SEASONAL <strong>RRA</strong>.</p>
 359 </li>
 360 <li>
 361 <p>SEASONAL <em>rra-num</em> is the index of the HWPREDICT <strong>RRA</strong>.</p>
 362 </li>
 363 <li>
 364 <p>DEVPREDICT <em>rra-num</em> is the index of the DEVSEASONAL <strong>RRA</strong>.</p>
 365 </li>
 366 <li>
 367 <p>DEVSEASONAL <em>rra-num</em> is the index of the HWPREDICT <strong>RRA</strong>.</p>
 368 </li>
 369 <li>
 370 <p>FAILURES <em>rra-num</em> is the index of the DEVSEASONAL <strong>RRA</strong>.</p>
 371 </li>
 372 </ul>
 373 <p><em>threshold</em> is the minimum number of violations (observed values outside
 374 the confidence bounds) within a window that constitutes a failure. If the
 375 FAILURES <strong>RRA</strong> is implicitly created, the default value is 7.</p>
 376 <p><em>window length</em> is the number of time points in the window. Specify an
 377 integer greater than or equal to the threshold and less than or equal to 28.
 378 The time interval this window represents depends on the interval between
 379 primary data points. If the FAILURES <strong>RRA</strong> is implicitly created, the
 380 default value is 9.</p>
 381 <p>
 382 </p>
 383 <hr />
 384 <h1><a name="the_heartbeat_and_the_step">The HEARTBEAT and the STEP</a></h1>
 385 <p>Here is an explanation by Don Baarda on the inner workings of RRDtool.
 386 It may help you to sort out why all this *UNKNOWN* data is popping
 387 up in your databases:</p>
 388 <p>RRDtool gets fed samples/updates at arbitrary times. From these it builds Primary
 389 Data Points (PDPs) on every ``step'' interval. The PDPs are
 390 then accumulated into the RRAs.</p>
 391 <p>The ``heartbeat'' defines the maximum acceptable interval between
 392 samples/updates. If the interval between samples is less than ``heartbeat'',
 393 then an average rate is calculated and applied for that interval. If
 394 the interval between samples is longer than ``heartbeat'', then that
 395 entire interval is considered ``unknown''. Note that there are other
 396 things that can make a sample interval ``unknown'', such as the rate
 397 exceeding limits, or a sample that was explicitly marked as unknown.</p>
 398 <p>The known rates during a PDP's ``step'' interval are used to calculate
 399 an average rate for that PDP. If the total ``unknown'' time accounts for
 400 more than <strong>half</strong> the ``step'', the entire PDP is marked
 401 as ``unknown''. This means that a mixture of known and ``unknown'' sample
 402 times in a single PDP ``step'' may or may not add up to enough ``known''
 403 time to warrent for a known PDP.</p>
 404 <p>The ``heartbeat'' can be short (unusual) or long (typical) relative to
 405 the ``step'' interval between PDPs. A short ``heartbeat'' means you
 406 require multiple samples per PDP, and if you don't get them mark the
 407 PDP unknown. A long heartbeat can span multiple ``steps'', which means
 408 it is acceptable to have multiple PDPs calculated from a single
 409 sample. An extreme example of this might be a ``step'' of 5 minutes and a
 410 ``heartbeat'' of one day, in which case a single sample every day will
 411 result in all the PDPs for that entire day period being set to the
 412 same average rate. <em>-- Don Baarda &lt;<a href="mailto:don.baarda@baesystems.com">don.baarda@baesystems.com</a>&gt;</em></p>
 413 <pre>
 414        time|
 415        axis|
 416  begin__|00|
 417         |01|
 418        u|02|----* sample1, restart &quot;hb&quot;-timer
 419        u|03|   /
 420        u|04|  /
 421        u|05| /
 422        u|06|/     &quot;hbt&quot; expired
 423        u|07|
 424         |08|----* sample2, restart &quot;hb&quot;
 425         |09|   /
 426         |10|  /
 427        u|11|----* sample3, restart &quot;hb&quot;
 428        u|12|   /
 429        u|13|  /
 430  step1_u|14| /
 431        u|15|/     &quot;swt&quot; expired
 432        u|16|
 433         |17|----* sample4, restart &quot;hb&quot;, create &quot;pdp&quot; for step1 =
 434         |18|   /  = unknown due to 10 &quot;u&quot; labled secs &gt; 0.5 * step
 435         |19|  /
 436         |20| /
 437         |21|----* sample5, restart &quot;hb&quot;
 438         |22|   /
 439         |23|  /
 440         |24|----* sample6, restart &quot;hb&quot;
 441         |25|   /
 442         |26|  /
 443         |27|----* sample7, restart &quot;hb&quot;
 444  step2__|28|   /
 445         |22|  /
 446         |23|----* sample8, restart &quot;hb&quot;, create &quot;pdp&quot; for step1, create &quot;cdp&quot;
 447         |24|   /
 448         |25|  /</pre>
 449 <p>graphics by <em><a href="mailto:vladimir.lavrov@desy.de">vladimir.lavrov@desy.de</a></em>.</p>
 450 <p>
 451 </p>
 452 <hr />
 453 <h1><a name="how_to_measure">HOW TO MEASURE</a></h1>
 454 <p>Here are a few hints on how to measure:</p>
 455 <dl>
 456 <dt><strong><a name="item_temperature">Temperature</a></strong></dt>
 457
 458 <dd>
 459 <p>Usually you have some type of meter you can read to get the temperature.
 460 The temperature is not really connected with a time. The only connection is
 461 that the temperature reading happened at a certain time. You can use the
 462 <strong>GAUGE</strong> data source type for this. RRDtool will then record your reading
 463 together with the time.</p>
 464 </dd>
 465 <dt><strong><a name="item_mail_messages">Mail Messages</a></strong></dt>
 466
 467 <dd>
 468 <p>Assume you have a method to count the number of messages transported by
 469 your mailserver in a certain amount of time, giving you data like '5
 470 messages in the last 65 seconds'. If you look at the count of 5 like an
 471 <strong>ABSOLUTE</strong> data type you can simply update the RRD with the number 5 and the
 472 end time of your monitoring period. RRDtool will then record the number of
 473 messages per second. If at some later stage you want to know the number of
 474 messages transported in a day, you can get the average messages per second
 475 from RRDtool for the day in question and multiply this number with the
 476 number of seconds in a day. Because all math is run with Doubles, the
 477 precision should be acceptable.</p>
 478 </dd>
 479 <dt><strong><a name="item_it_27s_always_a_rate">It's always a Rate</a></strong></dt>
 480
 481 <dd>
 482 <p>RRDtool stores rates in amount/second for COUNTER, DERIVE and ABSOLUTE
 483 data.  When you plot the data, you will get on the y axis
 484 amount/second which you might be tempted to convert to an absolute
 485 amount by multiplying by the delta-time between the points. RRDtool
 486 plots continuous data, and as such is not appropriate for plotting
 487 absolute amounts as for example ``total bytes'' sent and received in a
 488 router. What you probably want is plot rates that you can scale to
 489 bytes/hour, for example, or plot absolute amounts with another tool
 490 that draws bar-plots, where the delta-time is clear on the plot for
 491 each point (such that when you read the graph you see for example GB
 492 on the y axis, days on the x axis and one bar for each day).</p>
 493 </dd>
 494 </dl>
 495 <p>
 496 </p>
 497 <hr />
 498 <h1><a name="example">EXAMPLE</a></h1>
 499 <pre>
 500  rrdtool create temperature.rrd --step 300 \
 501   DS:temp:GAUGE:600:-273:5000 \
 502   RRA:AVERAGE:0.5:1:1200 \
 503   RRA:MIN:0.5:12:2400 \
 504   RRA:MAX:0.5:12:2400 \
 505   RRA:AVERAGE:0.5:12:2400</pre>
 506 <p>This sets up an <strong>RRD</strong> called <em>temperature.rrd</em> which accepts one
 507 temperature value every 300 seconds. If no new data is supplied for
 508 more than 600 seconds, the temperature becomes <em>*UNKNOWN*</em>.  The
 509 minimum acceptable value is -273 and the maximum is 5'000.</p>
 510 <p>A few archive areas are also defined. The first stores the
 511 temperatures supplied for 100 hours (1'200 * 300 seconds = 100
 512 hours). The second RRA stores the minimum temperature recorded over
 513 every hour (12 * 300 seconds = 1 hour), for 100 days (2'400 hours). The
 514 third and the fourth RRA's do the same for the maximum and
 515 average temperature, respectively.</p>
 516 <p>
 517 </p>
 518 <hr />
 519 <h1><a name="example_2">EXAMPLE 2</a></h1>
 520 <pre>
 521  rrdtool create monitor.rrd --step 300        \
 522    DS:ifOutOctets:COUNTER:1800:0:4294967295   \
 523    RRA:AVERAGE:0.5:1:2016                     \
 524    RRA:HWPREDICT:1440:0.1:0.0035:288</pre>
 525 <p>This example is a monitor of a router interface. The first <strong>RRA</strong> tracks the
 526 traffic flow in octets; the second <strong>RRA</strong> generates the specialized
 527 functions <strong>RRAs</strong> for aberrant behavior detection. Note that the <em>rra-num</em>
 528 argument of HWPREDICT is missing, so the other <strong>RRAs</strong> will implicitly be
 529 created with default parameter values. In this example, the forecasting
 530 algorithm baseline adapts quickly; in fact the most recent one hour of
 531 observations (each at 5 minute intervals) accounts for 75% of the baseline
 532 prediction. The linear trend forecast adapts much more slowly. Observations
 533 made during the last day (at 288 observations per day) account for only
 534 65% of the predicted linear trend. Note: these computations rely on an
 535 exponential smoothing formula described in the LISA 2000 paper.</p>
 536 <p>The seasonal cycle is one day (288 data points at 300 second intervals), and
 537 the seasonal adaption parameter will be set to 0.1. The RRD file will store 5
 538 days (1'440 data points) of forecasts and deviation predictions before wrap
 539 around. The file will store 1 day (a seasonal cycle) of 0-1 indicators in
 540 the FAILURES <strong>RRA</strong>.</p>
 541 <p>The same RRD file and <strong>RRAs</strong> are created with the following command,
 542 which explicitly creates all specialized function <strong>RRAs</strong>.</p>
 543 <pre>
 544  rrdtool create monitor.rrd --step 300 \
 545    DS:ifOutOctets:COUNTER:1800:0:4294967295 \
 546    RRA:AVERAGE:0.5:1:2016 \
 547    RRA:HWPREDICT:1440:0.1:0.0035:288:3 \
 548    RRA:SEASONAL:288:0.1:2 \
 549    RRA:DEVPREDICT:1440:5 \
 550    RRA:DEVSEASONAL:288:0.1:2 \
 551    RRA:FAILURES:288:7:9:5</pre>
 552 <p>Of course, explicit creation need not replicate implicit create, a
 553 number of arguments could be changed.</p>
 554 <p>
 555 </p>
 556 <hr />
 557 <h1><a name="example_3">EXAMPLE 3</a></h1>
 558 <pre>
 559  rrdtool create proxy.rrd --step 300 \
 560    DS:Total:DERIVE:1800:0:U  \
 561    DS:Duration:DERIVE:1800:0:U  \
 562    DS:AvgReqDur:COMPUTE:Duration,Requests,0,EQ,1,Requests,IF,/ \
 563    RRA:AVERAGE:0.5:1:2016</pre>
 564 <p>This example is monitoring the average request duration during each 300 sec
 565 interval for requests processed by a web proxy during the interval.
 566 In this case, the proxy exposes two counters, the number of requests
 567 processed since boot and the total cumulative duration of all processed
 568 requests. Clearly these counters both have some rollover point, but using the
 569 DERIVE data source also handles the reset that occurs when the web proxy is
 570 stopped and restarted.</p>
 571 <p>In the <strong>RRD</strong>, the first data source stores the requests per second rate
 572 during the interval. The second data source stores the total duration of all
 573 requests processed during the interval divided by 300. The COMPUTE data source
 574 divides each PDP of the AccumDuration by the corresponding PDP of
 575 TotalRequests and stores the average request duration. The remainder of the
 576 RPN expression handles the divide by zero case.</p>
 577 <p>
 578 </p>
 579 <hr />
 580 <h1><a name="author">AUTHOR</a></h1>
 581 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 582
 583 </body>
 584
 585 </html>