X-Git-Url: https://git.tokkee.org/?p=pkg-rrdtool.git;a=blobdiff_plain;f=doc%2Frrdgraph.txt;h=51a0b5ffa3379e6184d7091399039f8e4d4d0b07;hp=d1a493afee18104d552f14f657cfa8ec4fd8df53;hb=412b079ae92adc47a82bfc6a27de37a537420a26;hpb=5ae9312d35bd9931a761a15cbf1e8effe2e7b5d4 diff --git a/doc/rrdgraph.txt b/doc/rrdgraph.txt index d1a493a..51a0b5f 100644 --- a/doc/rrdgraph.txt +++ b/doc/rrdgraph.txt @@ -6,9 +6,9 @@ NNAAMMEE rrdgraph - Round Robin Database tool grapher functions SSYYNNOOPPSSIISS - rrrrddttooooll ggrraapphh _f_i_l_e_n_a_m_e [_o_p_t_i_o_n ...] [_d_a_t_a _d_e_f_i_n_i_t_i_o_n ...] [_d_a_t_a _c_a_l_- - _c_u_l_a_t_i_o_n ...] [_v_a_r_i_a_b_l_e _d_e_f_i_n_i_t_i_o_n ...] [_g_r_a_p_h _e_l_e_m_e_n_t ...] [_p_r_i_n_t - _e_l_e_m_e_n_t ...] + rrrrddttooooll ggrraapphh||ggrraapphhvv _f_i_l_e_n_a_m_e [_o_p_t_i_o_n ...] [_d_a_t_a _d_e_f_i_n_i_t_i_o_n ...] + [_d_a_t_a _c_a_l_c_u_l_a_t_i_o_n ...] [_v_a_r_i_a_b_l_e _d_e_f_i_n_i_t_i_o_n ...] [_g_r_a_p_h _e_l_e_m_e_n_t ...] + [_p_r_i_n_t _e_l_e_m_e_n_t ...] DDEESSCCRRIIPPTTIIOONN The ggrraapphh function of RRRRDDttooooll is used to present the data from an RRRRDD @@ -35,12 +35,19 @@ OOVVEERRVVIIEEWW it. For instance, you might be collecting bbyytteess per second, but want to display bbiittss per second. This is what the ddaattaa ccaallccuullaattiioonn command is designed for. After ccoonnssoolliiddaattiinngg the data, a copy is made and this - copy is modified using a rather powerful rrdgraph_rpn command set. + copy is modified using a rather powerful RRPPNN command set. When you are done fetching and processing the data, it is time to graph it (or print it). This ends the rrrrddttooooll ggrraapphh sequence. OOPPTTIIOONNSS + ggrraapphhvv + This alternate version of ggrraapphh takes the same arguments and per- + forms the same function. The _v stands for _v_e_r_b_o_s_e, which describes + the output returned. ggrraapphhvv 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. + filename The name and path of the graph to generate. It is recommended to end this in ".png", ".svg" or ".eps", but RRRRDDttooooll does not enforce @@ -55,13 +62,13 @@ OOPPTTIIOONNSS The start and end of the time series you would like to display, and which RRRRAA the data should come from. Defaults are: 1 day ago until now, with the best possible resolution. SSttaarrtt and eenndd can be speci- - fied in several formats, see rrdfetch and rrdgraph_examples. By - default, rrrrddttooooll ggrraapphh calculates the width of one pixel in the - time domain and tries to get data from an RRRRAA with that resolution. - With the sstteepp option you can alter this behaviour. If you want - rrrrddttooooll ggrraapphh to get data at a one-hour resolution from the RRRRDD, - set sstteepp to 3'600. Note: a step smaller than one pixel will - silently be ignored. + fied in several formats, see AT-STYLE TIME SPECIFICATION and rrd- + graph_examples. By default, rrrrddttooooll ggrraapphh calculates the width of + one pixel in the time domain and tries to get data from an RRRRAA with + that resolution. With the sstteepp option you can alter this + behaviour. If you want rrrrddttooooll ggrraapphh to get data at a one-hour + resolution from the RRRRDD, set sstteepp to 3'600. Note: a step smaller + than one pixel will silently be ignored. Labels [--tt|----ttiittllee _s_t_r_i_n_g] [--vv|----vveerrttiiccaall--llaabbeell _s_t_r_i_n_g] @@ -71,10 +78,15 @@ OOPPTTIIOONNSS Size [--ww|----wwiiddtthh _p_i_x_e_l_s] [--hh|----hheeiigghhtt _p_i_x_e_l_s] [--jj|----oonnllyy--ggrraapphh] + [--DD|----ffuullll--ssiizzee--mmooddee] - The width and height of the ccaannvvaass (the part of the graph with the + By default, the width and height of the ccaannvvaass (the part with the actual data and such). This defaults to 400 pixels by 100 pixels. + If you specify the ----ffuullll--ssiizzee--mmooddee option, the width and height + specify the final dimensions of the output image and the canvas is + automatically resized to fit. + If you specify the ----oonnllyy--ggrraapphh option and set the height < 32 pix- els you will get a tiny graph image (thumbnail) to use as an icon for use in an overview, for example. All labeling will be stripped @@ -121,107 +133,110 @@ OOPPTTIIOONNSS [--NN|----nnoo--ggrriiddffiitt] - In order to avoid anti-aliasing effects gridlines are placed on - integer pixel values. This is by default done by extending the - scale so that gridlines happens to be spaced using an integer num- - ber of pixels and also start on an integer pixel value. This might - extend the scale too much for some logarithmic scales and for lin- - ear scales where ----aalltt--aauuttoossccaallee is needed. Using ----nnoo--ggrriiddffiitt - disables modification of the scale. - - X-Grid - [--xx|----xx--ggrriidd _G_T_M::_G_S_T::_M_T_M::_M_S_T::_L_T_M::_L_S_T::_L_P_R::_L_F_M] - - [--xx|----xx--ggrriidd nnoonnee] - - 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 autoconfigu- - ration to get this right. You can specify the string "none" to sup- - press the grid and labels altogether. - - The grid is defined by specifying a certain amount of time in the - _?_T_M positions. You can choose from "SECOND", "MINUTE", "HOUR", - "DAY", "WEEK", "MONTH" or "YEAR". Then you define how many of these - should pass between each line or label. This pair (_?_T_M_:_?_S_T) needs - to be specified for the base grid (_G_?_?), the major grid (_M_?_?) and - the labels (_L_?_?). For the labels you also must define a precision - in _L_P_R and a _s_t_r_f_t_i_m_e format string in _L_F_M. _L_P_R defines where each - label will be placed. If it is zero, the label will be placed right - under the corresponding line (useful for hours, dates etcetera). - If you specify a number of seconds here the label is centered on - this interval (useful for Monday, January etcetera). - - --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X - - This places grid lines every 10 minutes, major grid lines every - hour, and labels every 4 hours. The labels are placed under the - major grid lines as they specify exactly that time. - - --x-grid HOUR:8:DAY:1:DAY:1:0:%A - - 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-Grid - [--yy|----yy--ggrriidd _g_r_i_d _s_t_e_p::_l_a_b_e_l _f_a_c_t_o_r] - - [--yy|----yy--ggrriidd nnoonnee] - - Y-axis grid lines appear at each _g_r_i_d _s_t_e_p interval. Labels are - placed every _l_a_b_e_l _f_a_c_t_o_r lines. You can specify "-y none" to sup- - press the grid and labels altogether. The default for this option - is to automatically select sensible values. - - If you have set --y-grid to 'none' not only the labels get - supressed, also the space reserved for the labels is removed. You - can still add space manually if you use the --units-length command - to explicitly reserve space. - - [--YY|----aalltt--yy--ggrriidd] - - Place the Y grid dynamically based on the graph's Y range. The - algorithm ensures that you always have a grid, that there are - enough but not too many grid lines, and that the grid is metric. - That is the grid lines are placed every 1, 2, 5 or 10 units. This - parameter will also ensure that you get enough decimals displayed - even if your graph goes from 69.998 to 70.001. (contributed by - Sasha Mikheev). + In order to avoid anti-aliasing blurring effects rrdtool snaps + points to device resolution pixels, this results in a crisper aper- + ance. 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. + + Grid + X-Axis + [--xx|----xx--ggrriidd _G_T_M::_G_S_T::_M_T_M::_M_S_T::_L_T_M::_L_S_T::_L_P_R::_L_F_M] + + [--xx|----xx--ggrriidd nnoonnee] + + 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 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 _?_T_M positions. You can choose from "SECOND", "MINUTE", + "HOUR", "DAY", "WEEK", "MONTH" or "YEAR". Then you define how + many of these should pass between each line or label. This + pair (_?_T_M_:_?_S_T) needs to be specified for the base grid (_G_?_?), + the major grid (_M_?_?) and the labels (_L_?_?). For the labels you + also must define a precision in _L_P_R and a _s_t_r_f_t_i_m_e format + string in _L_F_M. _L_P_R defines where each label will be placed. If + it is zero, the label will be placed right under the corre- + sponding line (useful for hours, dates etcetera). If you spec- + ify a number of seconds here the label is centered on this + interval (useful for Monday, January etcetera). + + --x-grid MINUTE:10:HOUR:1:HOUR:4:0:%X + + This places grid lines every 10 minutes, major grid lines every + hour, and labels every 4 hours. The labels are placed under the + major grid lines as they specify exactly that time. + + --x-grid HOUR:8:DAY:1:DAY:1:86400:%A + + 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-Axis + [--yy|----yy--ggrriidd _g_r_i_d _s_t_e_p::_l_a_b_e_l _f_a_c_t_o_r] + + [--yy|----yy--ggrriidd nnoonnee] + + Y-axis grid lines appear at each _g_r_i_d _s_t_e_p interval. Labels + are placed every _l_a_b_e_l _f_a_c_t_o_r lines. You can specify "-y none" + to suppress the grid and labels altogether. The default for + this option is to automatically select sensible values. - [--oo|----llooggaarriitthhmmiicc] + If you have set --y-grid to 'none' not only the labels get + supressed, also the space reserved for the labels is removed. + You can still add space manually if you use the --units-length + command to explicitly reserve space. - Logarithmic y-axis scaling. + [--YY|----aalltt--yy--ggrriidd] - [--XX|----uunniittss--eexxppoonneenntt _v_a_l_u_e] + Place the Y grid dynamically based on the graph's Y range. The + algorithm ensures that you always have a grid, that there are + enough but not too many grid lines, and that the grid is met- + ric. That is the grid lines are placed every 1, 2, 5 or 10 + units. This parameter will also ensure that you get enough dec- + imals displayed even if your graph goes from 69.998 to 70.001. + (contributed by Sasha Mikheev). - This sets the 10**exponent scaling of the y-axis values. Normally, - values will be scaled to the appropriate units (k, M, etc.). How- - ever, you may wish to display 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 - inclusively. It is the exponent on the units you wish to use. For - example, use 3 to display the y-axis values in k (Kilo, 10e3, thou- - sands), 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. + [--oo|----llooggaarriitthhmmiicc] - 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 successful in labeling the graph under the given - circumstances, it will switch to the more robust ----aalltt--yy--ggrriidd mode. + Logarithmic y-axis scaling. - [--LL|----uunniittss--lleennggtthh _v_a_l_u_e] + [--XX|----uunniittss--eexxppoonneenntt _v_a_l_u_e] - 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. + This sets the 10**exponent scaling of the y-axis values. Nor- + mally, values will be scaled to the appropriate units (k, M, + etc.). However, you may wish to display 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 inclusively. It is the exponent on the + units you wish 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, millionths). Use a value of + 0 to prevent any scaling of the y-axis values. - [----uunniittss==ssii] + 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 successful in labeling the graph under the given + circumstances, it will switch to the more robust ----aalltt--yy--ggrriidd + mode. - 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. + [--LL|----uunniittss--lleennggtthh _v_a_l_u_e] + + 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. + + [----uunniittss==ssii] + + 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. Miscellaneous [--zz|----llaazzyy] @@ -268,7 +283,7 @@ OOPPTTIIOONNSS elements, "TITLE" for the title, "AXIS" for the axis labels, "UNIT" for the vertical unit label, "LEGEND" for the graph legend. - Use Times for the title: "--font TITLE:13:/usr/lib/fonts/times.ttf" + Use Times for the title: "--font TITLE:13:Times" If you do not give a font string you can modify just the sice of the default font: "--font TITLE:13:". @@ -276,25 +291,48 @@ OOPPTTIIOONNSS If you specify the size 0 then you can modify just the font without touching the size. This is especially usefull for altering the default font without resetting the default fontsizes: "--font - DEFAULT:0:/usr/lib/fonts/times.ttf". + DEFAULT:0:Courier". RRDtool comes with a preset default font. You can set the environ- ment variable "RRD_DEFAULT_FONT" if you want to change this. - Truetype fonts are only supported for PNG output. See below. + 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 "[_F_A_M_I_L_Y_-_L_I_S_T] [_S_T_Y_L_E_-_O_P_T_I_O_N_S] [_S_I_Z_E]", + where _F_A_M_I_L_Y_-_L_I_S_T is a comma separated list of families optionally + terminated by a comma, _S_T_Y_L_E___O_P_T_I_O_N_S is a whitespace separated list + of words where each WORD describes one of style, variant, weight, + stretch, or gravity, and _S_I_Z_E is a decimal number (size in points) + or optionally followed by the unit modifier "px" for absolute size. + Any one of the options may be absent. + + [--RR|----ffoonntt--rreennddeerr--mmooddee {nnoorrmmaall,lliigghhtt,mmoonnoo}] + + There are 3 font render modes: + + nnoorrmmaall: Full Hinting and Antialiasing (default) - [--RR|----ffoonntt--rreennddeerr--mmooddee {_n_o_r_m_a_l,_l_i_g_h_t,_m_o_n_o}] + lliigghhtt: Slight Hinting and Antialiasing - This lets you customize the strength of the font smoothing, or dis- - able it entirely using _m_o_n_o. By default, _n_o_r_m_a_l font smoothing is - used. + mmoonnoo: Full Hinting and NO Antialiasing [--BB|----ffoonntt--ssmmooootthhiinngg--tthhrreesshhoolldd _s_i_z_e] + (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. + [--GG|----ggrraapphh--rreennddeerr--mmooddee {nnoorrmmaall,mmoonnoo}] + + There are 2 render modes: + + nnoorrmmaall: Graphs are fully Antialiased (default) + + mmoonnoo: No Antialiasing + [--EE|----ssllooppee--mmooddee] RRDtool graphs are composed of stair case curves by default. This @@ -313,6 +351,8 @@ OOPPTTIIOONNSS [--ii|----iinntteerrllaacceedd] + (this gets ignored in 1.3 for now!) + If images are interlaced they become visible on browsers more quickly. @@ -358,6 +398,56 @@ OOPPTTIIOONNSS least one print statement to generate a report. See rrdgraph_graph for the exact format. + Markup + All text in rrdtool is rendered using Pango markup. This means text + can contain embeded markup instructions. Simple html markup using + + text + + can be used. Apart from the verbose syntax, there are also the fol- + lowing short tags available. + + b Bold + big Makes font relatively larger, equivalent to + i Italic + s Strikethrough + sub Subscript + sup Superscript + small Makes font relatively smaller, equivalent to + tt Monospace font + u Underline + + More details on http://developer.gnome.org/doc/API/2.0/pango/Pango- + MarkupFormat.html. + + ggrraapphhvv + + 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 be returned through this interface (hash key 'image'). On the com- + mand line the output will look like this: + + print[0] = "0.020833" + print[1] = "0.0440833" + graph_left = 51 + graph_top = 22 + graph_width = 400 + graph_height = 100 + image_width = 481 + image_height = 154 + value_min = 0.0000000000e+00 + value_max = 4.0000000000e-02 + image = BLOB_SIZE:8196 + [... 8196 bytes of image data ...] + + There is more information returned than in the standard interface. + Especially the 'graph_*' keys are new. They help applications that want + to know what is where on the graph. + SSEEEE AALLSSOO rrdgraph gives an overview of how rrrrddttooooll ggrraapphh works. rrdgraph_data describes DDEEFF,CCDDEEFF and VVDDEEFF in detail. rrdgraph_rpn describes the RRPPNN @@ -373,4 +463,4 @@ AAUUTTHHOORR -1.2.27 2008-02-17 RRDGRAPH(1) +1.3rc4 2008-04-21 RRDGRAPH(1)