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