doc/rrdcgi.pod

   1 =head1 NAME
   2
   3 rrdcgi - create web pages containing RRD graphs based on templates
   4
   5 =for html <div align="right"><a href="rrdcgi.pdf">PDF</a> version.</div>
   6
   7 =head1 SYNOPSIS
   8
   9 #!/path/to/B<rrdcgi>
  10 S<[B<--filter>]>
  11
  12 =head1 DESCRIPTION
  13
  14 B<rrdcgi> is a sort of very limited script interpreter. Its purpose
  15 is to run as a cgi-program and parse a web page template containing special
  16 E<lt>RRD:: tags. B<rrdcgi> will interpret and act according to these tags.
  17 In the end it will printout a web page including the necessary CGI headers.
  18
  19 B<rrdcgi> parses the contents of the template in 2 steps. In each step it looks
  20 only for a subset of tags. This allows to nest tags.
  21
  22 The argument parser uses the same semantics as you are used from your c shell.
  23
  24 =over 8
  25
  26
  27 =item B<--filter>
  28
  29 Assume that rrdcgi is being run as a filter and not as a cgi.
  30
  31 =back
  32
  33 =head2 Pass 1
  34
  35 =over 8
  36
  37 =item RRD::CV I<name>
  38
  39 Inserts the CGI variable of the given name.
  40
  41 =item RRD::CV::QUOTE I<name>
  42
  43 Inserts the CGI variable of the given name but quotes it, ready for
  44 use as an argument in another RRD:: tag. So even when there are spaces in the
  45 value of the CGI variable it will still be considered as one argument.
  46
  47 =item RRD::CV::PATH I<name>
  48
  49 Inserts the CGI variable of the given name, quotes it and makes sure
  50 the it starts neither with a '/' nor contains '..'. This is to make
  51 sure that no problematic pathnames can be introduced through the
  52 CGI interface.
  53
  54 =item RRD::GETENV I<variable>
  55
  56 Get the value of an environment variable.
  57
  58  <RRD::GETENV REMOTE_USER>
  59
  60 might give you the name of the remote user given you are using
  61 some sort of access control on the directory
  62
  63 =back
  64
  65 =head2 Pass 2
  66
  67 =over 8
  68
  69 =item RRD::GOODFOR I<seconds>
  70
  71 Specify the number of seconds this page should remain valid. This will prompt
  72 the rrdcgi to output a Last-Modified, an Expire and if the number of
  73 seconds is I<negative> a Refresh headers.
  74
  75 =item RRD::INCLUDE I<filename>
  76
  77 Include the contents of the given file into the page returned from the cgi
  78
  79 =item RRD::SETENV I<variable> I<value>
  80
  81 If you want to present your graphs in another time zone than your own, you
  82 could use
  83
  84  <RRD::SETENV TZ UTC>
  85
  86 to make sure everything is presented in Universal Time. Note that the
  87 values permitted to TZ depend on your OS.
  88
  89 =item RRD::TIME::LAST I<rrd-file> I<strftime-format>
  90
  91 This gets replaced by the last modification time of the selected RRD. The
  92 time is I<strftime>-formated with the string specified in the second argument.
  93
  94 =item RRD::TIME::NOW I<strftime-format>
  95
  96 This gets replaced by the current time of day. The
  97 time is I<strftime>-formated with the string specified in the argument.
  98
  99 =back
 100
 101 =head2 Pass 3
 102
 103 =over 8
 104
 105 =item RRD::GRAPH I<rrdgraph arguments>
 106
 107 This tag creates the RRD graph defined in its argument and then gets
 108 replaced by an appropriate E<lt>IMGE<gt> tag referring to the graph.
 109 The B<--lazy> option in RRD graph can be used to make sure that graphs
 110 are only regenerated when they are out of date. The arguments
 111 to the B<RRD::GRAPH> tag work as described in the B<rrdgraph> manual page.
 112
 113 Use the B<--lazy> option in your RRD::GRAPH tags, to reduce the load
 114 on your server. This option makes sure that graphs are only regenerated when
 115 the old ones are out of date.
 116
 117 If you do not specify your own B<--imginfo> format, the following will
 118 be used:
 119
 120  <IMG SRC="%s" WIDTH="%lu" HEIGHT="%lu">
 121
 122 Note that %s stands for the filename part of the graph generated, all
 123 directories given in the PNG file argument will get dropped.
 124
 125 =item RRD::PRINT I<number>
 126
 127 If the preceding  B<RRD::GRAPH> tag contained and B<PRINT> arguments,
 128 then you can access their output with this tag. The I<number> argument refers to the
 129 number of the B<PRINT> argument. This first B<PRINT> has I<number> 0.
 130
 131 =back
 132
 133 =head1 EXAMPLE 1
 134
 135 The example below creates a web pages with a single RRD graph.
 136
 137  #!/usr/local/bin/rrdcgi
 138  <HTML>
 139  <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
 140  <BODY>
 141  <H1>RRDCGI Example Page</H1>
 142  <P>
 143  <RRD::GRAPH demo.png --lazy --title="Temperatures"
 144           DEF:cel=demo.rrd:exhaust:AVERAGE
 145           LINE2:cel#00a000:"D. Celsius">
 146
 147  </P>
 148  </BODY>
 149  </HTML>
 150
 151 =head1 EXAMPLE 2
 152
 153 This script is slightly more elaborate, it allows you to run it from
 154 a form which sets RRD_NAME. RRD_NAME is then used to select which RRD
 155 you want to use a source for your graph.
 156
 157  #!/usr/local/bin/rrdcgi
 158  <HTML>
 159  <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
 160  <BODY>
 161  <H1>RRDCGI Example Page for <RRD::CV RRD_NAME></H1>
 162  <H2>Selection</H2>
 163  <FORM><INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomA> Room A,
 164        <INPUT NAME=RRD_NAME TYPE=RADIO VALUE=roomB> Room B.
 165        <INPUT TYPE=SUBMIT></FORM>
 166  <H2>Graph</H2>
 167  <P>
 168  <RRD::GRAPH <RRD::CV::PATH RRD_NAME>.png --lazy
 169           --title "Temperatures for "<RRD::CV::QUOTE RRD_NAME>
 170           DEF:cel=<RRD::CV::PATH RRD_NAME>.rrd:exhaust:AVERAGE
 171           LINE2:cel#00a000:"D. Celsius">
 172
 173  </P>
 174  </BODY>
 175  </HTML>
 176
 177 =head1 EXAMPLE 3
 178
 179 This example shows how to handle the case where the RRD, graphs and
 180 cgi-bins are seperate directories
 181
 182  #!/.../bin/rrdcgi
 183  <HTML>
 184  <HEAD><TITLE>RRDCGI Demo</TITLE></HEAD>
 185  <BODY>
 186  <H1>RRDCGI test Page</H1>
 187  <RRD::GRAPH
 188   /.../web/pngs/testhvt.png
 189   --imginfo '<IMG SRC=/.../pngs/%s WIDTH=%lu HEIGHT=%lu >'
 190   --lazy --start -1d --end now
 191   DEF:http_src=/.../rrds/test.rrd:http_src:AVERAGE
 192   AREA:http_src#00ff00:http_src
 193  >
 194  </BODY>
 195  </HTML>
 196
 197 Note 1: Replace /.../ with the relevant directories
 198
 199 Note 2: The SRC=/.../pngs should be paths from the view of the
 200 webserver/browser
 201
 202 =head1 AUTHOR
 203
 204 Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
 205
 206
 207
 208
 209