improved handling of libintl issues
[rrdtool.git] / NEWS
1 RRDTOOL NEWS
2 ============
3 Major Changes between 1.2.x and 1.3.x
4
5 RRdtool dump / restore Incompatibilities
6 ----------------------------------------
7 rrdtool dump 1.3 does emit completely legal xml. Basically this means that
8 it contains an xml header and a DOCTYPE definition. Unfortunately this
9 causes older versions of rrdtool restore to be unhappy.
10
11 To restore a new dump with ann old rrdtool restore version, either remove
12 the xml header and the doctype by hand (both on the first line of the dump)
13 or use rrdtool dump --no-header.
14
15 NEW File access methods (Bernhard Fischer)
16 -------------------
17 * introduced file-accessor functions rrd_read/rrd_seek/rrd_write
18 * implemented full mmap-based file access with madvise hints for improved
19   scalability, much reduced memory-footprint and much less blocking on
20   disk
21 * implemented optional full file-descriptor access instead of FILE* access
22
23 NEW Graphing (Tobi Oetiker)
24 --------
25 * libart has been replaced by cairo/pango
26 * pango markup is supported
27 * full gridfitting 
28 * --graph-render-mode=mono for non antialiased graphing
29 * --font-render-mode=mono for non antialiased fonts
30 * fonts come through fontconfig, use the Pango fontnameing
31   scheme -> 'Times 20' ... it is not possible to use
32   truetype fonts directly anymore.
33 * Tabs are position independent.
34 * TRENDNAN filter that ignores NAN values while caculating the TREND data. (Timo Stripf)
35 * --full-size-mode to specify the outer border of the image and not just of the graphing canvas (Matthew Chambers)
36 * TEXTALIGN command to alter default text alignment behaviour
37 * C API in-memory graphing with rrd_graph_v (Evan Miller)
38 * draw dashed lines in graphs (Thomas Gutzler)
39 * new interface graphv which returns inforamation using the rrd_info
40   interface (Tobi Oetiker and Mark Plaksin)
41
42 NEW Forecasting (Evan Miller)
43 -----------
44 * the new MHWPREDICT consolidation function uses a variation of the Holt-Winters
45   method. It is a drop-in replacement for HWPREDICT, and is better suited for
46   data whose seasonal variations grow or shrink in proportion to the average.
47
48 * If you create an RRD with the new MHWPREDICT function, the resulting
49   rrdfile will be version 0004 and can only be used in rrdtool 1.3.
50
51 Rewrites
52 --------
53 * rrd_restore now uses libxml for parsing which makes things much more
54   tolerant towards xml variations. The old code could mostly just parse the
55   xml as it was output by rrdtool dump. See also: 'incompatibilities' at the
56   top of this document. (by Florian octo Forster)
57
58 * rrd_update rewritten to make it more modular. Fixed two longstanding
59   HW bugs in the process (Evan Miller)
60
61 Internationalization (Takao Fujiwara and Tobi Oetiker)
62 --------------------
63 * The help output by rrdtool has been internationalized. There are no real
64   translations included with rrdtool yet, contributions are welcome.
65 * The internationalization will only be compiled if libintl and friends are
66   available on your system. Use the configure option --disable-libintl if
67   you want to disable this feature
68
69 Misc
70 ----
71 * ruby rrd_fetch will return step as a last property -- Mike Perham
72
73 Locale Independent Numeric Input
74 --------------------------------
75 * Regardles of locale you are in, rrdtool always expects input to be numbers
76   (LC_NUMERIC) in C or POSIX locale for numbers. (not 1,1 but 1.1) this is
77   necessary to make things like RPN work as it uses , as a separator.
78
79 RRDTOOL NEWS
80 ============
81 Major Changes between 1.0.x and 1.2.x
82
83 Graphing
84 --------
85
86 * rewritten graphics generation based on libart.
87   - anti-aliased output
88   - alpha transparency support
89   - truetype fonts
90  
91 * additional graphics formats: EPS, PDF, SVG
92
93 * extended multi-part documentation
94
95 * VDEF support; define and use variables.  Find, and use, the
96   maximum rate seen by rrdtool; compute and show the average
97
98 * Sliding window (trend) analysis
99   Compute a smoother average, for instance over the last 6 CDPs
100
101 * percentile (95th or other)
102   Remove peaks, 95 percent of all rates are at or below the
103   returned value
104
105 Logging
106 -------
107 * a second logging interface: rrdtool updatev
108   Verbose updating of the database; show CPDs being created
109
110 * Aberrant Behavior Detection with Holt-Winters Forecasting
111   Compare current data with expected data, detect and log when
112   the rates are outside expected levels
113
114 * COMPUTE data type for artificial data-sources calculating their
115   input using RPN math and data from the other data-sources.
116  
117 Incompatibilities
118 -----------------
119 * Colons in COMMENT arguments to rrdtool graph must be escaped with a backslash
120
121 * the --alt-y-mrtg option is gone or rather since 1.2.7 it is back but
122   without functionality.
123
124 * In pipe mode, rrdtool answers with OK only if it was successful with the
125   command. Otherwhise the answer will be ERROR...
126
127
128 Behind the Scenes
129 -----------------
130 * In order to support Holt-Winters and Calculated Datasources,
131   the rrdtool data format has changed. While the new version of rrdtool can
132   read files created with rrdtool 1.0.x. It is not possible to read files
133   created by rrdtool-1.2.x with rrdtool-1.0.x
134
135 * External libraries are not included with rrdtool anymore. This is in line
136   with todays trend of using shared libraries everywhere. With the exception
137   of the cgi library most things required by rrdtool will be found on every recent
138   system.
139
140 * Memory Mapped IO support for faster logging.