Code

a new command-line parameter, --week-fmt, by which I can translate the word "week...
[rrdtool-all.git] / program / doc / rrdgraph.pod
1 =head1 NAME
3 rrdgraph - Round Robin Database tool graphing functions
5 =head1 SYNOPSIS
7 B<rrdtool graph|graphv> I<filename>
8 [I<L<option|rrdgraph/OPTIONS>> ...]
9 [I<L<data definition|rrdgraph_data/DEF>> ...]
10 [I<L<data calculation|rrdgraph_data/CDEF>> ...]
11 [I<L<variable definition|rrdgraph_data/VDEF>> ...]
12 [I<L<graph element|rrdgraph_graph/GRAPH>> ...]
13 [I<L<print element|rrdgraph_graph/PRINT>> ...]
15 =head1 DESCRIPTION
17 The B<graph> function of B<RRDtool> is used to present the
18 data from an B<RRD> to a human viewer.  Its main purpose is to
19 create a nice graphical representation, but it can also generate
20 a numerical report.
22 =head1 OVERVIEW
24 B<rrdtool graph> needs data to work with, so you must use one or more
25 B<L<data definition|rrdgraph_data/DEF>> statements to collect this
26 data.  You are not limited to one database, it's perfectly legal to
27 collect data from two or more databases (one per statement, though).
29 If you want to display averages, maxima, percentiles, etcetera
30 it is best to collect them now using the
31 B<L<variable definition|rrdgraph_data/VDEF>> statement.
32 Currently this makes no difference, but in a future version
33 of RRDtool you may want to collect these values before consolidation.
35 The data fetched from the B<RRA> is then B<consolidated> so that
36 there is exactly one data point per pixel in the graph. If you do
37 not take care yourself, B<RRDtool> will expand the range slightly
38 if necessary. Note, in that case the first and/or last pixel may very
39 well become unknown!
41 Sometimes data is not exactly in the format you would like to display
42 it. For instance, you might be collecting B<bytes> per second, but
43 want to display B<bits> per second. This is what the B<L<data
44 calculation|rrdgraph_data/CDEF>> command is designed for. After
45 B<consolidating> the data, a copy is made and this copy is modified
46 using a rather powerful B<L<RPN|rrdgraph_rpn>> command set.
48 When you are done fetching and processing the data, it is time to
49 graph it (or print it).  This ends the B<rrdtool graph> sequence.
51 Use B<graphv> instead of B<graph> to get detailed information about the
52 graph geometry and data once it is drawn. See the bottom of the document for
53 more information.
55 =head1 OPTIONS
59 =head2 I<filename>
61 The name and path of the graph to generate. It is recommended to
62 end this in C<.png>, C<.svg> or C<.eps>, but B<RRDtool> does not enforce this.
64 I<filename> can be 'C<->' to send the image to C<stdout>. In
65 this case, no other output is generated.
67 =head2 Time range
69 [B<-s>|B<--start> I<time>]
70 [B<-e>|B<--end> I<time>]
71 [B<-S>|B<--step> I<seconds>]
73 The start and end of the time series you would like to display, and which
74 B<RRA> the data should come from.  Defaults are: 1 day ago until
75 now, with the best possible resolution. B<Start> and B<end> can
76 be specified in several formats, see
77 L<AT-STYLE TIME SPECIFICATION|rrdfetch> and L<rrdgraph_examples>.
78 By default, B<rrdtool graph> calculates the width of one pixel in
79 the time domain and tries to get data from an B<RRA> with that
80 resolution.  With the B<step> option you can alter this behavior.
81 If you want B<rrdtool graph> to get data at a one-hour resolution
82 from the B<RRD>, set B<step> to 3'600. Note: a step smaller than
83 one pixel will silently be ignored.
85 =head2 Labels
87 [B<-t>|B<--title> I<string>]
88 [B<-v>|B<--vertical-label> I<string>]
90 A horizontal string at the top of the graph and/or a vertically
91 placed string at the left hand side of the graph.
94 =head2 Size
96 [B<-w>|B<--width> I<pixels>]
97 [B<-h>|B<--height> I<pixels>]
98 [B<-j>|B<--only-graph>]
99 [B<-D>|B<--full-size-mode>]
101 By default, the width and height of the B<canvas> (the part with
102 the actual data and such). This defaults to 400 pixels by 100 pixels.
104 If you specify the B<--full-size-mode> option, the width and height
105 specify the final dimensions of the output image and the canvas
106 is automatically resized to fit.
108 If you specify the B<--only-graph> option and set the height E<lt> 32
109 pixels you will get a tiny graph image (thumbnail) to use as an icon
110 for use in an overview, for example. All labeling will be stripped off
111 the graph.
113 =head2 Limits
115 [B<-u>|B<--upper-limit> I<value>]
116 [B<-l>|B<--lower-limit> I<value>]
117 [B<-r>|B<--rigid>]
119 By default the graph will be autoscaling so that it will adjust the
120 y-axis to the range of the data. You can change this behavior by
121 explicitly setting the limits. The displayed y-axis will then range at
122 least from B<lower-limit> to B<upper-limit>. Autoscaling will still
123 permit those boundaries to be stretched unless the B<rigid> option is
124 set.
126 [B<-A>|B<--alt-autoscale>]
128 Sometimes the default algorithm for selecting the y-axis scale is not
129 satisfactory. Normally the scale is selected from a predefined
130 set of ranges and this fails miserably when you need to graph something
131 like C<260 + 0.001 * sin(x)>. This option calculates the minimum and
132 maximum y-axis from the actual minimum and maximum data values. Our example
133 would display slightly less than C<260-0.001> to slightly more than
134 C<260+0.001> (this feature was contributed by Sasha Mikheev).
136 [B<-J>|B<--alt-autoscale-min>]
138 Where C<--alt-autoscale> will modify both the absolute maximum AND minimum
139 values, this option will only affect the minimum value. The maximum
140 value, if not defined on the command line, will be 0. This option can
141 be useful when graphing router traffic when the WAN line uses compression,
142 and thus the throughput may be higher than the WAN line speed.
144 [B<-M>|B<--alt-autoscale-max>]
146 Where C<--alt-autoscale> will modify both the absolute maximum AND minimum
147 values, this option will only affect the maximum value. The minimum
148 value, if not defined on the command line, will be 0. This option can
149 be useful when graphing router traffic when the WAN line uses compression,
150 and thus the throughput may be higher than the WAN line speed.
152 [B<-N>|B<--no-gridfit>]
154 In order to avoid anti-aliasing blurring effects RRDtool snaps
155 points to device resolution pixels, this results in a crisper
156 appearance. If this is not to your liking, you can use this switch
157 to turn this behavior off.
159 Grid-fitting is turned off for PDF, EPS, SVG output by default.
161 =head2 X-Axis
163 [B<-x>|B<--x-grid> I<GTM>B<:>I<GST>B<:>I<MTM>B<:>I<MST>B<:>I<LTM>B<:>I<LST>B<:>I<LPR>B<:>I<LFM>]
165 [B<-x>|B<--x-grid> B<none>]
167 The x-axis label is quite complex to configure. If you don't have
168 very special needs it is probably best to rely on the auto configuration
169 to get this right. You can specify the string C<none> to suppress the grid
170 and labels altogether.
172 The grid is defined by specifying a certain amount of time in the I<?TM>
173 positions. You can choose from C<SECOND>, C<MINUTE>, C<HOUR>, C<DAY>,
174 C<WEEK>, C<MONTH> or C<YEAR>. Then you define how many of these should
175 pass between each line or label.  This pair (I<?TM:?ST>) needs to be
176 specified for the base grid (I<G??>), the major grid (I<M??>) and the
177 labels (I<L??>). For the labels you also must define a precision
178 in I<LPR> and a I<strftime> format string in I<LFM>.  I<LPR> defines
179 where each label will be placed. If it is zero, the label will be
180 placed right under the corresponding line (useful for hours, dates
181 etcetera).  If you specify a number of seconds here the label is
182 centered on this interval (useful for Monday, January etcetera).
184  --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X
186 This places grid lines every 10 minutes, major grid lines every hour,
187 and labels every 4 hours. The labels are placed under the major grid
188 lines as they specify exactly that time.
190  --x-grid HOUR:8:DAY:1:DAY:1:86400:%A
192 This places grid lines every 8 hours, major grid lines and labels
193 each day. The labels are placed exactly between two major grid lines
194 as they specify the complete day and not just midnight.
196 [B<--week-fmt> I<strftime format string>]
198 By default rrdtool uses "Week %V" to render the week number. With this option
199 you can define your own format, without completely overriding the xaxis format.
201 =head2 Y-Axis
203 [B<-y>|B<--y-grid> I<grid step>B<:>I<label factor>]
205 [B<-y>|B<--y-grid> B<none>]
207 Y-axis grid lines appear at each I<grid step> interval.  Labels are
208 placed every I<label factor> lines.  You can specify C<-y none> to
209 suppress the grid and labels altogether.  The default for this option is
210 to automatically select sensible values.
212 If you have set --y-grid to 'none' not only the labels get suppressed, also
213 the space reserved for the labels is removed. You can still add space
214 manually if you use the --units-length command to explicitly reserve space.
216 [B<-Y>|B<--alt-y-grid>]
218 Place the Y grid dynamically based on the graph's Y range. The algorithm
219 ensures that you always have a grid, that there are enough but not too many
220 grid lines, and that the grid is metric. That is the grid lines are placed
221 every 1, 2, 5 or 10 units. This parameter will also ensure that you get
222 enough decimals displayed even if your graph goes from 69.998 to 70.001. 
223 (contributed by Sasha Mikheev).
225 [B<-o>|B<--logarithmic>]
227 Logarithmic y-axis scaling.
229 [B<-X>|B<--units-exponent> I<value>]
231 This sets the 10**exponent scaling of the y-axis values. Normally,
232 values will be scaled to the appropriate units (k, M, etc.).  However,
233 you may wish to display units always in k (Kilo, 10e3) even if the data
234 is in the M (Mega, 10e6) range, for instance. Value should be an
235 integer which is a multiple of 3 between -18 and 18 inclusively.  It is
236 the exponent on the units you wish to use. For example, use 3 to
237 display the y-axis values in k (Kilo, 10e3, thousands), use -6 to
238 display the y-axis values in u (Micro, 10e-6, millionths).  Use a value
239 of 0 to prevent any scaling of the y-axis values.
241 This option is very effective at confusing the heck out of the default
242 RRDtool autoscaling function and grid painter. If RRDtool detects that it is not
243 successful in labeling the graph under the given circumstances, it will switch
244 to the more robust B<--alt-y-grid> mode.
246 [B<-L>|B<--units-length> I<value>]
248 How many digits should RRDtool assume the y-axis labels to be? You
249 may have to use this option to make enough space once you start
250 fiddling with the y-axis labeling.
252 [B<--units=si>]
254 With this option y-axis values on logarithmic graphs will be scaled to 
255 the appropriate units (k, M, etc.) instead of using exponential notation.
256 Note that for linear graphs, SI notation is used by default.
258 =head2 Right Y Axis
260 [B<--right-axis> I<scale>B<:>I<shift>]
261 [B<--right-axis-label> I<label>]
263 A second axis will be drawn to the right of the graph. It is tied to the
264 left axis via the scale and shift parameters. You can also define a label
265 for the right axis.
267 [B<--right-axis-format> I<format-string>]
269 By default the format of the axis labels gets determined automatically. If
270 you want to do this your self, use this option with the same %lf arguments
271 you know from the PRINT and GPRINT commands.
273 =head2 Legend
275 [B<-g>|B<--no-legend>]
277 Suppress generation of the legend; only render the graph.
279 [B<-F>|B<--force-rules-legend>]
281 Force the generation of HRULE and VRULE legends even if those HRULE or
282 VRULE will not be drawn because out of graph boundaries (mimics
283 behavior of pre 1.0.42 versions).
285 [B<--legend-position>=(north|south|west|east)]
287 Place the legend at the given side of the graph. The default is south.
288 In west or east position it is necessary to add line breaks manually.
290 [B<--legend-direction>=(topdown|bottomup)]
292 Place the legend items in the given vertical order. The default is topdown.
293 Using bottomup the legend items appear in the same vertical order as a
294 stack of lines or areas.
296 =head2 Miscellaneous
298 [B<-z>|B<--lazy>]
300 Only generate the graph if the current graph is out of date or not existent.
301 Note, that all the calculations will happen regardless so that the output of
302 PRINT and graphv will be complete regardless. Note that the behavior of
303 lazy in this regard has seen several changes over time. The only thing you
304 can really rely on before RRDtool 1.3.7 is that lazy will not generate the
305 graph when it is already there and up to date, and also that it will output
306 the size of the graph. 
308 [B<--daemon> I<address>]
310 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
311 to the server before reading the RRD files. This allows the graph to contain
312 fresh data even if the daemon is configured to cache values for a long time.
313 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
315  rrdtool graph [...] --daemon unix:/var/run/rrdcached.sock [...]
317 [B<-f>|B<--imginfo> I<printfstr>]
319 After the image has been created, the graph function uses printf
320 together with this format string to create output similar to the PRINT
321 function, only that the printf function is supplied with the parameters
322 I<filename>, I<xsize> and I<ysize>. In order to generate an B<IMG> tag
323 suitable for including the graph into a web page, the command line
324 would look like this:
326  --imginfo '<IMG SRC="/img/%s" WIDTH="%lu" HEIGHT="%lu" ALT="Demo">'
328 [B<-c>|B<--color> I<COLORTAG>#I<rrggbb>[I<aa>]]
330 Override the default colors for the standard elements of the graph. The
331 I<COLORTAG> is one of C<BACK> background, C<CANVAS> for the background of
332 the actual graph, C<SHADEA> for the left and top border, C<SHADEB> for the
333 right and bottom border, C<GRID>, C<MGRID> for the major grid, C<FONT> for
334 the color of the font, C<AXIS> for the axis of the graph, C<FRAME> for the
335 line around the color spots, and finally C<ARROW> for the arrow head pointing
336 up and forward. Each color is composed out of three hexadecimal numbers
337 specifying its rgb color component (00 is off, FF is maximum) of red, green
338 and blue. Optionally you may add another hexadecimal number specifying the
339 transparency (FF is solid). You may set this option several times to alter
340 multiple defaults.
342 A green arrow is made by: C<--color ARROW#00FF00>
344 [B<--grid-dash> I<on>B<:>I<off>]
346 by default the grid is drawn in a 1 on, 1 off pattern. With this option you can set this yourself
348  --grid-dash 1:3    for a dot grid
349  
350  --grid-dash 1:0    for uninterrupted grid lines
352 [B<--border> I<width>]]
354 Width in pixels for the 3d border drawn around the image. Default 2, 0
355 disables the border. See C<SHADEA> and C<SHADEB> above for setting the border
356 color.
358 [B<--dynamic-labels>]
360 Pick the shape of the color marker next to the label according to the element drawn on the graph.
362 [B<-m>|B<--zoom> I<factor>]
364 Zoom the graphics by the given amount. The factor must be E<gt> 0
366 [B<-n>|B<--font> I<FONTTAG>B<:>I<size>B<:>[I<font>]]
368 This lets you customize which font to use for the various text elements on
369 the RRD graphs. C<DEFAULT> sets the default value for all elements, C<TITLE>
370 for the title, C<AXIS> for the axis labels, C<UNIT> for the vertical unit
371 label, C<LEGEND> for the graph legend, C<WATERMARK> for the watermark on the
372 edge of the graph.
374 Use Times for the title: C<--font TITLE:13:Times>
376 Note that you need to quote the argument to B<--font> if the font-name
377 contains whitespace:
378 --font "TITLE:13:Some Font"
380 If you do not give a font string you can modify just the size of the default font:
381 C<--font TITLE:13:>.
383 If you specify the size 0 then you can modify just the font without touching
384 the size. This is especially useful for altering the default font without
385 resetting the default fontsizes: C<--font DEFAULT:0:Courier>.
387 RRDtool comes with a preset default font. You can set the environment
388 variable C<RRD_DEFAULT_FONT> if you want to change this.
390 RRDtool uses Pango for its font handling. This means you can to use
391 the full Pango syntax when selecting your font:
393 The font name has the form "[I<FAMILY-LIST>] [I<STYLE-OPTIONS>] [I<SIZE>]",
394 where I<FAMILY-LIST> is a comma separated list of families optionally
395 terminated by a comma, I<STYLE_OPTIONS> is a whitespace separated list of
396 words where each WORD describes one of style, variant, weight, stretch, or
397 gravity, and I<SIZE> is a decimal number (size in points) or optionally
398 followed by the unit modifier "px" for absolute size. Any one of the options
399 may be absent.
401 [B<-R>|B<--font-render-mode> {B<normal>,B<light>,B<mono>}]
403 There are 3 font render modes:
405 B<normal>: Full Hinting and Anti-aliasing (default)
407 B<light>: Slight Hinting and Anti-aliasing
409 B<mono>: Full Hinting and NO Anti-aliasing
412 [B<-B>|B<--font-smoothing-threshold> I<size>]
414 (this gets ignored in 1.3 for now!)
416 This specifies the largest font size which will be rendered
417 bitmapped, that is, without any font smoothing. By default,
418 no text is rendered bitmapped.
420 [B<-P>|B<--pango-markup>]
422 All text in RRDtool is rendered using Pango. With the B<--pango-markup> option, all
423 text will be processed by pango markup. This allows to embed some simple html
424 like markup tags using 
426  <span key="value">text</span>
428 Apart from the verbose syntax, there are also the following short tags available.
430  b     Bold
431  big   Makes font relatively larger, equivalent to <span size="larger">
432  i     Italic
433  s     Strikethrough
434  sub   Subscript
435  sup   Superscript
436  small Makes font relatively smaller, equivalent to <span size="smaller">
437  tt    Monospace font
438  u     Underline 
440 More details on L<http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html>.
442 [B<-G>|B<--graph-render-mode> {B<normal>,B<mono>}]
444 There are 2 render modes:
446 B<normal>: Graphs are fully Anti-aliased (default)
448 B<mono>: No Anti-aliasing
450 [B<-E>|B<--slope-mode>]
452 RRDtool graphs are composed of stair case curves by default. This is in line with
453 the way RRDtool calculates its data. Some people favor a more 'organic' look
454 for their graphs even though it is not all that true.
456 [B<-a>|B<--imgformat> B<PNG>|B<SVG>|B<EPS>|B<PDF>]
458 Image format for the generated graph. For the vector formats you can
459 choose among the standard Postscript fonts Courier-Bold,
460 Courier-BoldOblique, Courier-Oblique, Courier, Helvetica-Bold,
461 Helvetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
462 Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
464 [B<-i>|B<--interlaced>]
466 (this gets ignored in 1.3 for now!)
468 If images are interlaced they become visible on browsers more quickly.
470 [B<-T>|B<--tabwidth> I<value>]
472 By default the tab-width is 40 pixels, use this option to change it.
474 [B<-b>|B<--base> I<value>]
476 If you are graphing memory (and NOT network traffic) this switch
477 should be set to 1024 so that one Kb is 1024 byte. For traffic
478 measurement, 1 kb/s is 1000 b/s.
480 [B<-W>|B<--watermark> I<string>]
482 Adds the given string as a watermark, horizontally centered, at the bottom 
483 of the graph.
485 =head2 Data and variables
487 B<DEF:>I<vname>B<=>I<rrdfile>B<:>I<ds-name>B<:>I<CF>[B<:step=>I<step>][B<:start=>I<time>][B<:end=>I<time>]
489 B<CDEF:>I<vname>B<=>I<RPN expression>
491 B<VDEF:>I<vname>B<=>I<RPN expression>
493 You need at least one B<DEF> and one B<LINE>, B<AREA>, B<GPRINT>, B<PRINT>
494 statement to generate anything useful.
496 See L<rrdgraph_data> and L<rrdgraph_rpn> for the exact format.
498 NOTE: B<Graph and print elements>
500 You need at least one graph element to generate an image and/or
501 at least one print statement to generate a report.
502 See L<rrdgraph_graph> for the exact format.
504 =head2 graphv
506 Calling RRDtool with the graphv option will return information in the
507 RRDtool info format. On the command line this means that all output will be
508 in key=value format. When used from the Perl and Ruby bindings a hash
509 pointer will be returned from the call.
511 When the filename '-' is given, the contents of the graph itself will also
512 be returned through this interface (hash key 'image'). On the command line
513 the output will look like this:
515  print[0] = "0.020833"
516  print[1] = "0.0440833"
517  graph_left = 51
518  graph_top = 22
519  graph_width = 400
520  graph_height = 100
521  graph_start = 1232908800
522  graph_end = 1232914200
523  image_width = 481
524  image_height = 154
525  value_min = 0.0000000000e+00
526  value_max = 4.0000000000e-02
527  image = BLOB_SIZE:8196
528  [... 8196 bytes of image data ...]
530 There is more information returned than in the standard interface.
531 Especially the 'graph_*' keys are new. They help applications that want to
532 know what is where on the graph.
534 =head1 ENVIRONMENT VARIABLES
536 The following environment variables may be used to change the behavior of
537 C<rrdtoolE<nbsp>graph>:
539 =over 4
541 =item B<RRDCACHED_ADDRESS>
543 If this environment variable is set it will have the same effect as specifying
544 the C<--daemon> option on the command line. If both are present, the command
545 line argument takes precedence.
547 =back
549 =head1 SEE ALSO
551 L<rrdgraph> gives an overview of how B<rrdtool graph> works.
552 L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail.
553 L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements.
554 L<rrdgraph_graph> page describes all of the graph and print functions.
556 Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
558 =head1 AUTHOR
560 Program by Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
562 This manual page by Alex van den Bogaerdt E<lt>alex@vandenbogaerdt.nlE<gt>
563 with corrections and/or additions by several people