1RRDXPORT(1) rrdtool RRDXPORT(1)
2
6 rrdxport - Export data in XML format based on data from one or several
7 RRD
8
10 rrdtool xport [-s|--start seconds] [-e|--end seconds]
11 [-m|--maxrows rows] [--step value] [DEF:vname=rrd:ds-name:CF]
12 [CDEF:vname=rpn-expression] [XPORT:vname[:legend]]
13
15 The xport function's main purpose is to write an XML formatted
16 representation of the data stored in one or several RRDs. It can also
17 extract numerical reports.
18 If no XPORT statements are found, there will be no output.
20 -s|--start seconds (default end-1day)
22 The time when the exported range should begin. Time in seconds
23 since epoch (1970-01-01) is required. Negative numbers are relative
24 to the current time. By default one day worth of data will be
25 printed. See also AT-STYLE TIME SPECIFICATION section in the
26 rrdfetch documentation for a detailed explanation on how to specify
27 time.
28 -e|--end seconds (default now)
30 The time when the exported range should end. Time in seconds since
31 epoch. See also AT-STYLE TIME SPECIFICATION section in the
32 rrdfetch documentation for a detailed explanation of ways to
33 specify time.
34 -m|--maxrows rows (default 400 rows)
36 This works like the -w|--width parameter of rrdgraph. In fact it
37 is exactly the same, but the parameter was renamed to describe its
38 purpose in this module. See rrdgraph documentation for details.
39 --step value (default automatic)
41 See rrdgraph documentation.
42 --enumds
44 The generated xml should contain the data values in enumerated
45 tags.
46 <v0>val</v0><v1>val</v1>
48 DEF:vname=rrd:ds-name:CF
50 See rrdgraph documentation.
51 CDEF:vname=rpn-expression
53 See rrdgraph documentation.
54 XPORT:vname::legend
56 At least one XPORT statement should be present. The values
57 referenced by vname are printed. Optionally add a legend.
58
60 The output is enclosed in an xport element and contains two blocks. The
61 first block is enclosed by a meta element and contains some meta data.
62 The second block is enclosed by a data element and contains the data
63 rows.
64 Let's assume that the xport command looks like this:
66 rrdtool xport \
68 --start now-1h --end now \
69 DEF:xx=host-inout.lo.rrd:output:AVERAGE \
70 DEF:yy=host-inout.lo.rrd:input:AVERAGE \
71 CDEF:aa=xx,yy,+,8,* \
72 XPORT:xx:"out bytes" \
73 XPORT:aa:"in and out bits"
74 The resulting meta data section is (the values will depend on the RRD
76 characteristics):
77 <meta>
79 <start>1020611700</start>
80 <step>300</step>
81 <end>1020615600</end>
82 <rows>14</rows>
83 <columns>2</columns>
84 <legend>
85 <entry>out bytes</entry>
86 <entry>in and out bits</entry>
87 </legend>
88 </meta>
89 The resulting data section is:
91 <data>
93 <row><t>1020611700</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
94 <row><t>1020612000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
95 <row><t>1020612300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
96 <row><t>1020612600</t><v>3.4113333333e+00</v><v>5.4581333333e+01</v></row>
97 <row><t>1020612900</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
98 <row><t>1020613200</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
99 <row><t>1020613500</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
100 <row><t>1020613800</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
101 <row><t>1020614100</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
102 <row><t>1020614400</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
103 <row><t>1020614700</t><v>3.7333333333e+00</v><v>5.9733333333e+01</v></row>
104 <row><t>1020615000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
105 <row><t>1020615300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
106 <row><t>1020615600</t><v>NaN</v><v>NaN</v></row>
107 </data>
108
110 rrdtool xport \
111 DEF:out=if1-inouts.rrd:outoctets:AVERAGE \
112 XPORT:out:"out bytes"
113
115 rrdtool xport \
116 DEF:out1=if1-inouts.rrd:outoctets:AVERAGE \
117 DEF:out2=if2-inouts.rrd:outoctets:AVERAGE \
118 CDEF:sum=out1,out2,+ \
119 XPORT:out1:"if1 out bytes" \
120 XPORT:out2:"if2 out bytes" \
121 XPORT:sum:"output sum"
122
124 Tobias Oetiker <tobi@oetiker.ch>
1251.3.8 2008-03-15 RRDXPORT(1)