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] [--daemon address]
12 [DEF:vname=rrd:ds-name:CF] [CDEF:vname=rpn-expression]
13 [XPORT:vname[:legend]]
14
16 The xport function's main purpose is to write an XML formatted
17 representation of the data stored in one or several RRDs. It can also
18 extract numerical reports.
19 If no XPORT statements are found, there will be no output.
21 -s|--start seconds (default end-1day)
23 The time when the exported range should begin. Time in seconds
24 since epoch (1970-01-01) is required. Negative numbers are relative
25 to the current time. By default one day worth of data will be
26 printed. See also AT-STYLE TIME SPECIFICATION section in the
27 rrdfetch documentation for a detailed explanation on how to specify
28 time.
29 -e|--end seconds (default now)
31 The time when the exported range should end. Time in seconds since
32 epoch. See also AT-STYLE TIME SPECIFICATION section in the
33 rrdfetch documentation for a detailed explanation of ways to
34 specify time.
35 -m|--maxrows rows (default 400 rows)
37 This works like the -w|--width parameter of rrdgraph. In fact it
38 is exactly the same, but the parameter was renamed to describe its
39 purpose in this module. See rrdgraph documentation for details.
40 --step value (default automatic)
42 See rrdgraph documentation.
43 --daemon address
45 Address of the rrdcached daemon. If specified, a "flush" command is
46 sent to the server before reading the RRD files. This allows
47 rrdtool to return fresh data even if the daemon is configured to
48 cache values for a long time. For a list of accepted formats, see
49 the -l option in the rrdcached manual.
50 rrdtool xport --daemon unix:/var/run/rrdcached.sock ...
52 --enumds
54 The generated xml should contain the data values in enumerated
55 tags.
56 <v0>val</v0><v1>val</v1>
58 DEF:vname=rrd:ds-name:CF
60 See rrdgraph documentation.
61 CDEF:vname=rpn-expression
63 See rrdgraph documentation.
64 XPORT:vname::legend
66 At least one XPORT statement should be present. The values
67 referenced by vname are printed. Optionally add a legend.
68
70 The output is enclosed in an xport element and contains two blocks. The
71 first block is enclosed by a meta element and contains some meta data.
72 The second block is enclosed by a data element and contains the data
73 rows.
74 Let's assume that the xport command looks like this:
76 rrdtool xport \
78 --start now-1h --end now \
79 DEF:xx=host-inout.lo.rrd:output:AVERAGE \
80 DEF:yy=host-inout.lo.rrd:input:AVERAGE \
81 CDEF:aa=xx,yy,+,8,* \
82 XPORT:xx:"out bytes" \
83 XPORT:aa:"in and out bits"
84 The resulting meta data section is (the values will depend on the RRD
86 characteristics):
87 <meta>
89 <start>1020611700</start>
90 <step>300</step>
91 <end>1020615600</end>
92 <rows>14</rows>
93 <columns>2</columns>
94 <legend>
95 <entry>out bytes</entry>
96 <entry>in and out bits</entry>
97 </legend>
98 </meta>
99 The resulting data section is:
101 <data>
103 <row><t>1020611700</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
104 <row><t>1020612000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
105 <row><t>1020612300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
106 <row><t>1020612600</t><v>3.4113333333e+00</v><v>5.4581333333e+01</v></row>
107 <row><t>1020612900</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
108 <row><t>1020613200</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
109 <row><t>1020613500</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
110 <row><t>1020613800</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
111 <row><t>1020614100</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
112 <row><t>1020614400</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
113 <row><t>1020614700</t><v>3.7333333333e+00</v><v>5.9733333333e+01</v></row>
114 <row><t>1020615000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
115 <row><t>1020615300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
116 <row><t>1020615600</t><v>NaN</v><v>NaN</v></row>
117 </data>
118
120 rrdtool xport \
121 DEF:out=if1-inouts.rrd:outoctets:AVERAGE \
122 XPORT:out:"out bytes"
123
125 rrdtool xport \
126 DEF:out1=if1-inouts.rrd:outoctets:AVERAGE \
127 DEF:out2=if2-inouts.rrd:outoctets:AVERAGE \
128 CDEF:sum=out1,out2,+ \
129 XPORT:out1:"if1 out bytes" \
130 XPORT:out2:"if2 out bytes" \
131 XPORT:sum:"output sum"
132
134 The following environment variables may be used to change the behavior
135 of "rrdtool xport":
136 RRDCACHED_ADDRESS
138 If this environment variable is set it will have the same effect as
139 specifying the "--daemon" option on the command line. If both are
140 present, the command line argument takes precedence.
141
143 Tobias Oetiker <tobi@oetiker.ch>
1441.4.4 2008-09-25 RRDXPORT(1)