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