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