doc/rrdinfo.pod

   1 =head1 NAME
   2
   3 rrdtool info - extract header information from an rrd
   4
   5 =for html <div align="right"><a href="rrdinfo.pdf">PDF</a> version.</div>
   6
   7 =head1 SYNOPSIS
   8
   9 B<rrdtool> B<info> I<filename.rrd>
  10
  11 =head1 DESCRIPTION
  12
  13 The B<info> function prints the header information from an rrd in
  14 a parsing friendly format.
  15
  16 Check L<rrdcreate> if you are uncertain about the meaning of the
  17 individual keys.
  18
  19 The B<info> function will always report the true version of the B<RRD>;
  20 unlike B<dump> which will generate a current version (0002) xml dump for
  21 older version (0001) files (although the version of the B<RRD> is unchanged).
  22
  23 =head1 EXAMPLE
  24
  25 This is the output generated by running B<info> on a simple rrd which
  26 contains two datasources and one rra. Note that the number after the
  27 I<last_update> keyword is in seconds since 1970. The string B<NaN>
  28 stands for I<*UNKNOWN*> data. In the example it means that this rrd
  29 has neither minimum not maximum values defined for either of its
  30 datasources.
  31
  32  filename = "randome.rrd"
  33  rrd_version = "0001"
  34  step = 300
  35  last_update = 955892996
  36  ds[a].type = "GAUGE"
  37  ds[a].minimal_heartbeat = 600
  38  ds[a].min = NaN
  39  ds[a].max = NaN
  40  ds[a].last_ds = "UNKN"
  41  ds[a].value = 2.1824421548e+04
  42  ds[a].unknown_sec = 0
  43  ds[b].type = "GAUGE"
  44  ds[b].minimal_heartbeat = 600
  45  ds[b].min = NaN
  46  ds[b].max = NaN
  47  ds[b].last_ds = "UNKN"
  48  ds[b].value = 3.9620838224e+03
  49  ds[b].unknown_sec = 0
  50  rra[0].cf = "AVERAGE"
  51  rra[0].pdp_per_row = 1
  52  rra[0].cdp_prep[0].value = nan
  53  rra[0].cdp_prep[0].unknown_datapoints = 0
  54  rra[0].cdp_prep[1].value = nan
  55  rra[0].cdp_prep[1].unknown_datapoints = 0
  56
  57 =over 8
  58
  59 =item I<filename.rrd>
  60
  61 The name of the B<RRD> you want to dump.
  62
  63 =back
  64
  65 =head1 AUTHOR
  66
  67 Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
  68