d18c746ad38cf83cfe54e5920505bc775c725b35
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
48 the graph using the same format as rrdtool info (key = value). See
49 the bottom of the document for more information.
51 filename
52 The name and path of the graph to generate. It is recommended to
54 this.
57 no other output is generated.
59 Time range
60 [-\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]
62 The start and end of the time series you would like to display, and
65 fied in several formats, see AT-STYLE TIME SPECIFICATION and rrd-
66 graph_examples. By default, r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh calculates the width of
69 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
71 than one pixel will silently be ignored.
73 Labels
74 [-\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]
76 A horizontal string at the top of the graph and/or a vertically
77 placed string at the left hand side of the graph.
79 Size
80 [-\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]
84 actual data and such). This defaults to 400 pixels by 100 pixels.
86 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
87 specify the final dimensions of the output image and the canvas is
88 automatically resized to fit.
90 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-
91 els you will get a tiny graph image (thumbnail) to use as an icon
92 for use in an overview, for example. All labeling will be stripped
93 off the graph.
95 Limits
96 [-\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]
98 By default the graph will be autoscaling so that it will adjust the
99 y-axis to the range of the data. You can change this behaviour by
100 explicitly setting the limits. The displayed y-axis will then range
101 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
103 set.
107 Sometimes the default algorithm for selecting the y-axis scale is
108 not satisfactory. Normally the scale is selected from a predefined
109 set of ranges and this fails miserably when you need to graph some-
110 thing like "260 + 0.001 * sin(x)". This option calculates the mini-
111 mum and maximum y-axis from the actual minimum and maximum data
112 values. Our example would display slightly less than "260-0.001" to
113 slightly more than "260+0.001" (this feature was contributed by
114 Sasha Mikheev).
118 Where "--alt-autoscale" will modify both the absolute maximum AND
119 minimum values, this option will only affect the minimum value. The
120 maximum value, if not defined on the command line, will be 0. This
121 option can be useful when graphing router traffic when the WAN line
122 uses compression, and thus the throughput may be higher than the
123 WAN line speed.
127 Where "--alt-autoscale" will modify both the absolute maximum AND
128 minimum values, this option will only affect the maximum value. The
129 minimum value, if not defined on the command line, will be 0. This
130 option can be useful when graphing router traffic when the WAN line
131 uses compression, and thus the throughput may be higher than the
132 WAN line speed.
136 In order to avoid anti-aliasing blurring effects rrdtool snaps
137 points to device resolution pixels, this results in a crisper aper-
138 ance. If this is not to your liking, you can use this switch to
139 turn this behaviour off.
141 Gridfitting is turned off for PDF, EPS, SVG output by default.
143 Grid
144 X-Axis
145 [-\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]
149 The x-axis label is quite complex to configure. If you don't
150 have very special needs it is probably best to rely on the
151 autoconfiguration to get this right. You can specify the string
152 "none" to suppress the grid and labels altogether.
154 The grid is defined by specifying a certain amount of time in
156 "HOUR", "DAY", "WEEK", "MONTH" or "YEAR". Then you define how
157 many of these should pass between each line or label. This
162 it is zero, the label will be placed right under the corre-
163 sponding line (useful for hours, dates etcetera). If you spec-
164 ify a number of seconds here the label is centered on this
165 interval (useful for Monday, January etcetera).
167 --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
169 This places grid lines every 10 minutes, major grid lines every
170 hour, and labels every 4 hours. The labels are placed under the
171 major grid lines as they specify exactly that time.
173 --x-grid HOUR:8:DAY:1:DAY:1:86400:%A
175 This places grid lines every 8 hours, major grid lines and
176 labels each day. The labels are placed exactly between two
177 major grid lines as they specify the complete day and not just
178 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]
187 to suppress the grid and labels altogether. The default for
188 this option 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.
192 You can still add space manually if you use the --units-length
193 command 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 met-
200 ric. That is the grid lines are placed every 1, 2, 5 or 10
201 units. This parameter will also ensure that you get enough dec-
202 imals displayed even if your graph goes from 69.998 to 70.001.
203 (contributed by 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. Nor-
212 mally, values will be scaled to the appropriate units (k, M,
213 etc.). However, you may wish to display units always in k
214 (Kilo, 10e3) even if the data is in the M (Mega, 10e6) range,
215 for instance. Value should be an integer which is a multiple of
216 3 between -18 and 18 inclusively. It is the exponent on the
217 units you wish to use. For example, use 3 to display the y-axis
218 values in k (Kilo, 10e3, thousands), use -6 to display the
219 y-axis values in u (Micro, 10e-6, millionths). Use a value of
220 0 to prevent any scaling of the y-axis 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
226 mode.
230 How many digits should rrdtool assume the y-axis labels to be?
231 You may have to use this option to make enough space once you
232 start fideling with the y-axis labeling.
236 With this option y-axis values on logarithmic graphs will be
237 scaled to the appropriate units (k, M, etc.) instead of using
238 exponential notation. Note that for linear graphs, SI notation
239 is used by default.
241 Miscellaneous
244 Only generate the graph if the current graph is out of date or not
245 existent.
249 After the image has been created, the graph function uses printf
250 together with this format string to create output similar to the
251 PRINT function, only that the printf function is supplied with the
252 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
253 tag suitable for including the graph into a web page, the command
254 line would look like this:
256 --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
258 [-\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]]
260 Override the default colors for the standard elements of the graph.
262 ground of the actual graph, "SHADEA" for the left and top border,
263 "SHADEB" for the right and bottom border, "GRID", "MGRID" for the
264 major grid, "FONT" for the color of the font, "AXIS" for the axis
265 of the graph, "FRAME" for the line around the color spots and
266 finally "ARROW" for the arrow head pointing up and forward. Each
267 color is composed out of three hexadecimal numbers specifying its
268 rgb color component (00 is off, FF is maximum) of red, green and
269 blue. Optionally you may add another hexadecimal number specifying
270 the transparency (FF is solid). You may set this option several
271 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 ele-
282 ments on the RRD graphs. "DEFAULT" sets the default value for all
283 elements, "TITLE" for the title, "AXIS" for the axis labels, "UNIT"
284 for the vertical 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
289 the 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
293 default font without resetting the default fontsizes: "--font
294 DEFAULT:0:Courier".
296 RRDtool comes with a preset default font. You can set the environ-
297 ment variable "RRD_DEFAULT_FONT" if you want to change this.
299 RRDtool uses Pango for its font handling. This means you can to use
300 the 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
304 terminated by a comma, _\bS_\bT_\bY_\bL_\bE_\b__\bO_\bP_\bT_\bI_\bO_\bN_\bS is a whitespace separated list
305 of words where each WORD describes one of style, variant, weight,
307 or optionally followed by the unit modifier "px" for absolute size.
308 Any one of the 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
325 bitmapped, that is, without any font smoothing. By default, no text
326 is rendered bitmapped.
328 [-\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}]
330 There are 2 render modes:
338 RRDtool graphs are composed of stair case curves by default. This
339 is in line with the way RRDtool calculates its data. Some people
340 favor a more 'organic' look for their graphs even though it is not
341 all that true.
343 [-\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]
345 Image format for the generated graph. For the vector formats you
346 can choose among the standard Postscript fonts Courier-Bold,
347 Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold, Hel-
348 vetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
349 Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfD-
350 ingbats.
354 (this gets ignored in 1.3 for now!)
356 If images are interlaced they become visible on browsers more
357 quickly.
361 Suppress generation of the legend; only render the graph.
365 Force the generation of HRULE and VRULE legends even if those HRULE
366 or VRULE will not be drawn because out of graph boundaries (mimics
367 behaviour of pre 1.0.42 versions).
371 By default the tab-width is 40 pixels, use this option to change
372 it.
376 If you are graphing memory (and NOT network traffic) this switch
377 should be set to 1024 so that one Kb is 1024 byte. For traffic mea-
378 surement, 1 kb/s is 1000 b/s.
382 Adds the given string as a watermark, horizontally centred, at the
383 bottom of the graph.
385 Data and variables
386 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]
388 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
390 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
393 statements are useful but optional. See rrdgraph_data and rrd-
394 graph_rpn for the exact format.
396 Graph and print elements
397 You need at least one graph element to generate an image and/or at
398 least one print statement to generate a report. See rrdgraph_graph
399 for the exact format.
401 Markup
402 All text in rrdtool is rendered using Pango markup. This means text
403 can contain embeded markup instructions. Simple html markup using
405 <span key="value">text</span>
407 can be used. Apart from the verbose syntax, there are also the fol-
408 lowing short tags available.
410 b Bold
411 big Makes font relatively larger, equivalent to <span size="larger">
412 i Italic
413 s Strikethrough
414 sub Subscript
415 sup Superscript
416 small Makes font relatively smaller, equivalent to <span size="smaller">
417 tt Monospace font
418 u Underline
420 More details on http://developer.gnome.org/doc/API/2.0/pango/Pango-
421 MarkupFormat.html.
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.3rc6 2008-04-21 RRDGRAPH(1)