32ff16e7bd3d22b6c42ef8f76ce82e9a7fd28c26
[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 * draw dashed lines in graphs (Thomas Gutzler)
32  
33 Forecasting (Evan Miller)
34 -----------
35 * the new MHWPREDICT consolidation function uses a variation of the Holt-Winters
36   method. It is a drop-in replacement for HWPREDICT, and is better suited for
37   data whose seasonal variations grow or shrink in proportion to the average.
38
39 Misc
40 ----
41 * ruby rrd_fetch will return step as a last property -- Mike Perham
42
43 Incompatibility
44 ---------------
45 * If you create an RRD with the new MHWPREDICT function, the resulting rrdfile will
46   be version 0004 and can only be used in rrdtool 1.3.
47
48 Locale Independent Input
49 ------------------------
50 * Regardles of locale you are in, rrdtool always expects input to be numbers (LC_NUMERIC)
51   in C or POSIX locale for numbers. (not 1,1 but 1.1) this is necessary to make
52   things like RPN work as it uses , as a separator.
53
54 RRDTOOL NEWS
55 ============
56 Major Changes between 1.0.x and 1.2.x
57
58 Graphing
59 --------
60
61 * rewritten graphics generation based on libart.
62   - anti-aliased output
63   - alpha transparency support
64   - truetype fonts
65  
66 * additional graphics formats: EPS, PDF, SVG
67
68 * extended multi-part documentation
69
70 * VDEF support; define and use variables.  Find, and use, the
71   maximum rate seen by rrdtool; compute and show the average
72
73 * Sliding window (trend) analysis
74   Compute a smoother average, for instance over the last 6 CDPs
75
76 * percentile (95th or other)
77   Remove peaks, 95 percent of all rates are at or below the
78   returned value
79
80 Logging
81 -------
82 * a second logging interface: rrdtool updatev
83   Verbose updating of the database; show CPDs being created
84
85 * Aberrant Behavior Detection with Holt-Winters Forecasting
86   Compare current data with expected data, detect and log when
87   the rates are outside expected levels
88
89 * COMPUTE data type for artificial data-sources calculating their
90   input using RPN math and data from the other data-sources.
91  
92 Incompatibilities
93 -----------------
94 * Colons in COMMENT arguments to rrdtool graph must be escaped with a backslash
95
96 * the --alt-y-mrtg option is gone or rather since 1.2.7 it is back but
97   without functionality.
98
99 * In pipe mode, rrdtool answers with OK only if it was successful with the
100   command. Otherwhise the answer will be ERROR...
101
102
103 Behind the Scenes
104 -----------------
105 * In order to support Holt-Winters and Calculated Datasources,
106   the rrdtool data format has changed. While the new version of rrdtool can
107   read files created with rrdtool 1.0.x. It is not possible to read files
108   created by rrdtool-1.2.x with rrdtool-1.0.x
109
110 * External libraries are not included with rrdtool anymore. This is in line
111   with todays trend of using shared libraries everywhere. With the exception
112   of the cgi library most things required by rrdtool will be found on every recent
113   system.
114
115 * Memory Mapped IO support for faster logging.