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