program/doc/rrdxport.pod

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