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