rrdgraph - Round Robin Database tool grapher functions
+rrdgraph - Round Robin Database tool graphing functions
The data fetched from the RRA is then consolidated so that -there is exactly one datapoint per pixel in the graph. If you do +there is exactly one data point per pixel in the graph. If you do not take care yourself, RRDtool will expand the range slightly if necessary. Note, in that case the first and/or last pixel may very well become unknown!
@@ -89,19 +97,15 @@ want to display bits per second. This is what the RPN command set.When you are done fetching and processing the data, it is time to graph it (or print it). This ends the rrdtool graph sequence.
+Use graphv instead of graph to get detailed information about the +graph geometry and data once it is drawn. See the bottom of the document for +more information.
-
This alternate version of graph takes the same arguments and performs the -same function. The v stands for verbose, which describes the output -returned. graphv will return a lot of information about the graph using -the same format as rrdtool info (key = value). See the bottom of the document for more information.
--
The name and path of the graph to generate. It is recommended to
end this in .png, .svg or .eps, but RRDtool does not enforce this.
-
[--right-axis scale:shift] -[--right-axis-label label]
-A second axis will be drawn to the right of the graph. It is tied to the -left axis via the scale and shift parameters. You can also define a label -for the right axis.
-[--right-axis-format format-string]
-By default the format of the axis lables gets determined automatically. If -you want todo this your self, use this option with the same %lf arguments -you know from the PRING and GPRINT commands.
--
[-w|--width pixels] [-h|--height pixels] @@ -166,7 +158,7 @@ the graph.
[-l|--lower-limit value] [-r|--rigid]By default the graph will be autoscaling so that it will adjust the -y-axis to the range of the data. You can change this behaviour by +y-axis to the range of the data. You can change this behavior by explicitly setting the limits. The displayed y-axis will then range at least from lower-limit to upper-limit. Autoscaling will still permit those boundaries to be stretched unless the rigid option is @@ -192,22 +184,18 @@ value, if not defined on the command line, will be 0. This option can be useful when graphing router traffic when the WAN line uses compression, and thus the throughput may be higher than the WAN line speed.
[-N|--no-gridfit]
-In order to avoid anti-aliasing blurring effects rrdtool snaps +
In order to avoid anti-aliasing blurring effects RRDtool snaps points to device resolution pixels, this results in a crisper appearance. If this is not to your liking, you can use this switch -to turn this behaviour off.
-Gridfitting is turned off for PDF, EPS, SVG output by default.
+to turn this behavior off. +Grid-fitting is turned off for PDF, EPS, SVG output by default.
-
[-x|--x-grid GTM:GST:MTM:MST:LTM:LST:LPR:LFM]
[-x|--x-grid none]
The x-axis label is quite complex to configure. If you don't have
-very special needs it is probably best to rely on the autoconfiguration
+very special needs it is probably best to rely on the auto configuration
to get this right. You can specify the string none to suppress the grid
and labels altogether.
The grid is defined by specifying a certain amount of time in the ?TM @@ -231,10 +219,9 @@ lines as they specify exactly that time.
This places grid lines every 8 hours, major grid lines and labels each day. The labels are placed exactly between two major grid lines as they specify the complete day and not just midnight.
-+
+[-y|--y-grid grid step:label factor]
[-y|--y-grid none]
Y-axis grid lines appear at each grid step interval. Labels are @@ -264,30 +251,63 @@ display the y-axis values in k (Kilo, 10e3, thousands), use -6 to display the y-axis values in u (Micro, 10e-6, millionths). Use a value of 0 to prevent any scaling of the y-axis values.
This option is very effective at confusing the heck out of the default -rrdtool autoscaler and grid painter. If rrdtool detects that it is not +RRDtool autoscaling function and grid painter. If RRDtool detects that it is not successful in labeling the graph under the given circumstances, it will switch to the more robust --alt-y-grid mode.
[-L|--units-length value]
-How many digits should rrdtool assume the y-axis labels to be? You +
How many digits should RRDtool assume the y-axis labels to be? You may have to use this option to make enough space once you start -fideling with the y-axis labeling.
+fiddling with the y-axis labeling.[--units=si]
With this option y-axis values on logarithmic graphs will be scaled to the appropriate units (k, M, etc.) instead of using exponential notation. Note that for linear graphs, SI notation is used by default.
-+
+[--right-axis scale:shift] +[--right-axis-label label]
+A second axis will be drawn to the right of the graph. It is tied to the +left axis via the scale and shift parameters. You can also define a label +for the right axis.
+[--right-axis-format format-string]
+By default the format of the axis labels gets determined automatically. If +you want to do this your self, use this option with the same %lf arguments +you know from the PRING and GPRINT commands.
++
+[-g|--no-legend]
+Suppress generation of the legend; only render the graph.
+[-F|--force-rules-legend]
+Force the generation of HRULE and VRULE legends even if those HRULE or +VRULE will not be drawn because out of graph boundaries (mimics +behavior of pre 1.0.42 versions).
+[--legend-position=(north|south|west|east)]
+Place the legend at the given side of the graph. The default is south. +In west or east position it is necessary to add line breaks manually.
+[--legend-direction=(topdown|bottomup)]
+Place the legend items in the given vertical order. The default is topdown. +Using bottomup the legend items appear in the same vertical order as a +stack of lines or areas.
[-z|--lazy]
Only generate the graph if the current graph is out of date or not existent. Note, that all the calculations will happen regardless so that the output of -PRINT and graphv will be complete regardless. Note that the behaviour of +PRINT and graphv will be complete regardless. Note that the behavior of lazy in this regard has seen several changes over time. The only thing you -can realy rely on before rrdtool 1.3.7 is that lazy will not generate the +can really rely on before RRDtool 1.3.7 is that lazy will not generate the graph when it is already there and up to date, and also that it will output the size of the graph.
+[--daemon address]
+Address of the the rrdcached manpage daemon. If specified, a flush command is sent
+to the server before reading the RRD files. This allows the graph to contain
+fresh data even if the daemon is configured to cache values for a long time.
+For a list of accepted formats, see the -l option in the the rrdcached manpage manual.
+ rrdtool graph [...] --daemon unix:/var/run/rrdcached.sock [...]
[-f|--imginfo printfstr]
After the image has been created, the graph function uses printf together with this format string to create output similar to the PRINT @@ -310,6 +330,16 @@ and blue. Optionally you may add another hexadecimal number specifying the transparency (FF is solid). You may set this option several times to alter multiple defaults.
A green arrow is made by: --color ARROW#00FF00
[--grid-dash on:off]
+by default the grid is drawn in a 1 on, 1 off pattern. With this option you can set this yourself
++ --grid-dash 1:3 for a dot grid + + --grid-dash 1:0 for uninterrupted grid lines+
[--border width]]
+Width in pixels for the 3d border drawn around the image. Default 2, 0
+disables the border. See SHADEA and SHADEB above for setting the border
+color.
[--zoom factor]
Zoom the graphics by the given amount. The factor must be > 0
[-n|--font FONTTAG:size:[font]]
@@ -319,6 +349,9 @@ for the title,AXIS for the axis labels, UNIT for the
label, LEGEND for the graph legend, WATERMARK for the watermark on the
edge of the graph.
Use Times for the title: --font TITLE:13:Times
Note that you need to quote the argument to --font if the font-name +contains whitespace: +--font "TITLE:13:Some Font"
If you do not give a font string you can modify just the size of the default font:
--font TITLE:13:.
If you specify the size 0 then you can modify just the font without touching
@@ -328,25 +361,25 @@ resetting the default fontsizes: --font DEFAULT:0:Courier.
RRD_DEFAULT_FONT if you want to change this.
RRDtool uses Pango for its font handling. This means you can to use the full Pango syntax when selecting your font:
-The font name has the form ``[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]'', +
The font name has the form "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]", where FAMILY-LIST is a comma separated list of families optionally terminated by a comma, STYLE_OPTIONS is a whitespace separated list of words where each WORD describes one of style, variant, weight, stretch, or gravity, and SIZE is a decimal number (size in points) or optionally -followed by the unit modifier ``px'' for absolute size. Any one of the options +followed by the unit modifier "px" for absolute size. Any one of the options may be absent.
[-R|--font-render-mode {normal,light,mono}]
There are 3 font render modes:
-normal: Full Hinting and Antialiasing (default)
-light: Slight Hinting and Antialiasing
-mono: Full Hinting and NO Antialiasing
+normal: Full Hinting and Anti-aliasing (default)
+light: Slight Hinting and Anti-aliasing
+mono: Full Hinting and NO Anti-aliasing
[-B|--font-smoothing-threshold size]
(this gets ignored in 1.3 for now!)
This specifies the largest font size which will be rendered bitmapped, that is, without any font smoothing. By default, no text is rendered bitmapped.
[-P|--pango-markup]
-All text in rrdtool is rendered using Pango. With the --pango-markup option, all +
All text in RRDtool is rendered using Pango. With the --pango-markup option, all text will be processed by pango markup. This allows to embed some simple html like markup tags using
@@ -365,8 +398,8 @@ like markup tags usingMore details on http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html.
[-G|--graph-render-mode {normal,mono}]
There are 2 render modes:
-normal: Graphs are fully Antialiased (default)
-mono: No Antialiasing
+normal: Graphs are fully Anti-aliased (default)
+mono: No Anti-aliasing
[-E|--slope-mode]
RRDtool graphs are composed of stair case curves by default. This is in line with the way RRDtool calculates its data. Some people favor a more 'organic' look @@ -380,12 +413,6 @@ Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
[-i|--interlaced]
(this gets ignored in 1.3 for now!)
If images are interlaced they become visible on browsers more quickly.
-[-g|--no-legend]
-Suppress generation of the legend; only render the graph.
-[-F|--force-rules-legend]
-Force the generation of HRULE and VRULE legends even if those HRULE or -VRULE will not be drawn because out of graph boundaries (mimics -behaviour of pre 1.0.42 versions).
[-T|--tabwidth value]
By default the tab-width is 40 pixels, use this option to change it.
[-b|--base value]
@@ -411,8 +438,8 @@ See the rrdgraph_graph manpage for the exa
graphv
-Calling rrdtool with the graphv option will return information in the -rrdtool info format. On the command line this means that all output will be +
Calling RRDtool with the graphv option will return information in the +RRDtool info format. On the command line this means that all output will be in key=value format. When used from the Perl and Ruby bindings a hash pointer will be returned from the call.
When the filename '-' is given, the contents of the graph itself will also @@ -439,6 +466,21 @@ know what is where on the graph.
+ENVIRONMENT VARIABLES
+The following environment variables may be used to change the behavior of +
+rrdtoolgraph:
If this environment variable is set it will have the same effect as specifying
+the --daemon option on the command line. If both are present, the command
+line argument takes precedence.
+
+the rrdgraph manpage gives an overview of how rrdtool graph works. the rrdgraph_data manpage describes DEF,CDEF and VDEF in detail.