1 RRDGRAPH(1) rrdtool RRDGRAPH(1)
6 rrdgraph - Round Robin Database tool grapher functions
9 r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh|\b|g\bgr\bra\bap\bph\bhv\bv _\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 ...]
10 [_\bd_\ba_\bt_\ba _\bc_\ba_\bl_\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 ...]
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.
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
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
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
40 When you are done fetching and processing the data, it is time to graph
49 the same format as rrdtool info (key = value). See the bottom of the
50 document for more information.
54 The name and path of the graph to generate. It is recommended to end
58 other output is generated.
62 [-\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]
64 The start and end of the time series you would like to display, and
67 in several formats, see AT-STYLE TIME SPECIFICATION and rrdgraph_exam-
68 ples. By default, r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh calculates the width of one pixel in
70 With the s\bst\bte\bep\bp option you can alter this behaviour. If you want r\brr\brd\bdt\bto\boo\bol\bl
71 g\bgr\bra\bap\bph\bh to get data at a one-hour resolution from the R\bRR\bRD\bD, set s\bst\bte\bep\bp to
72 3'600. Note: a step smaller than one pixel will silently be ignored.
76 [-\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]
78 A horizontal string at the top of the graph and/or a vertically placed
79 string at the left hand side of the graph.
83 [-\b--\b-r\bri\big\bgh\bht\bt-\b-a\bax\bxi\bis\bs _\bs_\bc_\ba_\bl_\be:\b:_\bs_\bh_\bi_\bf_\bt] [-\b--\b-r\bri\big\bgh\bht\bt-\b-a\bax\bxi\bis\bs-\b-l\bla\bab\bbe\bel\bl _\bl_\ba_\bb_\be_\bl]
85 A second axis will be drawn to the right of the graph. It is tied to
86 the left axis via the scale and shift parameters. You can also define a
87 label for the right axis.
89 [-\b--\b-r\bri\big\bgh\bht\bt-\b-a\bax\bxi\bis\bs-\b-f\bfo\bor\brm\bma\bat\bt _\bf_\bo_\br_\bm_\ba_\bt_\b-_\bs_\bt_\br_\bi_\bn_\bg]
91 By default the format of the axis lables gets determined automatically.
92 If you want todo this your self, use this option with the same %lf
93 arguments you know from the PRING and GPRINT commands.
97 [-\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]
101 actual data and such). This defaults to 400 pixels by 100 pixels.
103 If you specify the -\b--\b-f\bfu\bul\bll\bl-\b-s\bsi\biz\bze\be-\b-m\bmo\bod\bde\be option, the width and height spec-
104 ify the final dimensions of the output image and the canvas is automat-
105 ically resized to fit.
107 If you specify the -\b--\b-o\bon\bnl\bly\by-\b-g\bgr\bra\bap\bph\bh option and set the height < 32 pixels
108 you will get a tiny graph image (thumbnail) to use as an icon for use
109 in an overview, for example. All labeling will be stripped off the
110 graph.
114 [-\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]
116 By default the graph will be autoscaling so that it will adjust the
117 y-axis to the range of the data. You can change this behaviour by
118 explicitly setting the limits. The displayed y-axis will then range at
119 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 permit
124 Sometimes the default algorithm for selecting the y-axis scale is not
125 satisfactory. Normally the scale is selected from a predefined set of
126 ranges and this fails miserably when you need to graph something like
127 "260 + 0.001 * sin(x)". This option calculates the minimum and maximum
128 y-axis from the actual minimum and maximum data values. Our example
129 would display slightly less than "260-0.001" to slightly more than
130 "260+0.001" (this feature was contributed by Sasha Mikheev).
134 Where "--alt-autoscale" will modify both the absolute maximum AND mini-
135 mum values, this option will only affect the minimum value. The maximum
136 value, if not defined on the command line, will be 0. This option can
137 be useful when graphing router traffic when the WAN line uses compres-
138 sion, and thus the throughput may be higher than the WAN line speed.
142 Where "--alt-autoscale" will modify both the absolute maximum AND mini-
143 mum values, this option will only affect the maximum value. The minimum
144 value, if not defined on the command line, will be 0. This option can
145 be useful when graphing router traffic when the WAN line uses compres-
146 sion, and thus the throughput may be higher than the WAN line speed.
150 In order to avoid anti-aliasing blurring effects rrdtool snaps points
151 to device resolution pixels, this results in a crisper appearance. If
152 this is not to your liking, you can use this switch to turn this
153 behaviour off.
155 Gridfitting is turned off for PDF, EPS, SVG output by default.
160 X-Axis
161 [-\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]
165 The x-axis label is quite complex to configure. If you don't have
166 very special needs it is probably best to rely on the autoconfigu-
167 ration to get this right. You can specify the string "none" to sup-
168 press the grid and labels altogether.
170 The grid is defined by specifying a certain amount of time in the
172 "DAY", "WEEK", "MONTH" or "YEAR". Then you define how many of these
176 in _\bL_\bP_\bR and a _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be format string in _\bL_\bF_\bM. _\bL_\bP_\bR defines where each
177 label will be placed. If it is zero, the label will be placed right
178 under the corresponding line (useful for hours, dates etcetera).
179 If you specify a number of seconds here the label is centered on
180 this interval (useful for Monday, January etcetera).
182 --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
184 This places grid lines every 10 minutes, major grid lines every
185 hour, and labels every 4 hours. The labels are placed under the
186 major grid lines as they specify exactly that time.
188 --x-grid HOUR:8:DAY:1:DAY:1:86400:%A
190 This places grid lines every 8 hours, major grid lines and labels
191 each day. The labels are placed exactly between two major grid
192 lines as they specify the complete day and not just midnight.
194 Y-Axis
195 [-\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]
200 placed every _\bl_\ba_\bb_\be_\bl _\bf_\ba_\bc_\bt_\bo_\br lines. You can specify "-y none" to sup-
201 press the grid and labels altogether. The default for this option
202 is to automatically select sensible values.
204 If you have set --y-grid to 'none' not only the labels get sup-
205 pressed, also the space reserved for the labels is removed. You can
206 still add space manually if you use the --units-length command to
207 explicitly reserve space.
211 Place the Y grid dynamically based on the graph's Y range. The
212 algorithm ensures that you always have a grid, that there are
213 enough but not too many grid lines, and that the grid is metric.
214 That is the grid lines are placed every 1, 2, 5 or 10 units. This
215 parameter will also ensure that you get enough decimals displayed
216 even if your graph goes from 69.998 to 70.001. (contributed by
217 Sasha Mikheev).
221 Logarithmic y-axis scaling.
223 [-\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]
225 This sets the 10**exponent scaling of the y-axis values. Normally,
226 values will be scaled to the appropriate units (k, M, etc.). How-
227 ever, you may wish to display units always in k (Kilo, 10e3) even
228 if the data is in the M (Mega, 10e6) range, for instance. Value
229 should be an integer which is a multiple of 3 between -18 and 18
230 inclusively. It is the exponent on the units you wish to use. For
231 example, use 3 to display the y-axis values in k (Kilo, 10e3, thou-
232 sands), use -6 to display the y-axis values in u (Micro, 10e-6,
233 millionths). Use a value of 0 to prevent any scaling of the y-axis
234 values.
236 This option is very effective at confusing the heck out of the
237 default rrdtool autoscaler and grid painter. If rrdtool detects
238 that it is not successful in labeling the graph under the given
239 circumstances, it will switch to the more robust -\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd mode.
243 How many digits should rrdtool assume the y-axis labels to be? You
244 may have to use this option to make enough space once you start
245 fideling with the y-axis labeling.
249 With this option y-axis values on logarithmic graphs will be scaled
250 to the appropriate units (k, M, etc.) instead of using exponential
251 notation. Note that for linear graphs, SI notation is used by
252 default.
258 Only generate the graph if the current graph is out of date or not
259 existent. Note, that all the calculations will happen regardless so
260 that the output of PRINT and graphv will be complete regardless. Note
261 that the behaviour of lazy in this regard has seen several changes over
262 time. The only thing you can realy rely on before rrdtool 1.3.7 is that
263 lazy will not generate the graph when it is already there and up to
264 date, and also that it will output the size of the graph.
268 After the image has been created, the graph function uses printf
269 together with this format string to create output similar to the PRINT
270 function, only that the printf function is supplied with the parameters
271 _\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 tag suitable for
272 including the graph into a web page, the command line would look like
273 this:
275 --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
277 [-\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]]
279 Override the default colors for the standard elements of the graph. The
281 the actual graph, "SHADEA" for the left and top border, "SHADEB" for
282 the right and bottom border, "GRID", "MGRID" for the major grid, "FONT"
283 for the color of the font, "AXIS" for the axis of the graph, "FRAME"
284 for the line around the color spots, and finally "ARROW" for the arrow
285 head pointing up and forward. Each color is composed out of three hex-
286 adecimal numbers specifying its rgb color component (00 is off, FF is
287 maximum) of red, green and blue. Optionally you may add another hex-
288 adecimal number specifying the transparency (FF is solid). You may set
289 this option several times to alter multiple defaults.
291 A green arrow is made by: "--color ARROW#00FF00"
295 Zoom the graphics by the given amount. The factor must be > 0
297 [-\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]]
299 This lets you customize which font to use for the various text elements
300 on the RRD graphs. "DEFAULT" sets the default value for all elements,
301 "TITLE" for the title, "AXIS" for the axis labels, "UNIT" for the ver-
302 tical unit label, "LEGEND" for the graph legend, "WATERMARK" for the
303 watermark on the edge of the graph.
305 Use Times for the title: "--font TITLE:13:Times"
307 If you do not give a font string you can modify just the size of the
308 default font: "--font TITLE:13:".
310 If you specify the size 0 then you can modify just the font without
311 touching the size. This is especially useful for altering the default
312 font without resetting the default fontsizes: "--font
313 DEFAULT:0:Courier".
315 RRDtool comes with a preset default font. You can set the environment
316 variable "RRD_DEFAULT_FONT" if you want to change this.
318 RRDtool uses Pango for its font handling. This means you can to use the
319 full Pango syntax when selecting your font:
321 The font name has the form "[_\bF_\bA_\bM_\bI_\bL_\bY_\b-_\bL_\bI_\bS_\bT] [_\bS_\bT_\bY_\bL_\bE_\b-_\bO_\bP_\bT_\bI_\bO_\bN_\bS] [_\bS_\bI_\bZ_\bE]",
322 where _\bF_\bA_\bM_\bI_\bL_\bY_\b-_\bL_\bI_\bS_\bT is a comma separated list of families optionally ter-
323 minated by a comma, _\bS_\bT_\bY_\bL_\bE_\b__\bO_\bP_\bT_\bI_\bO_\bN_\bS is a whitespace separated list of
324 words where each WORD describes one of style, variant, weight, stretch,
326 followed by the unit modifier "px" for absolute size. Any one of the
327 options may be absent.
329 [-\b-R\bR|-\b--\b-f\bfo\bon\bnt\bt-\b-r\bre\ben\bnd\bde\ber\br-\b-m\bmo\bod\bde\be {n\bno\bor\brm\bma\bal\bl,l\bli\big\bgh\bht\bt,m\bmo\bon\bno\bo}]
331 There are 3 font render modes:
339 [-\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]
341 (this gets ignored in 1.3 for now!)
343 This specifies the largest font size which will be rendered bitmapped,
344 that is, without any font smoothing. By default, no text is rendered
345 bitmapped.
349 All text in rrdtool is rendered using Pango. With the -\b--\b-p\bpa\ban\bng\bgo\bo-\b-m\bma\bar\brk\bku\bup\bp
350 option, all text will be processed by pango markup. This allows to
351 embed some simple html like markup tags using
353 <span key="value">text</span>
355 Apart from the verbose syntax, there are also the following short tags
356 available.
358 b Bold
359 big Makes font relatively larger, equivalent to <span size="larger">
360 i Italic
361 s Strikethrough
362 sub Subscript
363 sup Superscript
364 small Makes font relatively smaller, equivalent to <span size="smaller">
365 tt Monospace font
366 u Underline
368 More details on <http://developer.gnome.org/doc/API/2.0/pango/Pango-
369 MarkupFormat.html>.
371 [-\b-G\bG|-\b--\b-g\bgr\bra\bap\bph\bh-\b-r\bre\ben\bnd\bde\ber\br-\b-m\bmo\bod\bde\be {n\bno\bor\brm\bma\bal\bl,m\bmo\bon\bno\bo}]
373 There are 2 render modes:
381 RRDtool graphs are composed of stair case curves by default. This is in
382 line with the way RRDtool calculates its data. Some people favor a more
383 'organic' look for their graphs even though it is not all that true.
385 [-\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]
387 Image format for the generated graph. For the vector formats you can
388 choose among the standard Postscript fonts Courier-Bold,
389 Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold, Hel-
390 vetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol, Times-Bold,
391 Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
395 (this gets ignored in 1.3 for now!)
397 If images are interlaced they become visible on browsers more quickly.
401 Suppress generation of the legend; only render the graph.
405 Force the generation of HRULE and VRULE legends even if those HRULE or
406 VRULE will not be drawn because out of graph boundaries (mimics
407 behaviour of pre 1.0.42 versions).
411 By default the tab-width is 40 pixels, use this option to change it.
415 If you are graphing memory (and NOT network traffic) this switch should
416 be set to 1024 so that one Kb is 1024 byte. For traffic measurement, 1
417 kb/s is 1000 b/s.
421 Adds the given string as a watermark, horizontally centered, at the
422 bottom of the graph.
426 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]
428 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
430 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
433 statements are useful but optional. See rrdgraph_data and rrdgraph_rpn
434 for the exact format.
438 You need at least one graph element to generate an image and/or at
439 least one print statement to generate a report. See rrdgraph_graph for
440 the exact format.
444 Calling rrdtool with the graphv option will return information in the
445 rrdtool info format. On the command line this means that all output
446 will be in key=value format. When used from the Perl and Ruby bindings
447 a hash pointer will be returned from the call.
449 When the filename '-' is given, the contents of the graph itself will
450 also be returned through this interface (hash key 'image'). On the com-
451 mand line the output will look like this:
453 print[0] = "0.020833"
454 print[1] = "0.0440833"
455 graph_left = 51
456 graph_top = 22
457 graph_width = 400
458 graph_height = 100
459 graph_start = 1232908800
460 graph_end = 1232914200
461 image_width = 481
462 image_height = 154
463 value_min = 0.0000000000e+00
464 value_max = 4.0000000000e-02
465 image = BLOB_SIZE:8196
466 [... 8196 bytes of image data ...]
468 There is more information returned than in the standard interface.
469 Especially the 'graph_*' keys are new. They help applications that want
470 to know what is where on the graph.
473 rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
474 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
476 all of the graph and print functions.
478 Make sure to read rrdgraph_examples for tips&tricks.
481 Program by Tobias Oetiker <tobi@oetiker.ch>
483 This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl> with
484 corrections and/or additions by several people
488 1.3.7 2009-04-07 RRDGRAPH(1)