added note about incompatible changes
[rrdtool.git] / NEWS
1 RRDTOOL NEWS
2 ============
3 Major Changes between 1.0.x and 1.2.x
4
5 Graphing
6 --------
7
8 * rewritten graphics generation based on libart.
9   - antialiased output
10   - alpha transparency support
11   - truetype fonts
12  
13 * additional graphics formats: EPS, PDF, SVG
14
15 * extended multipart documentation
16
17 * VDEF support; define and use variables.  Find, and use, the
18   maximum rate seen by rrdtool; compute and show the average
19
20 * Sliding window (trend) analysis
21   Compute a smoother average, for instance over the last 6 CDPs
22
23 * percentile (95th or other)
24   Remove peaks, 95 percent of all rates are at or below the
25   returned value
26
27 Logging
28 -------
29 * a second logging interface: rrdtool updatev
30   Verbose updating of the database; show CPDs being created
31
32 * Aberrant Behavior Detection with Holt-Winters Forecasting
33   Compare current data with expected data, detect and log when
34   the rates are outside expected levels
35
36 * COMPUTE datatype for artificial datasources calculating their
37   input using RPN math and data from the other datasources.
38  
39 Incompatibilities
40 -----------------
41 * Colons in COMMENT arguments to rrdtool graph must be escaped with a backslash
42
43 Behind the Scenes
44 -----------------
45 * In order to support Holt-Winters and Calculated Datasources,
46   the rrdtool dataformat has changed. While the new version of rrdtool can
47   read files created with rrdtool 1.0.x. It is not possible to read files
48   created by rrdtool-1.2.x with rrdtool-1.0.x
49
50 * External libraries are not included with rrdtool anymore. This is in line
51   with todays trend of using shared libraries everywhere. With the exception
52   of the cgi library most things required by rrdtool will be found on every recent
53   system.
54
55 * Memory Mapped IO support for faster logging.
56
57 ---------------
58
59   Configure and Makefiles and accordingly.
60
61 2002/03/26 Peter Speck <speck@ruc.dk>
62   Contribution of an svg output routine for the new gfx graphing part
63
64 2002/03/23 Alex van den Bogaerdt <alex@ergens.op.Het.Net>
65   Several visible changes made to rrd_graph
66   * Pie chart support workable
67   * Elements that are not used do not take up space on the img
68   * Hack for the missing rotated text (see --vertical-label)
69   * Tiny boxes in front of labels now scale with the text
70
71 2002/01/15 Tobias Oetiker <tobi@oetiker.ch>
72   The BIG graph update
73   * Replace libgd with libart
74   * Added freetype
75   * Updated zlib and libpng
76   * rrd_gfx.c intrduced as libart wrapper
77   * LINE takes now a float as argument
78   * RRDtool uses truetype for fonts
79   * thanks to libart there is now full alpha transparenc
80     and antialiasing.
81   * the new option --font lets customize the font
82     and size for various graph elements
83   * Updated to -> libtool 1.4.2 automake 2.12 autoconf 2.52
84   * new --zoom commandline option for zoom ans shrinking
85   ---- Still missing is rotatet text for the yaxis description
86   ---- Still missing is tab support in the text rendere
87   ---- Still missing is autoconf support for a default truetype font
88
89 2001/07/26 Alex van den Bogaerdt <alex@ergens.op.Het.Net>
90   Added TOTAL to the VDEF functions.
91
92 2001/07/19 Alex van den Bogaerdt <alex@ergens.op.Het.Net>
93   VDEF support.  This is a variable containing one value
94   and a time component.  This type of variable can hold
95   the result of a function over a complete time series
96   of data (DEF or CDEF) such as the maximum seen, and when.
97
98 2001/03/10 Jake Brutlag <jakeb@corp.webtv.net>
99   Support for COMPUTE data sources (CDEF data sources). Removes the RPN
100   parser and calculator from rrd_graph and puts then in a new file,
101   rrd_rpncalc.c. Changes to core files rrd_create and rrd_update. Some
102   clean-up of aberrant behavior stuff, including a bug fix. 
103   Documentation update (rrdcreate.pod, rrdupdate.pod). Change xml format.
104   
105 2001/03/07 Tobias Oetiker <oetiker@ee.ethz.ch> 
106   Integrated complete rewrite
107   of rrdgraph documentation by Alex van den Bogaerdt
108   <alex@ergens.op.Het.Net>. This also contains info on his planned
109   changes to the rrdgraph module
110
111 2001/03/02 Tobias Oetiker <oetiker@ee.ethz.ch>
112   Added Aberrant Patch from Jake Brutlag <jakeb@microsoft.com>
113   From now one, new rrd files use version tag 0002. They can
114   NOT be read by the old 1.0.x RRDtools. 
115  
116   Jake:
117   Aberrant Behavior Detection support. A brief overview added to
118   rrdtool.pod.  Major updates to rrd_update.c, rrd_create.c. Minor update to
119   other core files.  Updated documentation: rrdcreate.pod, rrdgraph.pod,
120   rrdtune.pod.  This is backwards compatible (i.e. new tool can read and will
121   leave the binary header unchanged for old files).
122   See http://cricket.sourceforge.net/aberrant/rrd_hw.htm