doc/rrdinfo.pod

   1 =head1 NAME
   2
   3 rrdinfo - extract header information from an RRD
   4
   5 =head1 SYNOPSIS
   6
   7 B<rrdtool> B<info> I<filename>
   8 S<[B<--daemon> I<address>]>
   9
  10 =head1 DESCRIPTION
  11
  12 The B<info> function prints the header information from an RRD in
  13 a parsing friendly format.
  14
  15 Check L<rrdcreate> if you are uncertain about the meaning of the
  16 individual keys.
  17
  18 =over 8
  19
  20 =item I<filename>
  21
  22 The name of the B<RRD> you want to examine.
  23
  24 =item B<--daemon> I<address>
  25
  26 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
  27 to the server before reading the RRD files. This allows B<rrdtool> to return
  28 fresh data even if the daemon is configured to cache values for a long time.
  29 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
  30
  31  rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
  32
  33 =back
  34
  35 =head1 EXAMPLE
  36
  37 This is the output generated by running B<info> on a simple RRD which
  38 contains two data sources and one RRA. Note that the number after the
  39 I<last_update> keyword is in seconds since 1970. The string B<NaN>
  40 stands for I<*UNKNOWN*> data. In the example it means that this RRD
  41 has neither minimum nor maximum values defined for either of its
  42 data sources.
  43
  44  filename = "random.rrd"
  45  rrd_version = "0001"
  46  step = 300
  47  last_update = 955892996
  48  ds[a].type = "GAUGE"
  49  ds[a].minimal_heartbeat = 600
  50  ds[a].min = NaN
  51  ds[a].max = NaN
  52  ds[a].last_ds = "UNKN"
  53  ds[a].value = 2.1824421548e+04
  54  ds[a].unknown_sec = 0
  55  ds[b].type = "GAUGE"
  56  ds[b].minimal_heartbeat = 600
  57  ds[b].min = NaN
  58  ds[b].max = NaN
  59  ds[b].last_ds = "UNKN"
  60  ds[b].value = 3.9620838224e+03
  61  ds[b].unknown_sec = 0
  62  rra[0].cf = "AVERAGE"
  63  rra[0].pdp_per_row = 1
  64  rra[0].cdp_prep[0].value = nan
  65  rra[0].cdp_prep[0].unknown_datapoints = 0
  66  rra[0].cdp_prep[1].value = nan
  67  rra[0].cdp_prep[1].unknown_datapoints = 0
  68
  69 =head1 ENVIRONMENT VARIABLES
  70
  71 The following environment variables may be used to change the behavior of
  72 C<rrdtoolE<nbsp>info>:
  73
  74 =over 4
  75
  76 =item B<RRDCACHED_ADDRESS>
  77
  78 If this environment variable is set it will have the same effect as specifying
  79 the C<--daemon> option on the command line. If both are present, the command
  80 line argument takes precedence.
  81
  82 =back
  83
  84 =head1 AUTHOR
  85
  86 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
  87