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-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]
87 actual data and such). This defaults to 400 pixels by 100 pixels.
89 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-
90 ify the final dimensions of the output image and the canvas is automat-
91 ically resized to fit.
93 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
94 you will get a tiny graph image (thumbnail) to use as an icon for use
95 in an overview, for example. All labeling will be stripped off the
96 graph.
100 [-\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]
102 By default the graph will be autoscaling so that it will adjust the
103 y-axis to the range of the data. You can change this behaviour by
104 explicitly setting the limits. The displayed y-axis will then range at
105 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
110 Sometimes the default algorithm for selecting the y-axis scale is not
111 satisfactory. Normally the scale is selected from a predefined set of
112 ranges and this fails miserably when you need to graph something like
113 "260 + 0.001 * sin(x)". This option calculates the minimum and maximum
114 y-axis from the actual minimum and maximum data values. Our example
115 would display slightly less than "260-0.001" to slightly more than
116 "260+0.001" (this feature was contributed by Sasha Mikheev).
120 Where "--alt-autoscale" will modify both the absolute maximum AND mini-
121 mum values, this option will only affect the minimum value. The maximum
122 value, if not defined on the command line, will be 0. This option can
123 be useful when graphing router traffic when the WAN line uses compres-
124 sion, and thus the throughput may be higher than the WAN line speed.
128 Where "--alt-autoscale" will modify both the absolute maximum AND mini-
129 mum values, this option will only affect the maximum value. The minimum
130 value, if not defined on the command line, will be 0. This option can
131 be useful when graphing router traffic when the WAN line uses compres-
132 sion, and thus the throughput may be higher than the WAN line speed.
136 In order to avoid anti-aliasing blurring effects rrdtool snaps points
137 to device resolution pixels, this results in a crisper aperance. If
138 this is not to your liking, you can use this switch to turn this
139 behaviour off.
141 Gridfitting is turned off for PDF, EPS, SVG output by default.
146 X-Axis
147 [-\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]
151 The x-axis label is quite complex to configure. If you don't have
152 very special needs it is probably best to rely on the autoconfigu-
153 ration to get this right. You can specify the string "none" to sup-
154 press the grid and labels altogether.
156 The grid is defined by specifying a certain amount of time in the
158 "DAY", "WEEK", "MONTH" or "YEAR". Then you define how many of these
162 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
163 label will be placed. If it is zero, the label will be placed right
164 under the corresponding line (useful for hours, dates etcetera).
165 If you specify a number of seconds here the label is centered on
166 this interval (useful for Monday, January etcetera).
168 --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
170 This places grid lines every 10 minutes, major grid lines every
171 hour, and labels every 4 hours. The labels are placed under the
172 major grid lines as they specify exactly that time.
174 --x-grid HOUR:8:DAY:1:DAY:1:86400:%A
176 This places grid lines every 8 hours, major grid lines and labels
177 each day. The labels are placed exactly between two major grid
178 lines as they specify the complete day and not just midnight.
180 Y-Axis
181 [-\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]
186 placed every _\bl_\ba_\bb_\be_\bl _\bf_\ba_\bc_\bt_\bo_\br lines. You can specify "-y none" to sup-
187 press the grid and labels altogether. The default for this option
188 is to automatically select sensible values.
190 If you have set --y-grid to 'none' not only the labels get
191 supressed, also the space reserved for the labels is removed. You
192 can still add space manually if you use the --units-length command
193 to explicitly reserve space.
197 Place the Y grid dynamically based on the graph's Y range. The
198 algorithm ensures that you always have a grid, that there are
199 enough but not too many grid lines, and that the grid is metric.
200 That is the grid lines are placed every 1, 2, 5 or 10 units. This
201 parameter will also ensure that you get enough decimals displayed
202 even if your graph goes from 69.998 to 70.001. (contributed by
203 Sasha Mikheev).
207 Logarithmic y-axis scaling.
209 [-\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]
211 This sets the 10**exponent scaling of the y-axis values. Normally,
212 values will be scaled to the appropriate units (k, M, etc.). How-
213 ever, you may wish to display units always in k (Kilo, 10e3) even
214 if the data is in the M (Mega, 10e6) range, for instance. Value
215 should be an integer which is a multiple of 3 between -18 and 18
216 inclusively. It is the exponent on the units you wish to use. For
217 example, use 3 to display the y-axis values in k (Kilo, 10e3, thou-
218 sands), use -6 to display the y-axis values in u (Micro, 10e-6,
219 millionths). Use a value of 0 to prevent any scaling of the y-axis
220 values.
222 This option is very effective at confusing the heck out of the
223 default rrdtool autoscaler and grid painter. If rrdtool detects
224 that it is not successful in labeling the graph under the given
225 circumstances, it will switch to the more robust -\b--\b-a\bal\blt\bt-\b-y\by-\b-g\bgr\bri\bid\bd mode.
229 How many digits should rrdtool assume the y-axis labels to be? You
230 may have to use this option to make enough space once you start
231 fideling with the y-axis labeling.
235 With this option y-axis values on logarithmic graphs will be scaled
236 to the appropriate units (k, M, etc.) instead of using exponential
237 notation. Note that for linear graphs, SI notation is used by
238 default.
244 Only generate the graph if the current graph is out of date or not
245 existent. Note, that only the image size will be returned, if you run
246 with lazy even when using graphv.
250 After the image has been created, the graph function uses printf
251 together with this format string to create output similar to the PRINT
252 function, only that the printf function is supplied with the parameters
253 _\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
254 including the graph into a web page, the command line would look like
255 this:
257 --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
259 [-\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]]
261 Override the default colors for the standard elements of the graph. The
263 the actual graph, "SHADEA" for the left and top border, "SHADEB" for
264 the right and bottom border, "GRID", "MGRID" for the major grid, "FONT"
265 for the color of the font, "AXIS" for the axis of the graph, "FRAME"
266 for the line around the color spots and finally "ARROW" for the arrow
267 head pointing up and forward. Each color is composed out of three hex-
268 adecimal numbers specifying its rgb color component (00 is off, FF is
269 maximum) of red, green and blue. Optionally you may add another hex-
270 adecimal number specifying the transparency (FF is solid). You may set
271 this option several times to alter multiple defaults.
273 A green arrow is made by: "--color ARROW#00FF00"
277 Zoom the graphics by the given amount. The factor must be > 0
279 [-\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]]
281 This lets you customize which font to use for the various text elements
282 on the RRD graphs. "DEFAULT" sets the default value for all elements,
283 "TITLE" for the title, "AXIS" for the axis labels, "UNIT" for the ver-
284 tical unit label, "LEGEND" for the graph legend.
286 Use Times for the title: "--font TITLE:13:Times"
288 If you do not give a font string you can modify just the sice of the
289 default font: "--font TITLE:13:".
291 If you specify the size 0 then you can modify just the font without
292 touching the size. This is especially usefull for altering the default
293 font without resetting the default fontsizes: "--font
294 DEFAULT:0:Courier".
296 RRDtool comes with a preset default font. You can set the environment
297 variable "RRD_DEFAULT_FONT" if you want to change this.
299 RRDtool uses Pango for its font handling. This means you can to use the
300 full Pango syntax when selecting your font:
302 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]",
303 where _\bF_\bA_\bM_\bI_\bL_\bY_\b-_\bL_\bI_\bS_\bT is a comma separated list of families optionally ter-
304 minated by a comma, _\bS_\bT_\bY_\bL_\bE_\b__\bO_\bP_\bT_\bI_\bO_\bN_\bS is a whitespace separated list of
305 words where each WORD describes one of style, variant, weight, stretch,
307 followed by the unit modifier "px" for absolute size. Any one of the
308 options may be absent.
310 [-\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}]
312 There are 3 font render modes:
320 [-\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]
322 (this gets ignored in 1.3 for now!)
324 This specifies the largest font size which will be rendered bitmapped,
325 that is, without any font smoothing. By default, no text is rendered
326 bitmapped.
330 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
331 option, all text will be processed by pango markup. This allows to
332 embed some simple html like markup tags using
334 <span key="value">text</span>
336 Apart from the verbose syntax, there are also the following short tags
337 available.
339 b Bold
340 big Makes font relatively larger, equivalent to <span size="larger">
341 i Italic
342 s Strikethrough
343 sub Subscript
344 sup Superscript
345 small Makes font relatively smaller, equivalent to <span size="smaller">
346 tt Monospace font
347 u Underline
349 More details on <http://developer.gnome.org/doc/API/2.0/pango/Pango-
350 MarkupFormat.html>.
352 [-\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}]
354 There are 2 render modes:
362 RRDtool graphs are composed of stair case curves by default. This is in
363 line with the way RRDtool calculates its data. Some people favor a more
364 'organic' look for their graphs even though it is not all that true.
366 [-\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]
368 Image format for the generated graph. For the vector formats you can
369 choose among the standard Postscript fonts Courier-Bold,
370 Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold, Hel-
371 vetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol, Times-Bold,
372 Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
376 (this gets ignored in 1.3 for now!)
378 If images are interlaced they become visible on browsers more quickly.
382 Suppress generation of the legend; only render the graph.
386 Force the generation of HRULE and VRULE legends even if those HRULE or
387 VRULE will not be drawn because out of graph boundaries (mimics
388 behaviour of pre 1.0.42 versions).
392 By default the tab-width is 40 pixels, use this option to change it.
396 If you are graphing memory (and NOT network traffic) this switch should
397 be set to 1024 so that one Kb is 1024 byte. For traffic measurement, 1
398 kb/s is 1000 b/s.
402 Adds the given string as a watermark, horizontally centred, at the bot-
403 tom of the graph.
407 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]
409 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
411 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
414 statements are useful but optional. See rrdgraph_data and rrdgraph_rpn
415 for the exact format.
419 You need at least one graph element to generate an image and/or at
420 least one print statement to generate a report. See rrdgraph_graph for
421 the exact format.
425 Calling rrdtool with the graphv option will return information in the
426 rrdtool info format. On the command line this means that all output
427 will be in key=value format. When used from the perl and ruby bindings
428 a hash pointer will be returned from the call.
430 When the filename '-' is given, the contents of the graph itself will
431 also be returned through this interface (hash key 'image'). On the com-
432 mand line the output will look like this:
434 print[0] = "0.020833"
435 print[1] = "0.0440833"
436 graph_left = 51
437 graph_top = 22
438 graph_width = 400
439 graph_height = 100
440 image_width = 481
441 image_height = 154
442 value_min = 0.0000000000e+00
443 value_max = 4.0000000000e-02
444 image = BLOB_SIZE:8196
445 [... 8196 bytes of image data ...]
447 There is more information returned than in the standard interface.
448 Especially the 'graph_*' keys are new. They help applications that want
449 to know what is where on the graph.
452 rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works. rrdgraph_data
453 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
455 all of the graph and print functions.
457 Make sure to read rrdgraph_examples for tips&tricks.
460 Program by Tobias Oetiker <tobi@oetiker.ch>
462 This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
466 1.3.1 2008-06-29 RRDGRAPH(1)