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] [--json] [--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 --json
54 produce json formated output (instead of xml)
55 --enumds
57 The generated xml should contain the data values in enumerated
58 tags.
59 <v0>val</v0><v1>val</v1>
61 DEF:vname=rrd:ds-name:CF
63 See rrdgraph documentation.
64 CDEF:vname=rpn-expression
66 See rrdgraph documentation.
67 XPORT:vname::legend
69 At least one XPORT statement should be present. The values
70 referenced by vname are printed. Optionally add a legend.
71
73 The output is enclosed in an xport element and contains two blocks. The
74 first block is enclosed by a meta element and contains some meta data.
75 The second block is enclosed by a data element and contains the data
76 rows.
77 Let's assume that the xport command looks like this:
79 rrdtool xport \
81 --start now-1h --end now \
82 DEF:xx=host-inout.lo.rrd:output:AVERAGE \
83 DEF:yy=host-inout.lo.rrd:input:AVERAGE \
84 CDEF:aa=xx,yy,+,8,* \
85 XPORT:xx:"out bytes" \
86 XPORT:aa:"in and out bits"
87 The resulting meta data section is (the values will depend on the RRD
89 characteristics):
90 <meta>
92 <start>1020611700</start>
93 <step>300</step>
94 <end>1020615600</end>
95 <rows>14</rows>
96 <columns>2</columns>
97 <legend>
98 <entry>out bytes</entry>
99 <entry>in and out bits</entry>
100 </legend>
101 </meta>
102 The resulting data section is:
104 <data>
106 <row><t>1020611700</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
107 <row><t>1020612000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
108 <row><t>1020612300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
109 <row><t>1020612600</t><v>3.4113333333e+00</v><v>5.4581333333e+01</v></row>
110 <row><t>1020612900</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
111 <row><t>1020613200</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
112 <row><t>1020613500</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
113 <row><t>1020613800</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
114 <row><t>1020614100</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
115 <row><t>1020614400</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
116 <row><t>1020614700</t><v>3.7333333333e+00</v><v>5.9733333333e+01</v></row>
117 <row><t>1020615000</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
118 <row><t>1020615300</t><v>3.4000000000e+00</v><v>5.4400000000e+01</v></row>
119 <row><t>1020615600</t><v>NaN</v><v>NaN</v></row>
120 </data>
121
123 rrdtool xport \
124 DEF:out=if1-inouts.rrd:outoctets:AVERAGE \
125 XPORT:out:"out bytes"
126
128 rrdtool xport \
129 DEF:out1=if1-inouts.rrd:outoctets:AVERAGE \
130 DEF:out2=if2-inouts.rrd:outoctets:AVERAGE \
131 CDEF:sum=out1,out2,+ \
132 XPORT:out1:"if1 out bytes" \
133 XPORT:out2:"if2 out bytes" \
134 XPORT:sum:"output sum"
135
137 The following environment variables may be used to change the behavior
138 of "rrdtool xport":
139 RRDCACHED_ADDRESS
141 If this environment variable is set it will have the same effect as
142 specifying the "--daemon" option on the command line. If both are
143 present, the command line argument takes precedence.
144
146 Tobias Oetiker <tobi@oetiker.ch>
1471.4.8 2013-05-23 RRDXPORT(1)