RRDCGI(1) rrdtool RRDCGI(1) NNAAMMEE rrdcgi - Create web pages containing RRD graphs based on templates SSYYNNOOPPSSIISS "#!/path/to/"rrrrddccggii [----ffiilltteerr] DDEESSCCRRIIPPTTIIOONN rrrrddccggii is a sort of very limited script interpreter. Its purpose is to run as a cgi-program and parse a web page template containing special might give you the name of the remote user given you are using some sort of access control on the directory. RRD::GOODFOR _s_e_c_o_n_d_s Specify the number of seconds this page should remain valid. This will prompt the rrdcgi to output a Last-Modified, an Expire and if the number of seconds is _n_e_g_a_t_i_v_e a Refresh header. RRD::INCLUDE _f_i_l_e_n_a_m_e Include the contents of the specified file into the page returned from the cgi. RRD::SETENV _v_a_r_i_a_b_l_e _v_a_l_u_e If you want to present your graphs in another time zone than your own, you could use to make sure everything is presented in Universal Time. Note that the values permitted to TZ depend on your OS. RRD::SETVAR _v_a_r_i_a_b_l_e _v_a_l_u_e Analog to SETENV but for local variables. RRD::GETVAR _v_a_r_i_a_b_l_e Analog to GETENV but for local variables. RRD::TIME::LAST _r_r_d_-_f_i_l_e _s_t_r_f_t_i_m_e_-_f_o_r_m_a_t This gets replaced by the last modification time of the selected RRD. The time is _s_t_r_f_t_i_m_e-formatted with the string specified in the second argument. RRD::TIME::NOW _s_t_r_f_t_i_m_e_-_f_o_r_m_a_t This gets replaced by the current time of day. The time is _s_t_r_f_t_i_m_e-formatted with the string specified in the argument. Note that if you return : (colons) from your strftime format you may have to escape them using \ if the time is to be used as an argument to a GRAPH command. RRD::TIME::STRFTIME _S_T_A_R_T_|_E_N_D _s_t_a_r_t_-_s_p_e_c _e_n_d_-_s_p_e_c _s_t_r_f_t_i_m_e_-_f_o_r_m_a_t This gets replaced by a strftime-formatted time using the for- mat _s_t_r_f_t_i_m_e_-_f_o_r_m_a_t on either _s_t_a_r_t_-_s_p_e_c or _e_n_d_-_s_p_e_c depending on whether _S_T_A_R_T or _E_N_D is specified. Both _s_t_a_r_t_-_s_p_e_c and _e_n_d_- _s_p_e_c must be supplied as either could be relative to the other. This is intended to allow pretty titles on graphs with times that are easier for non RRDtool folks to figure out than "-2weeks". Note that again, if you return : (colon) from your strftime format, you may have to escape them using \ if the time is to be used as an argument to a GRAPH command. RRD::GRAPH _r_r_d_g_r_a_p_h _a_r_g_u_m_e_n_t_s This tag creates the RRD graph defined by its argument and then is replaced by an appropriate tag referring to the graph. The ----llaazzyy option in RRD graph can be used to make sure that graphs are only regenerated when they are out of date. The arguments to the RRRRDD::::GGRRAAPPHH tag work as described in the rrrrdd-- ggrraapphh manual page. Use the ----llaazzyy option in your RRD::GRAPH tags, to reduce the load on your server. This option makes sure that graphs are only regenerated when the old ones are out of date. If you do not specify your own ----iimmggiinnffoo format, the following will be used: Note that %s stands for the filename part of the graph gener- ated, all directories given in the PNG file argument will get dropped. RRD::PRINT _n_u_m_b_e_r If the preceding RRRRDD::::GGRRAAPPHH tag contained and PPRRIINNTT arguments, then you can access their output with this tag. The _n_u_m_b_e_r argument refers to the number of the PPRRIINNTT argument. This first PPRRIINNTT has _n_u_m_b_e_r 0. RRD::INTERNAL This tag gets replaced by an internal var. Currently these vars are known: VERSION, COMPILETIME. These vars represent the compiled-in values. EEXXAAMMPPLLEE 11 The example below creates a web pages with a single RRD graph. #!/usr/local/bin/rrdcgi RRDCGI Demo

RRDCGI Example Page

EEXXAAMMPPLLEE 22 This script is slightly more elaborate, it allows you to run it from a form which sets RRD_NAME. RRD_NAME is then used to select which RRD you want to use as source for your graph. #!/usr/local/bin/rrdcgi RRDCGI Demo

RRDCGI Example Page for

Selection

Room A, Room B.

Graph

.png --lazy --title "Temperatures for " DEF:cel=.rrd:exhaust:AVERAGE LINE2:cel#00a000:"D. Celsius">

EEXXAAMMPPLLEE 33 This example shows how to handle the case where the RRD, graphs and cgi-bins are separate directories #!/.../bin/rrdcgi RRDCGI Demo

RRDCGI test Page

' --lazy --start -1d --end now DEF:http_src=/.../rrds/test.rrd:http_src:AVERAGE AREA:http_src#00ff00:http_src > Note 1: Replace /.../ with the relevant directories Note 2: The SRC=/.../pngs should be paths from the view of the web- server/browser AAUUTTHHOORR Tobias Oetiker 1.3.99909060808 2008-12-22 RRDCGI(1)