Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
Linux Magazine

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Glossary
MoreInfo
Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
FAQ
Copyright Info
Terms of Use
Privacy Info
Disclaimer
WorkBoard
Thanks
Donations
Advertising
Masthead / Impressum
Your Account

Communication
Feedback
Forums
Private Messages
Surveys

Features
HOWTOs
News Archive
Submit News
Topics
User Articles
Web Links

Google
Google


The Web
linux-tutorial.info

Who's Online
There are currently, 188 guest(s) and 0 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here

  

rrdgraph




SYNOPSIS

       rrdtool graph filename [-s|--start seconds] [-e|--end sec­
       onds] [-x|--x-grid x-axis grid and label]
       [-y|--y-grid y-axis grid and label] [-Y|--alt-y-grid]
       [-R|--alt-y-mrtg] [-A|--alt-autoscale]
       [-M|--alt-autoscale-max] [-N|--no-minor] [-X|--units-expo­
       nent] value]> [-v|--vertical-label text] [-w|--width pix­
       els] [-h|--height pixels] [-i|--interlaced]
       [-f|--imginfo formatstring] [-a|--imgformat GIF|PNG|GD]
       [-B|--background value] [-O|--overlay value]
       [-U|--unit value] [-z|--lazy] [-o|--logarithmic]
       [-u|--upper-limit value] [-l|--lower-limit value]
       [-g|--no-legend] [-r|--rigid] [-S|--step value]
       [-b|--base value] [-c|--color COLORTAG#rrggbb]
       [-t|--title title] [DEF:vname=rrd:ds-name:CF]
       [CDEF:vname=rpn-expression] [PRINT:vname:CF:format]
       [GPRINT:vname:CF:format] [COMMENT:text]
       [HRULE:value#rrggbb[:legend]] [VRULE:time#rrggbb[:legend]]
       [LINE{1|2|3}:vname[#rrggbb[:legend]]]
       [AREA:vname[#rrggbb[:legend]]] [STACK:vname[#rrggbb[:leg­
       end]]]


DESCRIPTION

       The graph functions main purpose is to create graphical
       representations of the data stored in one or several RRDs.
       Apart from generating graphs, it can also extract numeri­
       cal reports.

       filename
           The name of the graph to generate. Since rrdtool out­
           puts GIFs and PNGs, it's recommended that the filename
           end in either .gif or .png.  rrdtool does not enforce
           this, however.  If the  filename is set to '-' the
           image file will be written to standard out.  All other
           output will get suppressed.

           PNG output is recommended, since it takes up to 40%
           less disk space and 20-30% less time to generate than
           a GIF file.

           If no graph functions are called, the graph will not
           be created.

       -s|--start seconds (default end-1day)
           The time when the graph should begin. Time in seconds
           since epoch (1970-01-01) is required. Negative numbers
           are relative to the current time. By default one day
           worth of data will be graphed.  See also AT-STYLE TIME
           SPECIFICATION section in the rrdfetch documentation
           for a detailed explanation on how to specify time.

           The x-axis label and grid can be configured, using the
           following format:

           GTM:GST:MTM:MST:LTM:LST:LPR:LFM

           You have to configure three elements making up the
           x-axis labels and grid. The base grid (G??), the major
           grid (M??) and the labels (L??). The configuration is
           based on the idea that you first specify a well known
           amount of time (?TM) and then say how many times it
           has to pass between each grid line or label (?ST). For
           the label you have to define two additional items: The
           precision of the label in seconds (LPR) and the strf­
           time format used to generate the text of the label
           (LFM).

           The ?TM elements must be one of the following key­
           words: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH or YEAR.

           If you wanted a graph with a base grid every 10 min­
           utes and a major one every hour, with labels every
           hour you would use the following x-axis definition.

           "MINUTE:10:HOUR:1:HOUR:1:0:%X"

           The precision in this example is 0 because the %X for­
           mat is exact. If the label was the name of the day, we
           would have had a precision of 24 hours, because when
           you say something like 'Monday' you mean the whole day
           and not Monday morning 00:00. Thus the label should be
           positioned at noon. By defining a precision of 24
           hours or rather 86400 seconds, you make sure that this
           happens.

           If you want to alter the genertated text to another
           language, use the LC_TIME environment variable to set
           the locale you prefere prior to calling the graph
           function.

       -y|--y-grid grid step:label factor (default autoconfigure)
           Makes vertical grid lines appear at grid step inter­
           val. Every label factor gridstep, a major grid line is
           printed, along with label showing the value of the
           grid line.

           If you want no y-grid at all set specify the magic
           word none.

       -Y|--alt-y-grid
           Place Y grid dynamically based on graph Y range. Algo­
           rithm ensures that you always have grid, that there
           are enough but not too many grid lines and the grid is
           Compute Y range  based on function absolute minimum
           and maximum values. Default algorithm uses predefined
           set of ranges.  This is good in many cases but it
           fails miserably when you need to graph something like
           260 + 0.001 * sin(x). Default algorithm will use Y
           range from 250 to 300 and on the graph you will see
           almost straight line. With --alt-autoscale Y range
           will be from slightly less the 260 - 0.001 to slightly
           more then 260 + 0.001 and periodic behavior will be
           seen.   (contributed by Sasha Mikheev)

       -M|--alt-autoscale-max
           Where --alt-autoscale will modify both the absolute
           maximum AND minimum values, this option will only
           affect the maximum value. The minimum 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.

       -X|--units-exponent value (default autoconfigure)
           This sets the 10**exponent scaling of the y-axis val­
           ues.  Normally values will be scaled to the appropri­
           ate units (k, M, etc.).  However you may wish to dis­
           play units always in k (Kilo, 10e3) even if the data
           is in the M (Mega, 10e6) range for instance.  Value
           should be an integer which is a multiple of 3 between
           -18 and 18 inclusive.  It is the exponent on the units
           you which to use.  For example, use 3 to display the
           y-axis values in k (Kilo, 10e3, thousands), use -6 to
           display the y-axis values in u (Micro, 10e-6, mil­
           lionths).  Use a value of 0 to prevent any scaling of
           the y-axis values.

       -v|--vertical-label text
           vertical label on the left side of the graph. This is
           normally used to specify the units used.

       -w|--width pixels (default 400 pixel)
           Width of the drawing area within the graph. This
           affects the size of the gif.

       -h|--height pixels (default 100 pixel)
           Width of the drawing area within the graph. This
           affects the size of the gif.

       -i|--interlaced (default: false)
           If you set this option, then the resulting GIF will be
           interlaced.  Most web browsers display these incremen­
           tally as they load. If you do not use this option, the
           GIFs default to being progressive scanned. The only
           effect of this option is to control the format of the

       -a|--imgformat GIF|PNG|GD (default: GIF)
           Allows you to produce PNG or GD output from rrdtool.

       -B|--background value
           You could use image in (currently only) GD format for
           background. It is used as background at the very
           beginning of graph creation.

       -O|--overlay value
           You could use image in (currently only) GD format as
           overlay. It is placed over created graph so that white
           pixel (color 255,255,255) is considered transparent,
           all other is replacing corresponding pixel in created
           graph.

       -U|--unit value
           You could use unit to be displayed on y axis. It is
           wise to use only short units on graph, however.

       -z|--lazy (default: false)
           Only generate the graph, if the current gif is out of
           date or not existent.

       -u|--upper-limit value (default autoconfigure)
           Defines the value normally located at the upper border
           of the graph. If the graph contains higher values, the
           upper border will move upwards to accomodate these
           values as well.

           If you want to define an upper-limit which will not
           move in any event you have to set the --rigid option
           as well.

       -l|--lower-limit value (default autoconfigure)
           This is not the lower limit of a graph.  But rather,
           this is the maximum lower bound of a graph.  For exam­
           ple, the value -100 will result in a graph that has a
           lower limit of -100 or less.  Use this keyword to
           expand graphs down.

       -r|--rigid
           rigid boundaries mode.  Normally rrdgraph will auto­
           matically expand the lower and upper limit if the
           graph contains a value outside the valid range. With
           the r option you can disable this behavior

       -b|--base value
           if you are graphing memory (and NOT network traffic)
           this switch should be set to 1024 so that one Kb is
           1024 byte. For traffic measurement, 1 kb/s is 1000
           b/s.


       -t|--title text (default no title)
           Define a title to be written into the graph

       -S|--step value (default automatic)
           By default rrdgraph calculates the width of one pixel
           in the time domain and tries to get data at that reso­
           lution from the RRD. With this switch you can override
           this behaviour. If you want rrdgraph to get data at 1
           hour resolution from the RRD, then you can set the
           step to 3600 seconds. Note, that a step smaller than 1
           pixel will be silently ignored.

       DEF:vname=rrd:ds-name:CF
           Define virtual name for a data source. This name can
           then be used in the functions explained below. The DEF
           call automatically chooses an RRA which contains CF
           consolidated data in a resolution appropriate for the
           size of the graph to be drawn.  Ideally this means
           that one data point from the RRA should be represented
           by one pixel in the graph.  If the resolution of the
           RRA is higher than the resolution of the graph, the
           data in the RRA will be further consolidated according
           to the consolidation function (CF) chosen.

       CDEF:vname=rpn-expression
           Create a new virtual data source by evaluating a math­
           ematical expression, specified in Reverse Polish Nota­
           tion (RPN). If you have ever used a traditional HP
           calculator you already know RPN. The idea behind RPN
           notation is, that you have a stack and push your data
           onto this stack. When ever you execute an operation,
           it takes as many data values from the stack as needed.
           The pushing of data is implicit, so when ever you
           specify a number or a variable, it gets pushed auto­
           matically.

           If this is all a big load of incomprehensible words
           for you, maybe an example helps (a more complete
           explanation is given in [1]): The expression vname+3/2
           becomes "vname,3,2,/,+" in RPN. First the three values
           get pushed onto the stack (which now contains (the
           current value of) vname, a 3 and a 2).  Then the /
           operator pops two values from the stack (3 and 2),
           divides the first argument by the second (3/2) and
           pushes the result (1.5) back onto the stack. Then the
           + operator pops two values (vname and 1.5) from the
           stack; both values are added up and the result gets
           pushes back onto the stack. In the end there is only
           one value left on the stack: The result of the expres­
           sion.


           LT, LE, GT, GE, EQ
               pops two values from the stack, compares them
               according to the selected condition and pushes
               either 1 back onto the stack if the condition is
               true and 0 if the condition was not true.

           IF  pops three values from the stack. If the last
               value is not 0, the second value will be pushed
               back onto the stack, otherwise the first value is
               pushed back.

               If the stack contains the values A, B, C, D, E are
               presently on the stack, the IF operator will pop
               the values E D and C of the stack. It will look at
               C and if it is not 0 it will push D back onto the
               stack, otherwise E will be sent back to the stack.

           MIN, MAX
               selects the lesser or larger of the two top stack
               values respectively

           LIMIT
               replaces the value with *UNKNOWN* if it is outside
               the limits specified by the two values above it on
               the stack.

                CDEF:a=alpha,0,100,LIMIT

           DUP, EXC, POP
               These manipulate the stack directly.  DUP will
               duplicate the top of the stack, pushing the result
               back onto the stack.  EXC will exchange the top
               two elements of the stack, and POP will pop off
               the top element of the stack.  Having insufficient
               elements on the stack for these operations is an
               error.

           UN  Pops one value off the stack, if it is *UNKNOWN*,
               1 will be pushed back otherwise 0.

           UNKN
               Push an *UNKNOWN* value onto the stack.

           PREV
               Push *UNKNOWN* if its at the first value of a data
               set or otherwise the value of this CDEF at the
               previous time step. This allows you to perform
               calculations across the data.

           PREV(vname)
               Push *UNKNOWN* if its at the first value of the

           TIME
               Push the time the current sample was taken onto
               the stack. This is the number of non-skip seconds
               since 0:00:00 January 1, 1970.

           LTIME
               This is like TIME + current timezone offset in
               seconds. The current offset takes daylight saving
               time into account, given your OS supports this. If
               you were looking at a sample, in Zurich, in sum­
               mer, the offset would be 2*3600 seconds, as Zurich
               at that time of year is 2 hours ahead of UTC.

               Note that the timezone offset is always calculated
               for the time the current sample was taken at. It
               has nuthing todo with the time you are doing the
               calculation.

           Please note that you may only use vname variables that
           you previously defined by either DEF or CDEF. Further­
           more, as of this writing (version 0.99.25), you must
           use at least one vname per expression, that is
           "CDEF:fourtytwo=2,40,+" will yield an error message
           but not a vname fourtytwo that's always equal to 42.

       PRINT:vname:CF:format
           Calculate the chosen consolidation function CF over
           the data-source variable vname and "printf" the result
           to stdout using format.  In the format string there
           should be a '%lf', '%lg' or '%le' marker in the place
           where the number should be printed.

           If an additional '%s' is found AFTER the marker, the
           value will be scaled and an appropriate SI magnitude
           unit will be printed in place of the '%s' marker. The
           scaling will take the '--base' argument into consider­
           ation!

           If a '%S' is used instead of a '%s', then instead of
           calculating the appropriate SI magnitude unit for this
           value, the previously calculated SI magnitude unit
           will be used.  This is useful if you want all the val­
           ues in a PRINT statement to have the same SI magnitude
           unit.  If there was no previous SI magnitude calcula­
           tion made, then '%S' behaves like a '%s', unless the
           value is 0, in which case it does not remember a SI
           magnitude unit and a SI magnitude unit will only be
           calculated when the next '%s' is seen or the next '%S'
           for a non-zero value.

           If you want to put a '%' into your PRINT string, use
           '%%' instead.

       COMMENT:text
           Like GPRINT but the text is simply printed into the
           graph.

       HRULE:value#rrggbb[:legend]
           Draw a horizontal rule into the graph and optionally
           add a legend

       VRULE:time#rrggbb[:legend]
           Draw a vertical rule into the graph and optionally add
           a legend

       LINE{1|2|3}:vname[#rrggbb[:legend]]
           Plot for the requested data, using the color speci­
           fied. Write a legend into the graph. The 3 possible
           keywords LINE1, LINE2, and LINE3 generate increasingly
           wide lines. If no color is defined, the drawing is
           done 'blind' this is useful in connection with the
           STACK function when you want to ADD the values of two
           data-sources without showing it in the graph.

       AREA:vname[#rrggbb[:legend]]
           Does the same as LINE?, but the area between 0 and the
           graph will be filled with the color specified.

       STACK:vname[#rrggbb[:legend]]
           Does the same as LINE?, but the graph gets stacked on
           top of the previous LINE?, AREA or STACK graph.
           Depending on the type of the previous graph, the STACK
           will be either a LINE? or an AREA.  This obviously
           implies that the first STACK must be preceded by an
           AREA or LINE? -- you need something to stack something
           onto in the first place ;)

           Note, that when you STACK onto *UNKNOWN* data, rrdtool
           will not draw any graphics ... *UNKNOWN* is not zero
           ... if you want it to zero then you might want to use
           a CDEF argument with IF and UN functions to turn
           *UNKNOWN* into zero ...


NOTES on legend arguments

       Escaping the colon

       In a ':' in a legend argument will mark the end of the
       legend. To enter a ':' into a legend, the colon must be
       escaped with a backslash '\:'.  Beware, that many environ­
       ments look for backslashes themselves, so it may be neces­
       sary to write two backslashes so that one is passed onto
       rrd_graph.

       String Formatting

       of the string. The \g also squshes any space inside the
       string if it is at the very end of the string. This can be
       used in connection with %s to supress empty unit strings.

        GPRINT:a:MAX:%lf%s\g

       A special case is COMMENT:\s this inserts some additional
       vertical space before placing the next row of legends.

       When text has to be formated without special instructions
       from your side, rrdtool will automatically justify the
       text as soon as one string goes over the right edge. If
       you want to prevent the justification without forcing a
       newline, you can use the special tag \J at the end of the
       string to disable the auto justification.


NOTE on Return Values

       Whenever rrd_graph gets called, it prints a line telling
       the size of the gif it has just created to STDOUT. This
       line looks like this: XSIZExYSIZE.


EXAMPLE 1

         rrdtool graph demo.gif --title="Demo Graph" \
                 DEF:cel=demo.rrd:exhaust:AVERAGE \
                 "CDEF:far=cel,1.8,*,32,+"" \
                 LINE2:cel#00a000:"D. Celsius" \
                 LINE2:far#ff0000:"D. Fahrenheit\c"


EXAMPLE 2

       This example demonstrates the syntax for using IF and UN
       to set *UNKNOWN* values to 0.  This technique is useful if
       you are aggregating interface data where the start dates
       of the data sets doesn't match.

         rrdtool graph demo.gif --title="Demo Graph" \
                DEF:idat1=interface1.rrd:ds0:AVERAGE \
                DEF:idat2=interface2.rrd:ds0:AVERAGE \
                DEF:odat1=interface1.rrd:ds1:AVERAGE \
                DEF:odat2=interface2.rrd:ds1:AVERAGE \
                CDEF:agginput=idat1,UN,0,idat1,IF,idat2,UN,0,idat2,IF,+,8,* \
                CDEF:aggoutput=odat1,UN,0,odat1,IF,odat2,UN,0,odat2,IF,+,8,* \
                AREA:agginput#00cc00:Input Aggregate \
                LINE1:aggoutput#0000FF:Output Aggregate

       Assuming that idat1 has a data value of *UNKNOWN*, the
       CDEF expression

        idat1,UN,0,idat1,IF

       leaves us with a stack with contents of 1,0,NaN and the IF
       function will pop off the 3 values and replace them with
       0.  If idat1 had a real value like 7942099, then the stack
                DEF:val4=other.rrd:ds0:AVERAGE \
                CDEF:background=val4,POP,TIME,7200,%,3600,LE,INF,UNKN,IF \
                CDEF:wipeout=val1,val2,val3,val4,+,+,+,UN,INF,UNKN,IF \
                AREA:background#F0F0F0 \
                AREA:val1#0000FF:Value1 \
                STACK:val2#00C000:Value2 \
                STACK:val3#FFFF00:Value3 \
                STACK:val4#FFC000:Value4 \
                AREA:wipeout#FF0000:Unknown

       The first CDEF uses val4 as a dummy value. It's value is
       removed immediately from the stack. Then a decision is
       made based on the time that a sample was taken. If it is
       an even hour (UTC time !) then the area will be filled. If
       it is not, the value is set to UNKN and is not plotted.

       The second CDEF looks if any of val1,val2,val3,val4 is
       unknown. It does so by checking the outcome of
       sum(val1,val2,val3,val4). Again, INF is returned when the
       condition is true, UNKN is used to not plot the data.

       The different items are plotted in a particular order.
       First do the background, then use a normal area to overlay
       it with data. Stack the other data until they are all
       plotted. Last but not least, overlay everything with eye-
       hurting red to signal any unknown data.

       Note that this example assumes that your data is in the
       positive half of the y-axis otherwhise you would would
       have to add NEGINF in order to extend the coverage of the
       rea to whole graph.


AUTHOR

       Tobias Oetiker <oetiker@ee.ethz.ch>


REFERENCES

       [1] http://www.dotpoint.com/xnumber/rpn_or_adl.htm

1.0.45                      2003-02-19                RRDGRAPH(1)
  

The Linux Tutorial is always looking for new contributors.


Login
Nickname

Password

Security Code
Security Code
Type Security Code


Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!


Amazon Wish List

Did You Know?
You can get all the latest Site and Linux news by checking out our news page.


Friends



Tell a Friend About Us

Bookmark and Share



Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.10 Seconds