doc/rrdtool.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>rrdtool</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
  13 <!-- INDEX BEGIN -->
  14 <div name="index">
  15 <p><a name="__index__"></a></p>
  16 <!--
  17
  18 <ul>
  19
  20         <li><a href="#name">NAME</a></li>
  21         <li><a href="#synopsis">SYNOPSIS</a></li>
  22         <li><a href="#description">DESCRIPTION</a></li>
  23         <ul>
  24
  25                 <li><a href="#overview">OVERVIEW</a></li>
  26                 <li><a href="#functions">FUNCTIONS</a></li>
  27                 <li><a href="#how_does_rrdtool_work">HOW DOES RRDTOOL WORK?</a></li>
  28                 <li><a href="#remote_control">REMOTE CONTROL</a></li>
  29                 <li><a href="#rrd_server">RRD Server</a></li>
  30         </ul>
  31
  32         <li><a href="#rrdcached__the_caching_daemon">RRDCACHED, THE CACHING DAEMON</a></li>
  33         <li><a href="#see_also">SEE ALSO</a></li>
  34         <li><a href="#bugs">BUGS</a></li>
  35         <li><a href="#author">AUTHOR</a></li>
  36 </ul>
  37
  38 -->
  39
  40
  41 </div>
  42 <!-- INDEX END -->
  43
  44 <p>
  45 </p>
  46 <h1><a name="name">NAME</a></h1>
  47 <p>rrdtool - Round Robin Database Tool</p>
  48 <p>
  49 </p>
  50 <hr />
  51 <h1><a name="synopsis">SYNOPSIS</a></h1>
  52 <p><strong>rrdtool</strong> <strong>-</strong> [workdir]| <em>function</em></p>
  53 <p>
  54 </p>
  55 <hr />
  56 <h1><a name="description">DESCRIPTION</a></h1>
  57 <p>
  58 </p>
  59 <h2><a name="overview">OVERVIEW</a></h2>
  60 <p>It is pretty easy to gather status information from all sorts of
  61 things, ranging from the temperature in your office to the number of
  62 octets which have passed through the FDDI interface of your
  63 router. But it is not so trivial to store this data in an efficient and
  64 systematic manner. This is where <strong>RRDtool</strong> comes in handy. It lets you
  65 <em>log and analyze</em> the data you gather from all kinds of data-sources
  66 (<strong>DS</strong>). The data analysis part of RRDtool is based on the ability to
  67 quickly generate graphical representations of the data values
  68 collected over a definable time period.</p>
  69 <p>In this man page you will find general information on the design and
  70 functionality of the Round Robin Database Tool (RRDtool). For a more
  71 detailed description of how to use the individual functions of
  72 <strong>RRDtool</strong> check the corresponding man page.</p>
  73 <p>For an introduction to the usage of RRDtool make sure you consult the
  74 <a href="././rrdtutorial.html">the rrdtutorial manpage</a>.</p>
  75 <p>
  76 </p>
  77 <h2><a name="functions">FUNCTIONS</a></h2>
  78 <p>While the man pages talk of command line switches you have to set in
  79 order to make <strong>RRDtool</strong> work it is important to note that
  80 <strong>RRDtool</strong> can be remotely controlled through a set of pipes. This
  81 saves a considerable amount of startup time when you plan to make
  82 <strong>RRDtool</strong> do a lot of things quickly. Check the section on <em>Remote_Control</em>
  83 further down. There is also a number of language bindings
  84 for RRDtool which allow you to use it directly from Perl, python, Tcl,
  85 PHP, etc.</p>
  86 <dl>
  87 <dt><strong><a name="create" class="item"><strong>create</strong></a></strong></dt>
  88
  89 <dd>
  90 <p>Set up a new Round Robin Database (RRD). Check <a href="././rrdcreate.html">the rrdcreate manpage</a>.</p>
  91 </dd>
  92 <dt><strong><a name="update" class="item"><strong>update</strong></a></strong></dt>
  93
  94 <dd>
  95 <p>Store new data values into an RRD. Check <a href="././rrdupdate.html">the rrdupdate manpage</a>.</p>
  96 </dd>
  97 <dt><strong><a name="updatev" class="item"><strong>updatev</strong></a></strong></dt>
  98
  99 <dd>
 100 <p>Operationally equivalent to <strong>update</strong> except for output. Check <a href="././rrdupdate.html">the rrdupdate manpage</a>.</p>
 101 </dd>
 102 <dt><strong><a name="graph" class="item"><strong>graph</strong></a></strong></dt>
 103
 104 <dd>
 105 <p>Create a graph from data stored in one or several RRDs. Apart from
 106 generating graphs, data can also be extracted to stdout. Check <a href="././rrdgraph.html">the rrdgraph manpage</a>.</p>
 107 </dd>
 108 <dt><strong><a name="dump" class="item"><strong>dump</strong></a></strong></dt>
 109
 110 <dd>
 111 <p>Dump the contents of an RRD in plain ASCII. In connection with restore
 112 you can use this to move an RRD from one computer architecture to
 113 another.  Check <a href="././rrddump.html">the rrddump manpage</a>.</p>
 114 </dd>
 115 <dt><strong><a name="restore" class="item"><strong>restore</strong></a></strong></dt>
 116
 117 <dd>
 118 <p>Restore an RRD in XML format to a binary RRD. Check <a href="././rrdrestore.html">the rrdrestore manpage</a></p>
 119 </dd>
 120 <dt><strong><a name="fetch" class="item"><strong>fetch</strong></a></strong></dt>
 121
 122 <dd>
 123 <p>Get data for a certain time period from a RRD. The graph function
 124 uses fetch to retrieve its data from an RRD. Check <a href="././rrdfetch.html">the rrdfetch manpage</a>.</p>
 125 </dd>
 126 <dt><strong><a name="tune" class="item"><strong>tune</strong></a></strong></dt>
 127
 128 <dd>
 129 <p>Alter setup of an RRD. Check <a href="././rrdtune.html">the rrdtune manpage</a>.</p>
 130 </dd>
 131 <dt><strong><a name="last" class="item"><strong>last</strong></a></strong></dt>
 132
 133 <dd>
 134 <p>Find the last update time of an RRD. Check <a href="././rrdlast.html">the rrdlast manpage</a>.</p>
 135 </dd>
 136 <dt><strong><a name="info" class="item"><strong>info</strong></a></strong></dt>
 137
 138 <dd>
 139 <p>Get information about an RRD. Check <a href="././rrdinfo.html">the rrdinfo manpage</a>.</p>
 140 </dd>
 141 <dt><strong><a name="rrdresize" class="item"><strong>rrdresize</strong></a></strong></dt>
 142
 143 <dd>
 144 <p>Change the size of individual RRAs. This is dangerous! Check <a href="././rrdresize.html">the rrdresize manpage</a>.</p>
 145 </dd>
 146 <dt><strong><a name="xport" class="item"><strong>xport</strong></a></strong></dt>
 147
 148 <dd>
 149 <p>Export data retrieved from one or several RRDs. Check <a href="././rrdxport.html">the rrdxport manpage</a>.</p>
 150 </dd>
 151 <dt><strong><a name="flushcached" class="item"><strong>flushcached</strong></a></strong></dt>
 152
 153 <dd>
 154 <p>Flush the values for a specific RRD file from memory. Check <a href="././rrdflushcached.html">the rrdflushcached manpage</a>.</p>
 155 </dd>
 156 <dt><strong><a name="rrdcgi" class="item"><strong>rrdcgi</strong></a></strong></dt>
 157
 158 <dd>
 159 <p>This is a standalone tool for producing RRD graphs on the fly. Check
 160 <a href="././rrdcgi.html">the rrdcgi manpage</a>.</p>
 161 </dd>
 162 </dl>
 163 <p>
 164 </p>
 165 <h2><a name="how_does_rrdtool_work">HOW DOES RRDTOOL WORK?</a></h2>
 166 <dl>
 167 <dt><strong><a name="data_acquisition" class="item">Data Acquisition</a></strong></dt>
 168
 169 <dd>
 170 <p>When monitoring the state of a system, it is convenient to have the
 171 data available at a constant time interval. Unfortunately, you may not
 172 always be able to fetch data at exactly the time you want
 173 to. Therefore <strong>RRDtool</strong> lets you update the logfile at any time you
 174 want. It will automatically interpolate the value of the data-source
 175 (<strong>DS</strong>) at the latest official time-slot (interval) and write this
 176 interpolated value to the log. The original value you have supplied is
 177 stored as well and is also taken into account when interpolating the
 178 next log entry.</p>
 179 </dd>
 180 <dt><strong><a name="consolidation" class="item">Consolidation</a></strong></dt>
 181
 182 <dd>
 183 <p>You may log data at a 1 minute interval, but you might also be
 184 interested to know the development of the data over the last year. You
 185 could do this by simply storing the data in 1 minute intervals for the
 186 whole year. While this would take considerable disk space it would
 187 also take a lot of time to analyze the data when you wanted to create
 188 a graph covering the whole year. <strong>RRDtool</strong> offers a solution to this
 189 problem through its data consolidation feature. When setting up an
 190 Round Robin Database (<strong>RRD</strong>), you can define at which interval this
 191 consolidation should occur, and what consolidation function (<strong>CF</strong>)
 192 (average, minimum, maximum, total, last) should be used to build the
 193 consolidated values (see rrdcreate). You can define any number of
 194 different consolidation setups within one <strong>RRD</strong>. They will all be
 195 maintained on the fly when new data is loaded into the <strong>RRD</strong>.</p>
 196 </dd>
 197 <dt><strong><a name="round_robin_archives" class="item">Round Robin Archives</a></strong></dt>
 198
 199 <dd>
 200 <p>Data values of the same consolidation setup are stored into Round
 201 Robin Archives (<strong>RRA</strong>). This is a very efficient manner to store data
 202 for a certain amount of time, while using a known and constant amount
 203 of storage space.</p>
 204 <p>It works like this: If you want to store 1'000 values in 5 minute
 205 interval, <strong>RRDtool</strong> will allocate space for 1'000 data values and a
 206 header area. In the header it will store a pointer telling which slots
 207 (value) in the storage area was last written to. New values are
 208 written to the Round Robin Archive in, you guessed it, a round robin
 209 manner. This automatically limits the history to the last 1'000 values
 210 (in our example). Because you can define several <strong>RRA</strong>s within a
 211 single <strong>RRD</strong>, you can setup another one, for storing 750 data values
 212 at a 2 hour interval, for example, and thus keep a log for the last
 213 two months at a lower resolution.</p>
 214 <p>The use of <strong>RRA</strong>s guarantees that the <strong>RRD</strong> does not grow over
 215 time and that old data is automatically eliminated. By using the
 216 consolidation feature, you can still keep data for a very long time,
 217 while gradually reducing the resolution of the data along the time
 218 axis.</p>
 219 <p>Using different consolidation functions (<strong>CF</strong>) allows you to store
 220 exactly the type of information that actually interests you: the maximum
 221 one minute traffic on the LAN, the minimum temperature of your wine cellar,
 222 the total minutes of down time, etc.</p>
 223 </dd>
 224 <dt><strong><a name="unknown_data" class="item">Unknown Data</a></strong></dt>
 225
 226 <dd>
 227 <p>As mentioned earlier, the <strong>RRD</strong> stores data at a constant
 228 interval. Sometimes it may happen that no new data is available when a
 229 value has to be written to the <strong>RRD</strong>. Data acquisition may not be
 230 possible for one reason or other. With <strong>RRDtool</strong> you can handle these
 231 situations by storing an <em>*UNKNOWN*</em> value into the database. The
 232 value '<em>*UNKNOWN*</em>' is supported through all the functions of the
 233 tool. When consolidating a data set, the amount of <em>*UNKNOWN*</em> data
 234 values is accounted for and when a new consolidated value is ready to
 235 be written to its Round Robin Archive (<strong>RRA</strong>), a validity check is
 236 performed to make sure that the percentage of unknown values in the
 237 data point is above a configurable level. If not, an <em>*UNKNOWN*</em> value
 238 will be written to the <strong>RRA</strong>.</p>
 239 </dd>
 240 <dt><strong><a name="graphing" class="item">Graphing</a></strong></dt>
 241
 242 <dd>
 243 <p><strong>RRDtool</strong> allows you to generate reports in numerical and
 244 graphical form based on the data stored in one or several
 245 <strong>RRD</strong>s. The graphing feature is fully configurable. Size, color and
 246 contents of the graph can be defined freely. Check <a href="././rrdgraph.html">the rrdgraph manpage</a>
 247 for more information on this.</p>
 248 </dd>
 249 <dt><strong><a name="aberrant_behavior_detection" class="item">Aberrant Behavior Detection</a></strong></dt>
 250
 251 <dd>
 252 <p>by Jake Brutlag</p>
 253 <p><strong>RRDtool</strong> provides the building blocks for near real-time aberrant
 254 behavior detection. These components include:</p>
 255 <ul>
 256 <li>
 257 <p>An algorithm for predicting the value of a time series one time step
 258 into the future.</p>
 259 </li>
 260 <li>
 261 <p>A measure of deviation between predicted and observed values.</p>
 262 </li>
 263 <li>
 264 <p>A mechanism to decide if and when an observed value or sequence of
 265 observed values is <em>too deviant</em> from the predicted value(s).</p>
 266 </li>
 267 </ul>
 268 <p>Here is a brief explanation of these components:</p>
 269 <p>The Holt-Winters time series forecasting algorithm is an on-line (or
 270 incremental) algorithm that adaptively predicts future observations in
 271 a time series. Its forecast is the sum of three components: a baseline
 272 (or intercept), a linear trend over time (or slope), and a seasonal
 273 coefficient (a periodic effect, such as a daily cycle). There is one
 274 seasonal coefficient for each time point in the period (cycle). After
 275 a value is observed, each of these components is updated via
 276 exponential smoothing. This means that the algorithm &quot;learns&quot; from
 277 past values and uses them to predict the future. The rate of
 278 adaptation is governed by 3 parameters, alpha (intercept), beta
 279 (slope), and gamma (seasonal). The prediction can also be viewed as a
 280 smoothed value for the time series.</p>
 281 <p>The measure of deviation is a seasonal weighted absolute
 282 deviation. The term <em>seasonal</em> means deviation is measured separately
 283 for each time point in the seasonal cycle. As with Holt-Winters
 284 forecasting, deviation is predicted using the measure computed from
 285 past values (but only at that point in the seasonal cycle). After the
 286 value is observed, the algorithm learns from the observed value via
 287 exponential smoothing. Confidence bands for the observed time series
 288 are generated by scaling the sequence of predicted deviation values
 289 (we usually think of the sequence as a continuous line rather than a
 290 set of discrete points).</p>
 291 <p>Aberrant behavior (a potential failure) is reported whenever the
 292 number of times the observed value violates the confidence bands meets
 293 or exceeds a specified threshold within a specified temporal window
 294 (e.g. 5 violations during the past 45 minutes with a value observed
 295 every 5 minutes).</p>
 296 <p>This functionality is embedded in a set of related <strong>RRAs</strong>. In
 297 particular, a FAILURES <strong>RRA</strong> logs potential failures. With these data
 298 you could, for example, use a front-end application to <strong>RRDtool</strong> to
 299 initiate real-time alerts.</p>
 300 <p>For a detailed description on how to set this up, see <a href="././rrdcreate.html">the rrdcreate manpage</a>.</p>
 301 </dd>
 302 </dl>
 303 <p>
 304 </p>
 305 <h2><a name="remote_control">REMOTE CONTROL</a></h2>
 306 <p>When you start <strong>RRDtool</strong> with the command line option '<strong>-</strong>' it waits
 307 for input via standard input (STDIN). With this feature you can
 308 improve performance by attaching <strong>RRDtool</strong> to another process (MRTG
 309 is one example) through a set of pipes. Over these pipes <strong>RRDtool</strong>
 310 accepts the same arguments as on the command line and some special
 311 commands like <strong>quit, cd, mkdir</strong> and <strong>ls</strong>. For detailed help on the
 312 server commands type:</p>
 313 <pre>
 314    rrdtool help cd|mkdir|pwd|ls|quit</pre>
 315 <p>When a command is completed, RRDtool will print the string  '<code>OK</code>',
 316 followed by timing information of the form <strong>u:</strong><em>usertime</em>
 317 <strong>s:</strong><em>systemtime</em>. Both values are the running totals of seconds since
 318 RRDtool was started. If an error occurs, a line of the form '<code>ERROR:</code>
 319 <em>Description of error</em>' will be printed instead. <strong>RRDtool</strong> will not abort,
 320 unless something really serious happens. If
 321 a <strong>workdir</strong> is specified and the UID is 0, RRDtool will do a chroot to that
 322 workdir. If the UID is not 0, RRDtool only changes the current directory to
 323 <strong>workdir</strong>.</p>
 324 <p>
 325 </p>
 326 <h2><a name="rrd_server">RRD Server</a></h2>
 327 <p>If you want to create a RRD-Server, you must choose a TCP/IP Service
 328 number and add them to <em>/etc/services</em> like this:</p>
 329 <pre>
 330  rrdsrv      13900/tcp                       # RRD server</pre>
 331 <p>Attention: the TCP port 13900 isn't officially registered for
 332 rrdsrv. You can use any unused port in your services file, but the
 333 server and the client system must use the same port, of course.</p>
 334 <p>With this configuration you can add RRDtool as meta-server to
 335 <em>/etc/inetd.conf</em>. For example:</p>
 336 <pre>
 337  rrdsrv stream tcp nowait root /opt/rrd/bin/rrdtool rrdtool - /var/rrd</pre>
 338 <p>Don't forget to create the database directory /var/rrd and
 339 reinitialize your inetd.</p>
 340 <p>If all was setup correctly, you can access the server with Perl
 341 sockets, tools like netcat, or in a quick interactive test by using
 342 'telnet localhost rrdsrv'.</p>
 343 <p><strong>NOTE:</strong> that there is no authentication with this feature! Do not setup
 344 such a port unless you are sure what you are doing.</p>
 345 <p>
 346 </p>
 347 <hr />
 348 <h1><a name="rrdcached__the_caching_daemon">RRDCACHED, THE CACHING DAEMON</a></h1>
 349 <p>For very big setups, updating thousands of RRD files often becomes a serious IO
 350 problem. If you run into such problems, you might want to take a look at
 351 <a href="././rrdcached.html">the rrdcached manpage</a>, a caching daemon for RRDTool which may help you lessen the
 352 stress on your disks.</p>
 353 <p>
 354 </p>
 355 <hr />
 356 <h1><a name="see_also">SEE ALSO</a></h1>
 357 <p>rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast, rrdxport,
 358 rrdflushcached, rrdcached</p>
 359 <p>
 360 </p>
 361 <hr />
 362 <h1><a name="bugs">BUGS</a></h1>
 363 <p>Bugs? Features!</p>
 364 <p>
 365 </p>
 366 <hr />
 367 <h1><a name="author">AUTHOR</a></h1>
 368 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 369
 370 </body>
 371
 372 </html>