Code

Imported upstream version 1.2.26
[pkg-rrdtool.git] / doc / rrdgraph.txt
1 RRDGRAPH(1)                         rrdtool                        RRDGRAPH(1)
5 N\bNA\bAM\bME\bE
6        rrdgraph - Round Robin Database tool grapher functions
8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
9        r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [_\bo_\bp_\bt_\bi_\bo_\bn ...]  [_\bd_\ba_\bt_\ba _\bd_\be_\bf_\bi_\bn_\bi_\bt_\bi_\bo_\bn ...]  [_\bd_\ba_\bt_\ba _\bc_\ba_\bl_\b-
10        _\bc_\bu_\bl_\ba_\bt_\bi_\bo_\bn ...]  [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be _\bd_\be_\bf_\bi_\bn_\bi_\bt_\bi_\bo_\bn ...]  [_\bg_\br_\ba_\bp_\bh _\be_\bl_\be_\bm_\be_\bn_\bt ...]  [_\bp_\br_\bi_\bn_\bt
11        _\be_\bl_\be_\bm_\be_\bn_\bt ...]
13 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
14        The g\bgr\bra\bap\bph\bh function of R\bRR\bRD\bDt\bto\boo\bol\bl is used to present the data from an R\bRR\bRD\bD
15        to a human viewer.  Its main purpose is to create a nice graphical rep-
16        resentation, but it can also generate a numerical report.
18 O\bOV\bVE\bER\bRV\bVI\bIE\bEW\bW
19        r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh needs data to work with, so you must use one or more d\bda\bat\bta\ba
20        d\bde\bef\bfi\bin\bni\bit\bti\bio\bon\bn statements to collect this data.  You are not limited to one
21        database, it's perfectly legal to collect data from two or more
22        databases (one per statement, though).
24        If you want to display averages, maxima, percentiles, etcetera it is
25        best to collect them now using the v\bva\bar\bri\bia\bab\bbl\ble\be d\bde\bef\bfi\bin\bni\bit\bti\bio\bon\bn statement.  Cur-
26        rently this makes no difference, but in a future version of rrdtool you
27        may want to collect these values before consolidation.
29        The data fetched from the R\bRR\bRA\bA is then c\bco\bon\bns\bso\bol\bli\bid\bda\bat\bte\bed\bd so that there is
30        exactly one datapoint per pixel in the graph. If you do not take care
31        yourself, R\bRR\bRD\bDt\bto\boo\bol\bl will expand the range slightly if necessary. Note, in
32        that case the first and/or last pixel may very well become unknown!
34        Sometimes data is not exactly in the format you would like to display
35        it. For instance, you might be collecting b\bby\byt\bte\bes\bs per second, but want to
36        display b\bbi\bit\bts\bs per second. This is what the d\bda\bat\bta\ba c\bca\bal\blc\bcu\bul\bla\bat\bti\bio\bon\bn command is
37        designed for. After c\bco\bon\bns\bso\bol\bli\bid\bda\bat\bti\bin\bng\bg the data, a copy is made and this
38        copy is modified using a rather powerful R\bRP\bPN\bN command set.
40        When you are done fetching and processing the data, it is time to graph
41        it (or print it).  This ends the r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh sequence.
43 O\bOP\bPT\bTI\bIO\bON\bNS\bS
44        filename
45            The name and path of the graph to generate. It is recommended to
46            end this in ".png", ".svg" or ".eps", but R\bRR\bRD\bDt\bto\boo\bol\bl does not enforce
47            this.
49            _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be can be '"-"' to send the image to "stdout". In this case,
50            no other output is generated.
52        Time range
53            [-\b-s\bs|-\b--\b-s\bst\bta\bar\brt\bt _\bt_\bi_\bm_\be] [-\b-e\be|-\b--\b-e\ben\bnd\bd _\bt_\bi_\bm_\be] [-\b-S\bS|-\b--\b-s\bst\bte\bep\bp _\bs_\be_\bc_\bo_\bn_\bd_\bs]
55            The start and end of the time series you would like to display, and
56            which R\bRR\bRA\bA the data should come from.  Defaults are: 1 day ago until
57            now, with the best possible resolution. S\bSt\bta\bar\brt\bt and e\ben\bnd\bd can be speci-
58            fied in several formats, see AT-STYLE TIME SPECIFICATION and rrd-
59            graph_examples.  By default, r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh calculates the width of
60            one pixel in the time domain and tries to get data from an R\bRR\bRA\bA with
61            that resolution.  With the s\bst\bte\bep\bp option you can alter this
62            behaviour.  If you want r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh to get data at a one-hour
63            resolution from the R\bRR\bRD\bD, set s\bst\bte\bep\bp to 3'600. Note: a step smaller
64            than one pixel will silently be ignored.
66        Labels
67            [-\b-t\bt|-\b--\b-t\bti\bit\btl\ble\be _\bs_\bt_\br_\bi_\bn_\bg] [-\b-v\bv|-\b--\b-v\bve\ber\brt\bti\bic\bca\bal\bl-\b-l\bla\bab\bbe\bel\bl _\bs_\bt_\br_\bi_\bn_\bg]
69            A horizontal string at the top of the graph and/or a vertically
70            placed string at the left hand side of the graph.
72        Size
73            [-\b-w\bw|-\b--\b-w\bwi\bid\bdt\bth\bh _\bp_\bi_\bx_\be_\bl_\bs] [-\b-h\bh|-\b--\b-h\bhe\bei\big\bgh\bht\bt _\bp_\bi_\bx_\be_\bl_\bs] [-\b-j\bj|-\b--\b-o\bon\bnl\bly\by-\b-g\bgr\bra\bap\bph\bh]
75            The width and height of the c\bca\ban\bnv\bva\bas\bs (the part of the graph with the
76            actual data and such). This defaults to 400 pixels by 100 pixels.
78            If you specify the -\b--\b-o\bon\bnl\bly\by-\b-g\bgr\bra\bap\bph\bh option and set the height < 32 pix-
79            els you will get a tiny graph image (thumbnail) to use as an icon
80            for use in an overview, for example. All labeling will be stripped
81            off the graph.
83        Limits
84            [-\b-u\bu|-\b--\b-u\bup\bpp\bpe\ber\br-\b-l\bli\bim\bmi\bit\bt _\bv_\ba_\bl_\bu_\be] [-\b-l\bl|-\b--\b-l\blo\bow\bwe\ber\br-\b-l\bli\bim\bmi\bit\bt _\bv_\ba_\bl_\bu_\be] [-\b-r\br|-\b--\b-r\bri\big\bgi\bid\bd]
86            By default the graph will be autoscaling so that it will adjust the
87            y-axis to the range of the data. You can change this behaviour by
88            explicitly setting the limits. The displayed y-axis will then range
89            at least from l\blo\bow\bwe\ber\br-\b-l\bli\bim\bmi\bit\bt to u\bup\bpp\bpe\ber\br-\b-l\bli\bim\bmi\bit\bt. Autoscaling will still
90            permit those boundaries to be stretched unless the r\bri\big\bgi\bid\bd option is
91            set.
93            [-\b-A\bA|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be]
95            Sometimes the default algorithm for selecting the y-axis scale is
96            not satisfactory. Normally the scale is selected from a predefined
97            set of ranges and this fails miserably when you need to graph some-
98            thing like "260 + 0.001 * sin(x)". This option calculates the mini-
99            mum and maximum y-axis from the actual minimum and maximum data
100            values. Our example would display slightly less than "260-0.001" to
101            slightly more than "260+0.001" (this feature was contributed by
102            Sasha Mikheev).
104            [-\b-J\bJ|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be-\b-m\bmi\bin\bn]
106            Where "--alt-autoscale" will modify both the absolute maximum AND
107            minimum values, this option will only affect the minimum value. The
108            maximum value, if not defined on the command line, will be 0. This
109            option can be useful when graphing router traffic when the WAN line
110            uses compression, and thus the throughput may be higher than the
111            WAN line speed.
113            [-\b-M\bM|-\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be-\b-m\bma\bax\bx]
115            Where "--alt-autoscale" will modify both the absolute maximum AND
116            minimum values, this option will only affect the maximum value. The
117            minimum value, if not defined on the command line, will be 0. This
118            option can be useful when graphing router traffic when the WAN line
119            uses compression, and thus the throughput may be higher than the
120            WAN line speed.
122            [-\b-N\bN|-\b--\b-n\bno\bo-\b-g\bgr\bri\bid\bdf\bfi\bit\bt]
124            In order to avoid anti-aliasing effects gridlines are placed on
125            integer pixel values. This is by default done by extending the
126            scale so that gridlines happens to be spaced using an integer num-
127            ber of pixels and also start on an integer pixel value.  This might
128            extend the scale too much for some logarithmic scales and for lin-
129            ear scales where -\b--\b-a\bal\blt\bt-\b-a\bau\but\bto\bos\bsc\bca\bal\ble\be is needed.  Using -\b--\b-n\bno\bo-\b-g\bgr\bri\bid\bdf\bfi\bit\bt
130            disables modification of the scale.
132        Grid
133            X-Axis
134                [-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd _\bG_\bT_\bM:\b:_\bG_\bS_\bT:\b:_\bM_\bT_\bM:\b:_\bM_\bS_\bT:\b:_\bL_\bT_\bM:\b:_\bL_\bS_\bT:\b:_\bL_\bP_\bR:\b:_\bL_\bF_\bM]
136                [-\b-x\bx|-\b--\b-x\bx-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
138                The x-axis label is quite complex to configure. If you don't
139                have very special needs it is probably best to rely on the
140                autoconfiguration to get this right. You can specify the string
141                "none" to suppress the grid and labels altogether.
143                The grid is defined by specifying a certain amount of time in
144                the _\b?_\bT_\bM positions. You can choose from "SECOND", "MINUTE",
145                "HOUR", "DAY", "WEEK", "MONTH" or "YEAR". Then you define how
146                many of these should pass between each line or label.  This
147                pair (_\b?_\bT_\bM_\b:_\b?_\bS_\bT) needs to be specified for the base grid (_\bG_\b?_\b?),
148                the major grid (_\bM_\b?_\b?) and the labels (_\bL_\b?_\b?). For the labels you
149                also must define a precision in _\bL_\bP_\bR and a _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be format
150                string in _\bL_\bF_\bM.  _\bL_\bP_\bR defines where each label will be placed. If
151                it is zero, the label will be placed right under the corre-
152                sponding line (useful for hours, dates etcetera).  If you spec-
153                ify a number of seconds here the label is centered on this
154                interval (useful for Monday, January etcetera).
156                 --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
158                This places grid lines every 10 minutes, major grid lines every
159                hour, and labels every 4 hours. The labels are placed under the
160                major grid lines as they specify exactly that time.
162                 --x-grid HOUR:8:DAY:1:DAY:1:0:%A
164                This places grid lines every 8 hours, major grid lines and
165                labels each day. The labels are placed exactly between two
166                major grid lines as they specify the complete day and not just
167                midnight.
169            Y-Axis
170                [-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd _\bg_\br_\bi_\bd _\bs_\bt_\be_\bp:\b:_\bl_\ba_\bb_\be_\bl _\bf_\ba_\bc_\bt_\bo_\br]
172                [-\b-y\by|-\b--\b-y\by-\b-g\bgr\bri\bid\bd n\bno\bon\bne\be]
174                Y-axis grid lines appear at each _\bg_\br_\bi_\bd _\bs_\bt_\be_\bp interval.  Labels
175                are placed every _\bl_\ba_\bb_\be_\bl _\bf_\ba_\bc_\bt_\bo_\br lines.  You can specify "-y none"
176                to suppress the grid and labels altogether.  The default for
177                this option is to automatically select sensible values.
179                If you have set --y-grid to 'none' not only the labels get
180                supressed, also the space reserved for the labels is removed.
181                You can still add space manually if you use the --units-length
182                command to explicitly reserve space.
184                [-\b-Y\bY|-\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd]
186                Place the Y grid dynamically based on the graph's Y range. The
187                algorithm ensures that you always have a grid, that there are
188                enough but not too many grid lines, and that the grid is met-
189                ric. That is the grid lines are placed every 1, 2, 5 or 10
190                units. This parameter will also ensure that you get enough dec-
191                imals displayed even if your graph goes from 69.998 to 70.001.
192                (contributed by Sasha Mikheev).
194                [-\b-o\bo|-\b--\b-l\blo\bog\bga\bar\bri\bit\bth\bhm\bmi\bic\bc]
196                Logarithmic y-axis scaling.
198                [-\b-X\bX|-\b--\b-u\bun\bni\bit\bts\bs-\b-e\bex\bxp\bpo\bon\bne\ben\bnt\bt _\bv_\ba_\bl_\bu_\be]
200                This sets the 10**exponent scaling of the y-axis values. Nor-
201                mally, values will be scaled to the appropriate units (k, M,
202                etc.).  However, you may wish to display units always in k
203                (Kilo, 10e3) even if the data is in the M (Mega, 10e6) range,
204                for instance. Value should be an integer which is a multiple of
205                3 between -18 and 18 inclusively.  It is the exponent on the
206                units you wish to use. For example, use 3 to display the y-axis
207                values in k (Kilo, 10e3, thousands), use -6 to display the
208                y-axis values in u (Micro, 10e-6, millionths).  Use a value of
209                0 to prevent any scaling of the y-axis values.
211                This option is very effective at confusing the heck out of the
212                default rrdtool autoscaler and grid painter. If rrdtool detects
213                that it is not successful in labeling the graph under the given
214                circumstances, it will switch to the more robust -\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd
215                mode.
217                [-\b-L\bL|-\b--\b-u\bun\bni\bit\bts\bs-\b-l\ble\ben\bng\bgt\bth\bh _\bv_\ba_\bl_\bu_\be]
219                How many digits should rrdtool assume the y-axis labels to be?
220                You may have to use this option to make enough space once you
221                start fideling with the y-axis labeling.
223                [-\b--\b-u\bun\bni\bit\bts\bs=\b=s\bsi\bi]
225                With this option y-axis values on logarithmic graphs will be
226                scaled to the appropriate units (k, M, etc.) instead of using
227                exponential notation.  Note that for linear graphs, SI notation
228                is used by default.
230        Miscellaneous
231            [-\b-z\bz|-\b--\b-l\bla\baz\bzy\by]
233            Only generate the graph if the current graph is out of date or not
234            existent.
236            [-\b-f\bf|-\b--\b-i\bim\bmg\bgi\bin\bnf\bfo\bo _\bp_\br_\bi_\bn_\bt_\bf_\bs_\bt_\br]
238            After the image has been created, the graph function uses printf
239            together with this format string to create output similar to the
240            PRINT function, only that the printf function is supplied with the
241            parameters _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be, _\bx_\bs_\bi_\bz_\be and _\by_\bs_\bi_\bz_\be. In order to generate an I\bIM\bMG\bG
242            tag suitable for including the graph into a web page, the command
243            line would look like this:
245             --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
247            [-\b-c\bc|-\b--\b-c\bco\bol\blo\bor\br _\bC_\bO_\bL_\bO_\bR_\bT_\bA_\bG#_\br_\br_\bg_\bg_\bb_\bb[_\ba_\ba]]
249            Override the default colors for the standard elements of the graph.
250            The _\bC_\bO_\bL_\bO_\bR_\bT_\bA_\bG is one of "BACK" background, "CANVAS" for the back-
251            ground of the actual graph, "SHADEA" for the left and top border,
252            "SHADEB" for the right and bottom border, "GRID", "MGRID" for the
253            major grid, "FONT" for the color of the font, "AXIS" for the axis
254            of the graph, "FRAME" for the line around the color spots and
255            finally "ARROW" for the arrow head pointing up and forward. Each
256            color is composed out of three hexadecimal numbers specifying its
257            rgb color component (00 is off, FF is maximum) of red, green and
258            blue. Optionally you may add another hexadecimal number specifying
259            the transparency (FF is solid). You may set this option several
260            times to alter multiple defaults.
262            A green arrow is made by: "--color ARROW#00FF00"
264            [-\b--\b-z\bzo\boo\bom\bm _\bf_\ba_\bc_\bt_\bo_\br]
266            Zoom the graphics by the given amount. The factor must be > 0
268            [-\b-n\bn|-\b--\b-f\bfo\bon\bnt\bt _\bF_\bO_\bN_\bT_\bT_\bA_\bG:\b:_\bs_\bi_\bz_\be:\b:[_\bf_\bo_\bn_\bt]]
270            This lets you customize which font to use for the various text ele-
271            ments on the RRD graphs. "DEFAULT" sets the default value for all
272            elements, "TITLE" for the title, "AXIS" for the axis labels, "UNIT"
273            for the vertical unit label, "LEGEND" for the graph legend.
275            Use Times for the title: "--font TITLE:13:/usr/lib/fonts/times.ttf"
277            If you do not give a font string you can modify just the sice of
278            the default font: "--font TITLE:13:".
280            If you specify the size 0 then you can modify just the font without
281            touching the size. This is especially usefull for altering the
282            default font without resetting the default fontsizes: "--font
283            DEFAULT:0:/usr/lib/fonts/times.ttf".
285            RRDtool comes with a preset default font. You can set the environ-
286            ment variable "RRD_DEFAULT_FONT" if you want to change this.
288            Truetype fonts are only supported for PNG output. See below.
290            [-\b-R\bR|-\b--\b-f\bfo\bon\bnt\bt-\b-r\bre\ben\bnd\bde\ber\br-\b-m\bmo\bod\bde\be {_\bn_\bo_\br_\bm_\ba_\bl,_\bl_\bi_\bg_\bh_\bt,_\bm_\bo_\bn_\bo}]
292            This lets you customize the strength of the font smoothing, or dis-
293            able it entirely using _\bm_\bo_\bn_\bo. By default, _\bn_\bo_\br_\bm_\ba_\bl font smoothing is
294            used.
296            [-\b-B\bB|-\b--\b-f\bfo\bon\bnt\bt-\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-t\bth\bhr\bre\bes\bsh\bho\bol\bld\bd _\bs_\bi_\bz_\be]
298            This specifies the largest font size which will be rendered
299            bitmapped, that is, without any font smoothing. By default, no text
300            is rendered bitmapped.
302            [-\b-E\bE|-\b--\b-s\bsl\blo\bop\bpe\be-\b-m\bmo\bod\bde\be]
304            RRDtool graphs are composed of stair case curves by default. This
305            is in line with the way RRDtool calculates its data. Some people
306            favor a more 'organic' look for their graphs even though it is not
307            all that true.
309            [-\b-a\ba|-\b--\b-i\bim\bmg\bgf\bfo\bor\brm\bma\bat\bt P\bPN\bNG\bG|S\bSV\bVG\bG|E\bEP\bPS\bS|P\bPD\bDF\bF]
311            Image format for the generated graph. For the vector formats you
312            can choose among the standard Postscript fonts Courier-Bold,
313            Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold, Hel-
314            vetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
315            Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfD-
316            ingbats.
318            [-\b-i\bi|-\b--\b-i\bin\bnt\bte\ber\brl\bla\bac\bce\bed\bd]
320            If images are interlaced they become visible on browsers more
321            quickly.
323            [-\b-g\bg|-\b--\b-n\bno\bo-\b-l\ble\beg\bge\ben\bnd\bd]
325            Suppress generation of the legend; only render the graph.
327            [-\b-F\bF|-\b--\b-f\bfo\bor\brc\bce\be-\b-r\bru\bul\ble\bes\bs-\b-l\ble\beg\bge\ben\bnd\bd]
329            Force the generation of HRULE and VRULE legends even if those HRULE
330            or VRULE will not be drawn because out of graph boundaries (mimics
331            behaviour of pre 1.0.42 versions).
333            [-\b-T\bT|-\b--\b-t\bta\bab\bbw\bwi\bid\bdt\bth\bh _\bv_\ba_\bl_\bu_\be]
335            By default the tab-width is 40 pixels, use this option to change
336            it.
338            [-\b-b\bb|-\b--\b-b\bba\bas\bse\be _\bv_\ba_\bl_\bu_\be]
340            If you are graphing memory (and NOT network traffic) this switch
341            should be set to 1024 so that one Kb is 1024 byte. For traffic mea-
342            surement, 1 kb/s is 1000 b/s.
344            [-\b-W\bW|-\b--\b-w\bwa\bat\bte\ber\brm\bma\bar\brk\bk _\bs_\bt_\br_\bi_\bn_\bg]
346            Adds the given string as a watermark, horizontally centred, at the
347            bottom of the graph.
349        Data and variables
350            D\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\br_\br_\bd_\bf_\bi_\bl_\be:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bC_\bF[:\b:s\bst\bte\bep\bp=\b=_\bs_\bt_\be_\bp][:\b:s\bst\bta\bar\brt\bt=\b=_\bt_\bi_\bm_\be][:\b:e\ben\bnd\bd=\b=_\bt_\bi_\bm_\be]
352            C\bCD\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
354            V\bVD\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
356            You need at least one D\bDE\bEF\bF statement to generate anything. The other
357            statements are useful but optional.  See rrdgraph_data and rrd-
358            graph_rpn for the exact format.
360        Graph and print elements
361            You need at least one graph element to generate an image and/or at
362            least one print statement to generate a report.  See rrdgraph_graph
363            for the exact format.
365 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
366        rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works.  rrdgraph_data
367        describes D\bDE\bEF\bF,C\bCD\bDE\bEF\bF and V\bVD\bDE\bEF\bF in detail.  rrdgraph_rpn describes the R\bRP\bPN\bN
368        language used in the ?\b?D\bDE\bEF\bF statements.  rrdgraph_graph page describes
369        all of the graph and print functions.
371        Make sure to read rrdgraph_examples for tips&tricks.
373 A\bAU\bUT\bTH\bHO\bOR\bR
374        Program by Tobias Oetiker <tobi@oetiker.ch>
376        This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
380 1.2.26                            2007-11-20                       RRDGRAPH(1)