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