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>
10 <body style="background-color: white">
12 <p><a name="__index__"></a></p>
13 <!-- INDEX BEGIN -->
14 <!--
16 <ul>
18 <li><a href="#name">NAME</a></li>
19 <li><a href="#synopsis">SYNOPSIS</a></li>
20 <li><a href="#description">DESCRIPTION</a></li>
21 <li><a href="#output_format">Output format</a></li>
22 <li><a href="#example_1">EXAMPLE 1</a></li>
23 <li><a href="#example_2">EXAMPLE 2</a></li>
24 <li><a href="#author">AUTHOR</a></li>
25 </ul>
26 -->
27 <!-- INDEX END -->
29 <p>
30 </p>
31 <h1><a name="name">NAME</a></h1>
32 <p>rrdxport - Export data in XML format based on data from one or several RRD</p>
33 <p>
34 </p>
35 <hr />
36 <h1><a name="synopsis">SYNOPSIS</a></h1>
37 <p><strong>rrdtool</strong> <strong>xport</strong>
38 [<strong>-s</strong>|<strong>--start</strong> <em>seconds</em>]
39 [<strong>-e</strong>|<strong>--end</strong> <em>seconds</em>]
40 [<strong>-m</strong>|<strong>--maxrows</strong> <em>rows</em>]
41 [<strong>--step</strong> <em>value</em>]
42 [<strong>DEF:</strong><em>vname</em><strong>=</strong><em>rrd</em><strong>:</strong><em>ds-name</em><strong>:</strong><em>CF</em>]
43 [<strong>CDEF:</strong><em>vname</em><strong>=</strong><em>rpn-expression</em>]
44 [<strong>XPORT</strong><strong>:</strong><em>vname</em>[<strong>:</strong><em>legend</em>]]</p>
45 <p>
46 </p>
47 <hr />
48 <h1><a name="description">DESCRIPTION</a></h1>
49 <p>The <strong>xport</strong> function's main purpose is to write an XML formatted
50 representation of the data stored in one or several <strong>RRD</strong>s. It
51 can also extract numerical reports.</p>
52 <p>If no <em>XPORT</em> statements are found, there will be no output.</p>
53 <dl>
54 <dt><strong><a name="item_seconds"><strong>-s</strong>|<strong>--start</strong> <em>seconds</em> (default end-1day)</a></strong>
56 <dd>
57 <p>The time when the exported range should begin. Time in seconds since
58 epoch (1970-01-01) is required. Negative numbers are relative to the
59 current time. By default one day worth of data will be printed.
60 See also AT-STYLE TIME SPECIFICATION section in the <em>rrdfetch</em>
61 documentation for a detailed explanation on how to specify time.</p>
62 </dd>
63 </li>
64 <dt><strong><strong>-e</strong>|<strong>--end</strong> <em>seconds</em> (default now)</strong>
66 <dd>
67 <p>The time when the exported range should end. Time in seconds since epoch.
68 See also AT-STYLE TIME SPECIFICATION section in the <em>rrdfetch</em>
69 documentation for a detailed explanation of ways to specify time.</p>
70 </dd>
71 </li>
72 <dt><strong><a name="item_rows"><strong>-m</strong>|<strong>--maxrows</strong> <em>rows</em> (default 400 rows)</a></strong>
74 <dd>
75 <p>This works like the <strong>-w</strong>|<strong>--width</strong> parameter of <em>rrdgraph</em>.
76 In fact it is exactly the same, but the parameter was renamed to
77 describe its purpose in this module. See <em>rrdgraph</em> documentation
78 for details.</p>
79 </dd>
80 </li>
81 <dt><strong><a name="item_value"><strong>--step</strong> <em>value</em> (default automatic)</a></strong>
83 <dd>
84 <p>See <a href="././rrdgraph.html">the rrdgraph manpage</a> documentation.</p>
85 </dd>
86 </li>
87 <dt><strong><a name="item__2d_2denumds"><strong>--enumds</strong></a></strong>
89 <dd>
90 <p>The generated xml should contain the data values in enumerated tags.</p>
91 </dd>
92 <dd>
93 <pre>
94 <v0>val</v0><v1>val</v1></pre>
95 </dd>
96 </li>
97 <dt><strong><a name="item_def_3avname_3drrd_3ads_2dname_3acf"><strong>DEF:</strong><em>vname</em><strong>=</strong><em>rrd</em><strong>:</strong><em>ds-name</em><strong>:</strong><em>CF</em></a></strong>
99 <dd>
100 <p>See <em>rrdgraph</em> documentation.</p>
101 </dd>
102 </li>
103 <dt><strong><a name="item_cdef_3avname_3drpn_2dexpression"><strong>CDEF:</strong><em>vname</em><strong>=</strong><em>rpn-expression</em></a></strong>
105 <dd>
106 <p>See <em>rrdgraph</em> documentation.</p>
107 </dd>
108 </li>
109 <dt><strong><a name="item_xport_3avname_3a_3alegend"><strong>XPORT:</strong><em>vname</em><strong>:</strong><strong>:</strong><em>legend</em></a></strong>
111 <dd>
112 <p>At least one <em>XPORT</em> statement should be present. The values
113 referenced by <em>vname</em> are printed. Optionally add a legend.</p>
114 </dd>
115 </li>
116 </dl>
117 <p>
118 </p>
119 <hr />
120 <h1><a name="output_format">Output format</a></h1>
121 <p>The output is enclosed in an <strong>xport</strong> element and contains two
122 blocks. The first block is enclosed by a <strong>meta</strong> element and
123 contains some meta data. The second block is enclosed by a
124 <strong>data</strong> element and contains the data rows.</p>
125 <p>Let's assume that the <em>xport</em> command looks like this:</p>
126 <pre>
127 rrdtool xport \
128 --start now-1h --end now \
129 DEF:xx=host-inout.lo.rrd:output:AVERAGE \
130 DEF:yy=host-inout.lo.rrd:input:AVERAGE \
131 CDEF:aa=xx,yy,+,8,* \
132 XPORT:xx:"out bytes" \
133 XPORT:aa:"in and out bits"</pre>
134 <p>The resulting meta data section is (the values will depend on the
135 RRD characteristics):</p>
136 <pre>
137 <meta>
138 <start>1020611700</start>
139 <step>300</step>
140 <end>1020615600</end>
141 <rows>14</rows>
142 <columns>2</columns>
143 <legend>
144 <entry>out bytes</entry>
145 <entry>in and out bits</entry>
146 </legend>
147 </meta></pre>
148 <p>The resulting data section is:</p>
149 <pre>
150 <data>
151 <row><t>1020611700</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
152 <row><t>1020612000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
153 <row><t>1020612300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
154 <row><t>1020612600</t><v>3.4113333333e+00</v><v>5.4581333333e+01</v></row>
155 <row><t>1020612900</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
156 <row><t>1020613200</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
157 <row><t>1020613500</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
158 <row><t>1020613800</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
159 <row><t>1020614100</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
160 <row><t>1020614400</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
161 <row><t>1020614700</t><v>3.7333333333e+00</v><v>5.9733333333e+01</v></row>
162 <row><t>1020615000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
163 <row><t>1020615300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
164 <row><t>1020615600</t><v>NaN</v><v>NaN</v></row>
165 </data></pre>
166 <p>
167 </p>
168 <hr />
169 <h1><a name="example_1">EXAMPLE 1</a></h1>
170 <pre>
171 rrdtool xport \
172 DEF:out=if1-inouts.rrd:outoctets:AVERAGE \
173 XPORT:out:"out bytes"</pre>
174 <p>
175 </p>
176 <hr />
177 <h1><a name="example_2">EXAMPLE 2</a></h1>
178 <pre>
179 rrdtool xport \
180 DEF:out1=if1-inouts.rrd:outoctets:AVERAGE \
181 DEF:out2=if2-inouts.rrd:outoctets:AVERAGE \
182 CDEF:sum=out1,out2,+ \
183 XPORT:out1:"if1 out bytes" \
184 XPORT:out2:"if2 out bytes" \
185 XPORT:sum:"output sum"</pre>
186 <p>
187 </p>
188 <hr />
189 <h1><a name="author">AUTHOR</a></h1>
190 <p>Tobias Oetiker <<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>></p>
192 </body>
194 </html>