3 rrdxport - Export data in XML format based on data from one or several RRD
8 S<[B<-s>|B<--start> I<seconds>]>
9 S<[B<-e>|B<--end> I<seconds>]>
10 S<[B<-m>|B<--maxrows> I<rows>]>
11 S<[B<--step> I<value>]>
12 S<[B<--daemon> I<address>]>
13 S<[B<DEF:>I<vname>B<=>I<rrd>B<:>I<ds-name>B<:>I<CF>]>
14 S<[B<CDEF:>I<vname>B<=>I<rpn-expression>]>
15 S<[B<XPORT>B<:>I<vname>[B<:>I<legend>]]>
19 The B<xport> function's main purpose is to write an XML formatted
20 representation of the data stored in one or several B<RRD>s. It
21 can also extract numerical reports.
23 If no I<XPORT> statements are found, there will be no output.
27 =item B<-s>|B<--start> I<seconds> (default end-1day)
29 The time when the exported range should begin. Time in seconds since
30 epoch (1970-01-01) is required. Negative numbers are relative to the
31 current time. By default one day worth of data will be printed.
32 See also AT-STYLE TIME SPECIFICATION section in the I<rrdfetch>
33 documentation for a detailed explanation on how to specify time.
35 =item B<-e>|B<--end> I<seconds> (default now)
37 The time when the exported range should end. Time in seconds since epoch.
38 See also AT-STYLE TIME SPECIFICATION section in the I<rrdfetch>
39 documentation for a detailed explanation of ways to specify time.
41 =item B<-m>|B<--maxrows> I<rows> (default 400 rows)
43 This works like the B<-w>|B<--width> parameter of I<rrdgraph>.
44 In fact it is exactly the same, but the parameter was renamed to
45 describe its purpose in this module. See I<rrdgraph> documentation
48 =item B<--step> I<value> (default automatic)
50 See L<rrdgraph> documentation.
52 =item B<--daemon> I<address>
54 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
55 to the server before reading the RRD files. This allows B<rrdtool> to return
56 fresh data even if the daemon is configured to cache values for a long time.
57 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
59 rrdtool xport --daemon unix:/var/run/rrdcached.sock ...
63 The generated xml should contain the data values in enumerated tags.
65 <v0>val</v0><v1>val</v1>
67 =item B<DEF:>I<vname>B<=>I<rrd>B<:>I<ds-name>B<:>I<CF>
69 See I<rrdgraph> documentation.
71 =item B<CDEF:>I<vname>B<=>I<rpn-expression>
73 See I<rrdgraph> documentation.
75 =item B<XPORT:>I<vname>B<:>B<:>I<legend>
77 At least one I<XPORT> statement should be present. The values
78 referenced by I<vname> are printed. Optionally add a legend.
84 The output is enclosed in an B<xport> element and contains two
85 blocks. The first block is enclosed by a B<meta> element and
86 contains some meta data. The second block is enclosed by a
87 B<data> element and contains the data rows.
89 Let's assume that the I<xport> command looks like this:
92 --start now-1h --end now \
93 DEF:xx=host-inout.lo.rrd:output:AVERAGE \
94 DEF:yy=host-inout.lo.rrd:input:AVERAGE \
96 XPORT:xx:"out bytes" \
97 XPORT:aa:"in and out bits"
99 The resulting meta data section is (the values will depend on the
100 RRD characteristics):
103 <start>1020611700</start>
105 <end>1020615600</end>
109 <entry>out bytes</entry>
110 <entry>in and out bits</entry>
114 The resulting data section is:
117 <row><t>1020611700</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
118 <row><t>1020612000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
119 <row><t>1020612300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
120 <row><t>1020612600</t><v>3.4113333333e+00</v><v>5.4581333333e+01</v></row>
121 <row><t>1020612900</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
122 <row><t>1020613200</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
123 <row><t>1020613500</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
124 <row><t>1020613800</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
125 <row><t>1020614100</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
126 <row><t>1020614400</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
127 <row><t>1020614700</t><v>3.7333333333e+00</v><v>5.9733333333e+01</v></row>
128 <row><t>1020615000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
129 <row><t>1020615300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
130 <row><t>1020615600</t><v>NaN</v><v>NaN</v></row>
137 DEF:out=if1-inouts.rrd:outoctets:AVERAGE \
138 XPORT:out:"out bytes"
143 DEF:out1=if1-inouts.rrd:outoctets:AVERAGE \
144 DEF:out2=if2-inouts.rrd:outoctets:AVERAGE \
145 CDEF:sum=out1,out2,+ \
146 XPORT:out1:"if1 out bytes" \
147 XPORT:out2:"if2 out bytes" \
148 XPORT:sum:"output sum"
150 =head1 ENVIRONMENT VARIABLES
152 The following environment variables may be used to change the behavior of
153 C<rrdtoolE<nbsp>xport>:
157 =item B<RRDCACHED_ADDRESS>
159 If this environment variable is set it will have the same effect as specifying
160 the C<--daemon> option on the command line. If both are present, the command
161 line argument takes precedence.
167 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>