notes on evans contribs
[rrdtool.git] / NEWS
1 RRDTOOL NEWS
2 ============
3 Major Changes between 1.2.x and 1.3.x
4
5 see http://oss.oetiker.ch/rrdtool-trac/wiki/RRDtool13
6 for up to date information
7
8 File access methods (Bernhard Fischer)
9 -------------------
10 * introduced file-accessor functions rrd_read/rrd_seek/rrd_write
11 * implemented full mmap-based file access with madvise hints for improved
12   scalability, much reduced memory-footprint and much less blocking on
13   disk
14 * implemented optional full file-descriptor access instead of FILE* access
15
16 Graphing (Tobi Oetiker)
17 --------
18 * libart has been replaced by cairo/pango
19 * pango markup is supported
20 * full gridfitting 
21 * --graph-render-mode=mono for non antialiased graphing
22 * --font-render-mode=mono for non antialiased fonts
23 * fonts come through fontconfig, use the Pango fontnameing
24   scheme -> 'Times 20' ... it is not possible to use
25   truetype fonts directly anymore.
26 * Tabs are position independent.
27 * TRENDNAN filter that ignores NAN values while caculating the TREND data. (Timo Stripf)
28 * --full-size-mode to specify the outer border of the image and not just of the graphing canvas (Matthew Chambers)
29 * TEXTALIGN command to alter default text alignment behaviour
30 * C API supports in-memory graphing with rrd_graph_in_memory (Evan Miller)
31  
32 Forecasting (Evan Miller)
33 -----------
34 * the new MHWPREDICT consolidation function uses a variation of the Holt-Winters
35   method. It is a drop-in replacement for HWPREDICT, and is better suited for
36   data whose seasonal variations grow or shrink in proportion to the average.
37
38
39 RRDTOOL NEWS
40 ============
41 Major Changes between 1.0.x and 1.2.x
42
43 Graphing
44 --------
45
46 * rewritten graphics generation based on libart.
47   - anti-aliased output
48   - alpha transparency support
49   - truetype fonts
50  
51 * additional graphics formats: EPS, PDF, SVG
52
53 * extended multi-part documentation
54
55 * VDEF support; define and use variables.  Find, and use, the
56   maximum rate seen by rrdtool; compute and show the average
57
58 * Sliding window (trend) analysis
59   Compute a smoother average, for instance over the last 6 CDPs
60
61 * percentile (95th or other)
62   Remove peaks, 95 percent of all rates are at or below the
63   returned value
64
65 Logging
66 -------
67 * a second logging interface: rrdtool updatev
68   Verbose updating of the database; show CPDs being created
69
70 * Aberrant Behavior Detection with Holt-Winters Forecasting
71   Compare current data with expected data, detect and log when
72   the rates are outside expected levels
73
74 * COMPUTE data type for artificial data-sources calculating their
75   input using RPN math and data from the other data-sources.
76  
77 Incompatibilities
78 -----------------
79 * Colons in COMMENT arguments to rrdtool graph must be escaped with a backslash
80
81 * the --alt-y-mrtg option is gone or rather since 1.2.7 it is back but
82   without functionality.
83
84 * In pipe mode, rrdtool answers with OK only if it was successful with the
85   command. Otherwhise the answer will be ERROR...
86
87
88 Behind the Scenes
89 -----------------
90 * In order to support Holt-Winters and Calculated Datasources,
91   the rrdtool data format has changed. While the new version of rrdtool can
92   read files created with rrdtool 1.0.x. It is not possible to read files
93   created by rrdtool-1.2.x with rrdtool-1.0.x
94
95 * External libraries are not included with rrdtool anymore. This is in line
96   with todays trend of using shared libraries everywhere. With the exception
97   of the cgi library most things required by rrdtool will be found on every recent
98   system.
99
100 * Memory Mapped IO support for faster logging.