Code

67831b1a2c593ec5803c3b1ba23acfe4329f89fd
[pkg-rrdtool.git] / doc / rrdcgi.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <title>rrdcgi</title>
5 <link rev="made" href="mailto:root@localhost" />
6 </head>
8 <body style="background-color: white">
10 <p><a name="__index__"></a></p>
11 <!-- INDEX BEGIN -->
12 <!--
14 <ul>
16         <li><a href="#name">NAME</a></li>
17         <li><a href="#synopsis">SYNOPSIS</a></li>
18         <li><a href="#description">DESCRIPTION</a></li>
19         <ul>
21                 <li><a href="#keywords">Keywords</a></li>
22         </ul>
24         <li><a href="#example_1">EXAMPLE 1</a></li>
25         <li><a href="#example_2">EXAMPLE 2</a></li>
26         <li><a href="#example_3">EXAMPLE 3</a></li>
27         <li><a href="#author">AUTHOR</a></li>
28 </ul>
29 -->
30 <!-- INDEX END -->
32 <p>
33 </p>
34 <h1><a name="name">NAME</a></h1>
35 <p>rrdcgi - Create web pages containing RRD graphs based on templates</p>
36 <p>
37 </p>
38 <hr />
39 <h1><a name="synopsis">SYNOPSIS</a></h1>
40 <p><code>#!/path/to/</code><strong>rrdcgi</strong> [<strong>--filter</strong>]</p>
41 <p>
42 </p>
43 <hr />
44 <h1><a name="description">DESCRIPTION</a></h1>
45 <p><strong>rrdcgi</strong> is a sort of very limited script interpreter. Its purpose
46 is to run as a cgi-program and parse a web page template containing special
47 &lt;RRD:: tags. <strong>rrdcgi</strong> will interpret and act according to these tags.
48 In the end it will printout a web page including the necessary CGI headers.</p>
49 <p><strong>rrdcgi</strong> parses the contents of the template in 3 steps. In each step it looks
50 only for a subset of tags. This allows nesting of tags.</p>
51 <p>The argument parser uses the same semantics as you are used from your C-shell.</p>
52 <dl>
53 <dt><strong><a name="item__2d_2dfilter"><strong>--filter</strong></a></strong><br />
54 </dt>
55 <dd>
56 Assume that rrdcgi is run as a filter and not as a cgi.
57 </dd>
58 <p></p></dl>
59 <p>
60 </p>
61 <h2><a name="keywords">Keywords</a></h2>
62 <dl>
63 <dt><strong><a name="item_rrd_3a_3acv_name">RRD::CV <em>name</em></a></strong><br />
64 </dt>
65 <dd>
66 Inserts the CGI variable of the given name.
67 </dd>
68 <p></p>
69 <dt><strong><a name="item_rrd_3a_3acv_3a_3aquote_name">RRD::CV::QUOTE <em>name</em></a></strong><br />
70 </dt>
71 <dd>
72 Inserts the CGI variable of the given name but quotes it, ready for
73 use as an argument in another RRD:: tag. So even when there are spaces in the
74 value of the CGI variable it will still be considered to be one argument.
75 </dd>
76 <p></p>
77 <dt><strong><a name="item_rrd_3a_3acv_3a_3apath_name">RRD::CV::PATH <em>name</em></a></strong><br />
78 </dt>
79 <dd>
80 Inserts the CGI variable of the given name, quotes it and makes sure
81 it starts neither with a '/' nor contains '..'. This is to make
82 sure that no problematic pathnames can be introduced through the
83 CGI interface.
84 </dd>
85 <p></p>
86 <dt><strong><a name="item_rrd_3a_3agetenv_variable">RRD::GETENV <em>variable</em></a></strong><br />
87 </dt>
88 <dd>
89 Get the value of an environment variable.
90 </dd>
91 <dd>
92 <pre>
93  &lt;RRD::GETENV REMOTE_USER&gt;</pre>
94 </dd>
95 <dd>
96 <p>might give you the name of the remote user given you are using
97 some sort of access control on the directory.</p>
98 </dd>
99 <p></p>
100 <dt><strong><a name="item_rrd_3a_3agoodfor_seconds">RRD::GOODFOR <em>seconds</em></a></strong><br />
101 </dt>
102 <dd>
103 Specify the number of seconds this page should remain valid. This will prompt
104 the rrdcgi to output a Last-Modified, an Expire and if the number of
105 seconds is <em>negative</em> a Refresh header.
106 </dd>
107 <p></p>
108 <dt><strong><a name="item_rrd_3a_3ainclude_filename">RRD::INCLUDE <em>filename</em></a></strong><br />
109 </dt>
110 <dd>
111 Include the contents of the specified file into the page returned from the cgi.
112 </dd>
113 <p></p>
114 <dt><strong><a name="item_rrd_3a_3asetenv_variable_value">RRD::SETENV <em>variable</em> <em>value</em></a></strong><br />
115 </dt>
116 <dd>
117 If you want to present your graphs in another time zone than your own, you
118 could use
119 </dd>
120 <dd>
121 <pre>
122  &lt;RRD::SETENV TZ UTC&gt;</pre>
123 </dd>
124 <dd>
125 <p>to make sure everything is presented in Universal Time. Note that the
126 values permitted to TZ depend on your OS.</p>
127 </dd>
128 <p></p>
129 <dt><strong><a name="item_rrd_3a_3asetvar_variable_value">RRD::SETVAR <em>variable</em> <em>value</em></a></strong><br />
130 </dt>
131 <dd>
132 Analog to SETENV but for local variables.
133 </dd>
134 <p></p>
135 <dt><strong><a name="item_rrd_3a_3agetvar_variable">RRD::GETVAR <em>variable</em></a></strong><br />
136 </dt>
137 <dd>
138 Analog to GETENV but for local variables.
139 </dd>
140 <p></p>
141 <dt><strong><a name="item_rrd_3a_3atime_3a_3alast_rrd_2dfile_strftime_2dform">RRD::TIME::LAST <em>rrd-file</em> <em>strftime-format</em></a></strong><br />
142 </dt>
143 <dd>
144 This gets replaced by the last modification time of the selected RRD. The
145 time is <em>strftime</em>-formatted with the string specified in the second argument.
146 </dd>
147 <p></p>
148 <dt><strong><a name="item_rrd_3a_3atime_3a_3anow_strftime_2dformat">RRD::TIME::NOW <em>strftime-format</em></a></strong><br />
149 </dt>
150 <dd>
151 This gets replaced by the current time of day. The time is
152 <em>strftime</em>-formatted with the string specified in the argument.
153 </dd>
154 <dd>
155 <p>Note that if you return : (colons) from your strftime format you may
156 have to escape them using \ if the time is to be used as an argument
157 to a GRAPH command.</p>
158 </dd>
159 <p></p>
160 <dt><strong><a name="item_rrd_3a_3atime_3a_3astrftime_start_7cend_start_2dsp">RRD::TIME::STRFTIME <em>START|END</em> <em>start-spec</em> <em>end-spec</em> <em>strftime-format</em></a></strong><br />
161 </dt>
162 <dd>
163 This gets replaced by a strftime-formatted time using the format
164 <em>strftime-format</em> on either <em>start-spec</em> or <em>end-spec</em> depending on
165 whether <em>START</em> or <em>END</em> is specified.  Both <em>start-spec</em> and <em>end-spec</em>
166 must be supplied as either could be relative to the other.  This is intended
167 to allow pretty titles on graphs with times that are easier for non RRDtool
168 folks to figure out than ``-2weeks''.
169 </dd>
170 <dd>
171 <p>Note that again, if you return : (colon) from your strftime format,
172 you may have to escape them using \ if the time is to be used as an
173 argument to a GRAPH command.</p>
174 </dd>
175 <p></p>
176 <dt><strong><a name="item_rrd_3a_3agraph_rrdgraph_arguments">RRD::GRAPH <em>rrdgraph arguments</em></a></strong><br />
177 </dt>
178 <dd>
179 This tag creates the RRD graph defined by its argument and then is
180 replaced by an appropriate &lt;IMG ... &gt; tag referring to the graph.
181 The <strong>--lazy</strong> option in RRD graph can be used to make sure that graphs
182 are only regenerated when they are out of date. The arguments
183 to the <strong>RRD::GRAPH</strong> tag work as described in the <strong>rrdgraph</strong> manual page.
184 </dd>
185 <dd>
186 <p>Use the <strong>--lazy</strong> option in your RRD::GRAPH tags, to reduce the load
187 on your server. This option makes sure that graphs are only regenerated when
188 the old ones are out of date.</p>
189 </dd>
190 <dd>
191 <p>If you do not specify your own <strong>--imginfo</strong> format, the following will
192 be used:</p>
193 </dd>
194 <dd>
195 <pre>
196  &lt;IMG SRC=&quot;%s&quot; WIDTH=&quot;%lu&quot; HEIGHT=&quot;%lu&quot;&gt;</pre>
197 </dd>
198 <dd>
199 <p>Note that %s stands for the filename part of the graph generated, all
200 directories given in the PNG file argument will get dropped.</p>
201 </dd>
202 <p></p>
203 <dt><strong><a name="item_rrd_3a_3aprint_number">RRD::PRINT <em>number</em></a></strong><br />
204 </dt>
205 <dd>
206 If the preceding  <strong>RRD::GRAPH</strong> tag contained and <strong>PRINT</strong> arguments,
207 then you can access their output with this tag. The <em>number</em> argument refers to the
208 number of the <strong>PRINT</strong> argument. This first <strong>PRINT</strong> has <em>number</em> 0.
209 </dd>
210 <p></p>
211 <dt><strong><a name="item_rrd_3a_3ainternal__3cvar_3e">RRD::INTERNAL &lt;var&gt;</a></strong><br />
212 </dt>
213 <dd>
214 This tag gets replaced by an internal var. Currently these vars are known:
215 VERSION, COMPILETIME.
216 These vars represent the compiled-in values.
217 </dd>
218 <p></p></dl>
219 <p>
220 </p>
221 <hr />
222 <h1><a name="example_1">EXAMPLE 1</a></h1>
223 <p>The example below creates a web pages with a single RRD graph.</p>
224 <pre>
225  #!/usr/local/bin/rrdcgi
226  &lt;HTML&gt;
227  &lt;HEAD&gt;&lt;TITLE&gt;RRDCGI Demo&lt;/TITLE&gt;&lt;/HEAD&gt;
228  &lt;BODY&gt;
229  &lt;H1&gt;RRDCGI Example Page&lt;/H1&gt;
230  &lt;P&gt;
231  &lt;RRD::GRAPH demo.png --lazy --title=&quot;Temperatures&quot;
232           DEF:cel=demo.rrd:exhaust:AVERAGE
233           LINE2:cel#00a000:&quot;D. Celsius&quot;&gt;</pre>
234 <pre>
235  &lt;/P&gt;
236  &lt;/BODY&gt;
237  &lt;/HTML&gt;</pre>
238 <p>
239 </p>
240 <hr />
241 <h1><a name="example_2">EXAMPLE 2</a></h1>
242 <p>This script is slightly more elaborate, it allows you to run it from
243 a form which sets RRD_NAME. RRD_NAME is then used to select which RRD
244 you want to use as source for your graph.</p>
245 <pre>
246  #!/usr/local/bin/rrdcgi
247  &lt;HTML&gt;
248  &lt;HEAD&gt;&lt;TITLE&gt;RRDCGI Demo&lt;/TITLE&gt;&lt;/HEAD&gt;
249  &lt;BODY&gt;
250  &lt;H1&gt;RRDCGI Example Page for &lt;RRD::CV RRD_NAME&gt;&lt;/H1&gt;
251  &lt;H2&gt;Selection&lt;/H2&gt;
252  &lt;FORM&gt;&lt;INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomA&gt; Room A,
253        &lt;INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomB&gt; Room B.
254        &lt;INPUT TYPE=SUBMIT&gt;&lt;/FORM&gt;
255  &lt;H2&gt;Graph&lt;/H2&gt;
256  &lt;P&gt;
257  &lt;RRD::GRAPH &lt;RRD::CV::PATH RRD_NAME&gt;.png --lazy
258           --title &quot;Temperatures for &quot;&lt;RRD::CV::QUOTE RRD_NAME&gt;
259           DEF:cel=&lt;RRD::CV::PATH RRD_NAME&gt;.rrd:exhaust:AVERAGE
260           LINE2:cel#00a000:&quot;D. Celsius&quot;&gt;</pre>
261 <pre>
262  &lt;/P&gt;
263  &lt;/BODY&gt;
264  &lt;/HTML&gt;</pre>
265 <p>
266 </p>
267 <hr />
268 <h1><a name="example_3">EXAMPLE 3</a></h1>
269 <p>This example shows how to handle the case where the RRD, graphs and
270 cgi-bins are separate directories</p>
271 <pre>
272  #!/.../bin/rrdcgi
273  &lt;HTML&gt;
274  &lt;HEAD&gt;&lt;TITLE&gt;RRDCGI Demo&lt;/TITLE&gt;&lt;/HEAD&gt;
275  &lt;BODY&gt;
276  &lt;H1&gt;RRDCGI test Page&lt;/H1&gt;
277  &lt;RRD::GRAPH
278   /.../web/pngs/testhvt.png
279   --imginfo '&lt;IMG SRC=/.../pngs/%s WIDTH=%lu HEIGHT=%lu &gt;'
280   --lazy --start -1d --end now
281   DEF:http_src=/.../rrds/test.rrd:http_src:AVERAGE
282   AREA:http_src#00ff00:http_src
283  &gt;
284  &lt;/BODY&gt;
285  &lt;/HTML&gt;</pre>
286 <p>Note 1: Replace /.../ with the relevant directories</p>
287 <p>Note 2: The SRC=/.../pngs should be paths from the view of the
288 webserver/browser</p>
289 <p>
290 </p>
291 <hr />
292 <h1><a name="author">AUTHOR</a></h1>
293 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
295 </body>
297 </html>