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