doc/rrdxport.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>rrdxport</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:root@localhost" />
   8 </head>
   9
  10 <body style="background-color: white">
  11
  12
  13 <!-- INDEX BEGIN -->
  14 <div name="index">
  15 <p><a name="__index__"></a></p>
  16 <!--
  17
  18 <ul>
  19
  20         <li><a href="#name">NAME</a></li>
  21         <li><a href="#synopsis">SYNOPSIS</a></li>
  22         <li><a href="#description">DESCRIPTION</a></li>
  23         <li><a href="#output_format">Output format</a></li>
  24         <li><a href="#example_1">EXAMPLE 1</a></li>
  25         <li><a href="#example_2">EXAMPLE 2</a></li>
  26         <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
  27         <li><a href="#author">AUTHOR</a></li>
  28 </ul>
  29
  30 -->
  31
  32
  33 </div>
  34 <!-- INDEX END -->
  35
  36 <p>
  37 </p>
  38 <h1><a name="name">NAME</a></h1>
  39 <p>rrdxport - Export data in XML format based on data from one or several RRD</p>
  40 <p>
  41 </p>
  42 <hr />
  43 <h1><a name="synopsis">SYNOPSIS</a></h1>
  44 <p><strong>rrdtool</strong> <strong>xport</strong>
  45 [<strong>-s</strong>|<strong>--start</strong>&nbsp;<em>seconds</em>]
  46 [<strong>-e</strong>|<strong>--end</strong>&nbsp;<em>seconds</em>]
  47 [<strong>-m</strong>|<strong>--maxrows</strong>&nbsp;<em>rows</em>]
  48 [<strong>--step</strong>&nbsp;<em>value</em>]
  49 [<strong>--json</strong>]
  50 [<strong>--daemon</strong>&nbsp;<em>address</em>]
  51 [<strong>DEF:</strong><em>vname</em><strong>=</strong><em>rrd</em><strong>:</strong><em>ds-name</em><strong>:</strong><em>CF</em>]
  52 [<strong>CDEF:</strong><em>vname</em><strong>=</strong><em>rpn-expression</em>]
  53 [<strong>XPORT</strong><strong>:</strong><em>vname</em>[<strong>:</strong><em>legend</em>]]</p>
  54 <p>
  55 </p>
  56 <hr />
  57 <h1><a name="description">DESCRIPTION</a></h1>
  58 <p>The <strong>xport</strong> function's main purpose is to write an XML formatted
  59 representation of the data stored in one or several <strong>RRD</strong>s. It
  60 can also extract numerical reports.</p>
  61 <p>If no <em>XPORT</em> statements are found, there will be no output.</p>
  62 <dl>
  63 <dt><strong><a name="seconds" class="item"><strong>-s</strong>|<strong>--start</strong> <em>seconds</em> (default end-1day)</a></strong></dt>
  64
  65 <dd>
  66 <p>The time when the exported range should begin. Time in seconds since
  67 epoch (1970-01-01) is required. Negative numbers are relative to the
  68 current time. By default one day worth of data will be printed.
  69 See also AT-STYLE TIME SPECIFICATION section in the <em>rrdfetch</em>
  70 documentation for a detailed explanation on how to specify time.</p>
  71 </dd>
  72 <dt><strong><strong>-e</strong>|<strong>--end</strong> <em>seconds</em> (default now)</strong></dt>
  73
  74 <dd>
  75 <p>The time when the exported range should end. Time in seconds since epoch.
  76 See also AT-STYLE TIME SPECIFICATION section in the <em>rrdfetch</em>
  77 documentation for a detailed explanation of ways to specify time.</p>
  78 </dd>
  79 <dt><strong><a name="rows" class="item"><strong>-m</strong>|<strong>--maxrows</strong> <em>rows</em> (default 400 rows)</a></strong></dt>
  80
  81 <dd>
  82 <p>This works like the <strong>-w</strong>|<strong>--width</strong> parameter of <em>rrdgraph</em>.
  83 In fact it is exactly the same, but the parameter was renamed to
  84 describe its purpose in this module. See <em>rrdgraph</em> documentation
  85 for details.</p>
  86 </dd>
  87 <dt><strong><a name="value" class="item"><strong>--step</strong> <em>value</em> (default automatic)</a></strong></dt>
  88
  89 <dd>
  90 <p>See <a href="././rrdgraph.html">the rrdgraph manpage</a> documentation.</p>
  91 </dd>
  92 <dt><strong><a name="daemon_address" class="item"><strong>--daemon</strong> <em>address</em></a></strong></dt>
  93
  94 <dd>
  95 <p>Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If specified, a <code>flush</code> command is sent
  96 to the server before reading the RRD files. This allows <strong>rrdtool</strong> to return
  97 fresh data even if the daemon is configured to cache values for a long time.
  98 For a list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.</p>
  99 <pre>
 100   rrdtool xport --daemon unix:/var/run/rrdcached.sock ...</pre>
 101 </dd>
 102 <dt><strong><a name="json" class="item"><strong>--json</strong></a></strong></dt>
 103
 104 <dd>
 105 <p>produce json formated output (instead of xml)</p>
 106 </dd>
 107 <dt><strong><a name="enumds" class="item"><strong>--enumds</strong></a></strong></dt>
 108
 109 <dd>
 110 <p>The generated xml should contain the data values in enumerated tags.</p>
 111 <pre>
 112  &lt;v0&gt;val&lt;/v0&gt;&lt;v1&gt;val&lt;/v1&gt;</pre>
 113 </dd>
 114 <dt><strong><a name="def_vname_rrd_ds_name_cf" class="item"><strong>DEF:</strong><em>vname</em><strong>=</strong><em>rrd</em><strong>:</strong><em>ds-name</em><strong>:</strong><em>CF</em></a></strong></dt>
 115
 116 <dd>
 117 <p>See <em>rrdgraph</em> documentation.</p>
 118 </dd>
 119 <dt><strong><a name="cdef_vname_rpn_expression" class="item"><strong>CDEF:</strong><em>vname</em><strong>=</strong><em>rpn-expression</em></a></strong></dt>
 120
 121 <dd>
 122 <p>See <em>rrdgraph</em> documentation.</p>
 123 </dd>
 124 <dt><strong><a name="xport_vname_legend" class="item"><strong>XPORT:</strong><em>vname</em><strong>:</strong><strong>:</strong><em>legend</em></a></strong></dt>
 125
 126 <dd>
 127 <p>At least one <em>XPORT</em> statement should be present. The values
 128 referenced by <em>vname</em> are printed. Optionally add a legend.</p>
 129 </dd>
 130 </dl>
 131 <p>
 132 </p>
 133 <hr />
 134 <h1><a name="output_format">Output format</a></h1>
 135 <p>The output is enclosed in an <strong>xport</strong> element and contains two
 136 blocks. The first block is enclosed by a <strong>meta</strong> element and
 137 contains some meta data. The second block is enclosed by a
 138 <strong>data</strong> element and contains the data rows.</p>
 139 <p>Let's assume that the <em>xport</em> command looks like this:</p>
 140 <pre>
 141   rrdtool xport \
 142           --start now-1h --end now \
 143           DEF:xx=host-inout.lo.rrd:output:AVERAGE \
 144           DEF:yy=host-inout.lo.rrd:input:AVERAGE \
 145           CDEF:aa=xx,yy,+,8,* \
 146           XPORT:xx:&quot;out bytes&quot; \
 147           XPORT:aa:&quot;in and out bits&quot;</pre>
 148 <p>The resulting meta data section is (the values will depend on the
 149 RRD characteristics):</p>
 150 <pre>
 151   &lt;meta&gt;
 152     &lt;start&gt;1020611700&lt;/start&gt;
 153     &lt;step&gt;300&lt;/step&gt;
 154     &lt;end&gt;1020615600&lt;/end&gt;
 155     &lt;rows&gt;14&lt;/rows&gt;
 156     &lt;columns&gt;2&lt;/columns&gt;
 157     &lt;legend&gt;
 158       &lt;entry&gt;out bytes&lt;/entry&gt;
 159       &lt;entry&gt;in and out bits&lt;/entry&gt;
 160     &lt;/legend&gt;
 161   &lt;/meta&gt;</pre>
 162 <p>The resulting data section is:</p>
 163 <pre>
 164   &lt;data&gt;
 165     &lt;row&gt;&lt;t&gt;1020611700&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 166     &lt;row&gt;&lt;t&gt;1020612000&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 167     &lt;row&gt;&lt;t&gt;1020612300&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 168     &lt;row&gt;&lt;t&gt;1020612600&lt;/t&gt;&lt;v&gt;3.4113333333e+00&lt;/v&gt;&lt;v&gt;5.4581333333e+01&lt;/v&gt;&lt;/row&gt;
 169     &lt;row&gt;&lt;t&gt;1020612900&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 170     &lt;row&gt;&lt;t&gt;1020613200&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 171     &lt;row&gt;&lt;t&gt;1020613500&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 172     &lt;row&gt;&lt;t&gt;1020613800&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 173     &lt;row&gt;&lt;t&gt;1020614100&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 174     &lt;row&gt;&lt;t&gt;1020614400&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 175     &lt;row&gt;&lt;t&gt;1020614700&lt;/t&gt;&lt;v&gt;3.7333333333e+00&lt;/v&gt;&lt;v&gt;5.9733333333e+01&lt;/v&gt;&lt;/row&gt;
 176     &lt;row&gt;&lt;t&gt;1020615000&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 177     &lt;row&gt;&lt;t&gt;1020615300&lt;/t&gt;&lt;v&gt;3.4000000000e+00&lt;/v&gt;&lt;v&gt;5.4400000000e+01&lt;/v&gt;&lt;/row&gt;
 178     &lt;row&gt;&lt;t&gt;1020615600&lt;/t&gt;&lt;v&gt;NaN&lt;/v&gt;&lt;v&gt;NaN&lt;/v&gt;&lt;/row&gt;
 179   &lt;/data&gt;</pre>
 180 <p>
 181 </p>
 182 <hr />
 183 <h1><a name="example_1">EXAMPLE 1</a></h1>
 184 <pre>
 185   rrdtool xport \
 186           DEF:out=if1-inouts.rrd:outoctets:AVERAGE \
 187           XPORT:out:&quot;out bytes&quot;</pre>
 188 <p>
 189 </p>
 190 <hr />
 191 <h1><a name="example_2">EXAMPLE 2</a></h1>
 192 <pre>
 193   rrdtool xport \
 194           DEF:out1=if1-inouts.rrd:outoctets:AVERAGE \
 195           DEF:out2=if2-inouts.rrd:outoctets:AVERAGE \
 196           CDEF:sum=out1,out2,+ \
 197           XPORT:out1:&quot;if1 out bytes&quot; \
 198           XPORT:out2:&quot;if2 out bytes&quot; \
 199           XPORT:sum:&quot;output sum&quot;</pre>
 200 <p>
 201 </p>
 202 <hr />
 203 <h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
 204 <p>The following environment variables may be used to change the behavior of
 205 <code>rrdtoolxport</code>:</p>
 206 <dl>
 207 <dt><strong><a name="rrdcached_address" class="item"><strong>RRDCACHED_ADDRESS</strong></a></strong></dt>
 208
 209 <dd>
 210 <p>If this environment variable is set it will have the same effect as specifying
 211 the <code>--daemon</code> option on the command line. If both are present, the command
 212 line argument takes precedence.</p>
 213 </dd>
 214 </dl>
 215 <p>
 216 </p>
 217 <hr />
 218 <h1><a name="author">AUTHOR</a></h1>
 219 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 220
 221 </body>
 222
 223 </html>