![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdtool.txt b/doc/rrdtool.txt
index 113857ef4b10f51d817969067f5796c51a911bbe..f6115a798adbd7a4d9a5c37ebfbec89c1dc8983e 100644 (file)
--- a/doc/rrdtool.txt
+++ b/doc/rrdtool.txt
r\brr\brd\bdt\bto\boo\bol\bl -\b- [workdir]| _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
- O\bOV\bVE\bER\bRV\bVI\bIE\bEW\bW
-
+ O\bOV\bVE\bER\bRV\bVI\bIE\bEW\bW
It is pretty easy to gather status information from all sorts of
things, ranging from the temperature in your office to the number of
octets which have passed through the FDDI interface of your router. But
it is not so trivial to store this data in an efficient and systematic
- manner. This is where R\bRR\bRD\bDt\bto\boo\bol\bl comes in handy. It lets you _\bl_\bo_\bg _\ba_\bn_\bd _\ba_\bn_\ba_\b-
- _\bl_\by_\bz_\be the data you gather from all kinds of data-sources (D\bDS\bS). The data
- analysis part of RRDtool is based on the ability to quickly generate
- graphical representations of the data values collected over a definable
- time period.
+ manner. This is where R\bRR\bRD\bDt\bto\boo\bol\bl comes in handy. It lets you _\bl_\bo_\bg _\ba_\bn_\bd
+ _\ba_\bn_\ba_\bl_\by_\bz_\be the data you gather from all kinds of data-sources (D\bDS\bS). The
+ data analysis part of RRDtool is based on the ability to quickly
+ generate graphical representations of the data values collected over a
+ definable time period.
In this man page you will find general information on the design and
functionality of the Round Robin Database Tool (RRDtool). For a more
For an introduction to the usage of RRDtool make sure you consult the
rrdtutorial.
- F\bFU\bUN\bNC\bCT\bTI\bIO\bON\bNS\bS
-
+ F\bFU\bUN\bNC\bCT\bTI\bIO\bON\bNS\bS
While the man pages talk of command line switches you have to set in
order to make R\bRR\bRD\bDt\bto\boo\bol\bl work it is important to note that R\bRR\bRD\bDt\bto\boo\bol\bl can be
remotely controlled through a set of pipes. This saves a considerable
r\bre\bes\bst\bto\bor\bre\be Restore an RRD in XML format to a binary RRD. Check rrdrestore
- f\bfe\bet\btc\bch\bh Get data for a certain time period from a RRD. The graph func-
- tion uses fetch to retrieve its data from an RRD. Check rrd-
- fetch.
+ f\bfe\bet\btc\bch\bh Get data for a certain time period from a RRD. The graph
+ function uses fetch to retrieve its data from an RRD. Check
+ rrdfetch.
t\btu\bun\bne\be Alter setup of an RRD. Check rrdtune.
r\brr\brd\bdc\bcg\bgi\bi This is a standalone tool for producing RRD graphs on the fly.
Check rrdcgi.
- H\bHO\bOW\bW D\bDO\bOE\bES\bS R\bRR\bRD\bDT\bTO\bOO\bOL\bL W\bWO\bOR\bRK\bK?\b?
-
-
+ H\bHO\bOW\bW D\bDO\bOE\bES\bS R\bRR\bRD\bDT\bTO\bOO\bOL\bL W\bWO\bOR\bRK\bK?\b?
Data Acquisition
When monitoring the state of a system, it is convenient to have
the data available at a constant time interval. Unfortunately,
You may log data at a 1 minute interval, but you might also be
interested to know the development of the data over the last
year. You could do this by simply storing the data in 1 minute
- intervals for the whole year. While this would take consider-
- able disk space it would also take a lot of time to analyze the
- data when you wanted to create a graph covering the whole year.
- R\bRR\bRD\bDt\bto\boo\bol\bl offers a solution to this problem through its data con-
- solidation feature. When setting up an Round Robin Database
- (R\bRR\bRD\bD), you can define at which interval this consolidation
- should occur, and what consolidation function (C\bCF\bF) (average,
- minimum, maximum, total, last) should be used to build the con-
- solidated values (see rrdcreate). You can define any number of
- different consolidation setups within one R\bRR\bRD\bD. They will all be
- maintained on the fly when new data is loaded into the R\bRR\bRD\bD.
+ intervals for the whole year. While this would take
+ considerable disk space it would also take a lot of time to
+ analyze the data when you wanted to create a graph covering the
+ whole year. R\bRR\bRD\bDt\bto\boo\bol\bl offers a solution to this problem through
+ its data consolidation feature. When setting up an Round Robin
+ Database (R\bRR\bRD\bD), you can define at which interval this
+ consolidation should occur, and what consolidation function
+ (C\bCF\bF) (average, minimum, maximum, total, last) should be used to
+ build the consolidated values (see rrdcreate). You can define
+ any number of different consolidation setups within one R\bRR\bRD\bD.
+ They will all be maintained on the fly when new data is loaded
+ into the R\bRR\bRD\bD.
Round Robin Archives
Data values of the same consolidation setup are stored into
It works like this: If you want to store 1'000 values in 5
minute interval, R\bRR\bRD\bDt\bto\boo\bol\bl will allocate space for 1'000 data
values and a header area. In the header it will store a pointer
- telling which slots (value) in the storage area was last writ-
- ten to. New values are written to the Round Robin Archive in,
- you guessed it, a round robin manner. This automatically limits
- the history to the last 1'000 values (in our example). Because
- you can define several R\bRR\bRA\bAs within a single R\bRR\bRD\bD, you can setup
- another one, for storing 750 data values at a 2 hour interval,
- for example, and thus keep a log for the last two months at a
- lower resolution.
+ telling which slots (value) in the storage area was last
+ written to. New values are written to the Round Robin Archive
+ in, you guessed it, a round robin manner. This automatically
+ limits the history to the last 1'000 values (in our example).
+ Because you can define several R\bRR\bRA\bAs within a single R\bRR\bRD\bD, you
+ can setup another one, for storing 750 data values at a 2 hour
+ interval, for example, and thus keep a log for the last two
+ months at a lower resolution.
The use of R\bRR\bRA\bAs guarantees that the R\bRR\bRD\bD does not grow over time
and that old data is automatically eliminated. By using the
time, etc.
Unknown Data
- As mentioned earlier, the R\bRR\bRD\bD stores data at a constant inter-
- val. Sometimes it may happen that no new data is available when
- a value has to be written to the R\bRR\bRD\bD. Data acquisition may not
- be possible for one reason or other. With R\bRR\bRD\bDt\bto\boo\bol\bl you can han-
- dle these situations by storing an _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* value into the
+ As mentioned earlier, the R\bRR\bRD\bD stores data at a constant
+ interval. Sometimes it may happen that no new data is available
+ when a value has to be written to the R\bRR\bRD\bD. Data acquisition may
+ not be possible for one reason or other. With R\bRR\bRD\bDt\bto\boo\bol\bl you can
+ handle these situations by storing an _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* value into the
database. The value '_\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*' is supported through all the
functions of the tool. When consolidating a data set, the
amount of _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data values is accounted for and when a new
to the R\bRR\bRA\bA.
Graphing
- R\bRR\bRD\bDt\bto\boo\bol\bl allows you to generate reports in numerical and graphi-
- cal form based on the data stored in one or several R\bRR\bRD\bDs. The
- graphing feature is fully configurable. Size, color and con-
- tents of the graph can be defined freely. Check rrdgraph for
+ R\bRR\bRD\bDt\bto\boo\bol\bl allows you to generate reports in numerical and
+ graphical form based on the data stored in one or several R\bRR\bRD\bDs.
+ The graphing feature is fully configurable. Size, color and
+ contents of the graph can be defined freely. Check rrdgraph for
more information on this.
Aberrant Behavior Detection
by Jake Brutlag
- R\bRR\bRD\bDt\bto\boo\bol\bl provides the building blocks for near real-time aber-
- rant behavior detection. These components include:
+ R\bRR\bRD\bDt\bto\boo\bol\bl provides the building blocks for near real-time
+ aberrant behavior detection. These components include:
- * An algorithm for predicting the value of a time series one
+ · An algorithm for predicting the value of a time series one
time step into the future.
- * A measure of deviation between predicted and observed val-
- ues.
+ · A measure of deviation between predicted and observed
+ values.
- * A mechanism to decide if and when an observed value or
- sequence of observed values is _\bt_\bo_\bo _\bd_\be_\bv_\bi_\ba_\bn_\bt from the pre-
- dicted value(s).
+ · A mechanism to decide if and when an observed value or
+ sequence of observed values is _\bt_\bo_\bo _\bd_\be_\bv_\bi_\ba_\bn_\bt from the
+ predicted value(s).
Here is a brief explanation of these components:
time point in the period (cycle). After a value is observed,
each of these components is updated via exponential smoothing.
This means that the algorithm "learns" from past values and
- uses them to predict the future. The rate of adaptation is gov-
- erned by 3 parameters, alpha (intercept), beta (slope), and
+ uses them to predict the future. The rate of adaptation is
+ governed by 3 parameters, alpha (intercept), beta (slope), and
gamma (seasonal). The prediction can also be viewed as a
smoothed value for the time series.
- The measure of deviation is a seasonal weighted absolute devia-
- tion. The term _\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl means deviation is measured separately
- for each time point in the seasonal cycle. As with Holt-Winters
- forecasting, deviation is predicted using the measure computed
- from past values (but only at that point in the seasonal
- cycle). After the value is observed, the algorithm learns from
- the observed value via exponential smoothing. Confidence bands
- for the observed time series are generated by scaling the
- sequence of predicted deviation values (we usually think of the
- sequence as a continuous line rather than a set of discrete
- points).
+ The measure of deviation is a seasonal weighted absolute
+ deviation. The term _\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl means deviation is measured
+ separately for each time point in the seasonal cycle. As with
+ Holt-Winters forecasting, deviation is predicted using the
+ measure computed from past values (but only at that point in
+ the seasonal cycle). After the value is observed, the algorithm
+ learns from the observed value via exponential smoothing.
+ Confidence bands for the observed time series are generated by
+ scaling the sequence of predicted deviation values (we usually
+ think of the sequence as a continuous line rather than a set of
+ discrete points).
Aberrant behavior (a potential failure) is reported whenever
the number of times the observed value violates the confidence
data you could, for example, use a front-end application to
R\bRR\bRD\bDt\bto\boo\bol\bl to initiate real-time alerts.
- For a detailed description on how to set this up, see rrdcre-
- ate.
-
- R\bRE\bEM\bMO\bOT\bTE\bE C\bCO\bON\bNT\bTR\bRO\bOL\bL
+ For a detailed description on how to set this up, see
+ rrdcreate.
+ R\bRE\bEM\bMO\bOT\bTE\bE C\bCO\bON\bNT\bTR\bRO\bOL\bL
When you start R\bRR\bRD\bDt\bto\boo\bol\bl with the command line option '-\b-' it waits for
input via standard input (STDIN). With this feature you can improve
- performance by attaching R\bRR\bRD\bDt\bto\boo\bol\bl to another process (MRTG is one exam-
- ple) through a set of pipes. Over these pipes R\bRR\bRD\bDt\bto\boo\bol\bl accepts the same
- arguments as on the command line and some special commands like q\bqu\bui\bit\bt,\b,
- c\bcd\bd,\b, m\bmk\bkd\bdi\bir\br and l\bls\bs. For detailed help on the server commands type:
+ performance by attaching R\bRR\bRD\bDt\bto\boo\bol\bl to another process (MRTG is one
+ example) through a set of pipes. Over these pipes R\bRR\bRD\bDt\bto\boo\bol\bl accepts the
+ same arguments as on the command line and some special commands like
+ q\bqu\bui\bit\bt,\b, c\bcd\bd,\b, m\bmk\bkd\bdi\bir\br and l\bls\bs. For detailed help on the server commands type:
rrdtool help cd|mkdir|pwd|ls|quit
followed by timing information of the form u\bu:\b:_\bu_\bs_\be_\br_\bt_\bi_\bm_\be s\bs:\b:_\bs_\by_\bs_\bt_\be_\bm_\bt_\bi_\bm_\be.
Both values are the running totals of seconds since RRDtool was
started. If an error occurs, a line of the form '"ERROR:" _\bD_\be_\bs_\bc_\br_\bi_\bp_\bt_\bi_\bo_\bn
- _\bo_\bf _\be_\br_\br_\bo_\br' will be printed instead. R\bRR\bRD\bDt\bto\boo\bol\bl will not abort, unless some-
- thing really serious happens. If a w\bwo\bor\brk\bkd\bdi\bir\br is specified and the UID is
- 0, RRDtool will do a chroot to that workdir. If the UID is not 0, RRD-
- tool only changes the current directory to w\bwo\bor\brk\bkd\bdi\bir\br.
-
- R\bRR\bRD\bD S\bSe\ber\brv\bve\ber\br
+ _\bo_\bf _\be_\br_\br_\bo_\br' will be printed instead. R\bRR\bRD\bDt\bto\boo\bol\bl will not abort, unless
+ something really serious happens. If a w\bwo\bor\brk\bkd\bdi\bir\br is specified and the UID
+ is 0, RRDtool will do a chroot to that workdir. If the UID is not 0,
+ RRDtool only changes the current directory to w\bwo\bor\brk\bkd\bdi\bir\br.
+ R\bRR\bRD\bD S\bSe\ber\brv\bve\ber\br
If you want to create a RRD-Server, you must choose a TCP/IP Service
number and add them to _\b/_\be_\bt_\bc_\b/_\bs_\be_\br_\bv_\bi_\bc_\be_\bs like this:
Don't forget to create the database directory /var/rrd and reinitialize
your inetd.
- If all was setup correctly, you can access the server with Perl sock-
- ets, tools like netcat, or in a quick interactive test by using 'telnet
- localhost rrdsrv'.
+ If all was setup correctly, you can access the server with Perl
+ sockets, tools like netcat, or in a quick interactive test by using
+ 'telnet localhost rrdsrv'.
N\bNO\bOT\bTE\bE:\b: that there is no authentication with this feature! Do not setup
such a port unless you are sure what you are doing.
-1.3.99909060808 2009-05-26 RRDTOOL(1)
+1.3.999 2009-06-09 RRDTOOL(1)