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. To
  29 specify a UNIX domain socket use the prefix C<unix:>, see example below. Other
  30 addresses are interpreted as normal network addresses, i.E<nbsp>e. IPv4 or IPv6
  31 addresses in most cases.
  32
  33  rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
  34
  35 =back
  36
  37 =head1 EXAMPLE
  38
  39 This is the output generated by running B<info> on a simple RRD which
  40 contains two data sources and one RRA. Note that the number after the
  41 I<last_update> keyword is in seconds since 1970. The string B<NaN>
  42 stands for I<*UNKNOWN*> data. In the example it means that this RRD
  43 has neither minimum nor maximum values defined for either of its
  44 data sources.
  45
  46  filename = "random.rrd"
  47  rrd_version = "0001"
  48  step = 300
  49  last_update = 955892996
  50  ds[a].type = "GAUGE"
  51  ds[a].minimal_heartbeat = 600
  52  ds[a].min = NaN
  53  ds[a].max = NaN
  54  ds[a].last_ds = "UNKN"
  55  ds[a].value = 2.1824421548e+04
  56  ds[a].unknown_sec = 0
  57  ds[b].type = "GAUGE"
  58  ds[b].minimal_heartbeat = 600
  59  ds[b].min = NaN
  60  ds[b].max = NaN
  61  ds[b].last_ds = "UNKN"
  62  ds[b].value = 3.9620838224e+03
  63  ds[b].unknown_sec = 0
  64  rra[0].cf = "AVERAGE"
  65  rra[0].pdp_per_row = 1
  66  rra[0].cdp_prep[0].value = nan
  67  rra[0].cdp_prep[0].unknown_datapoints = 0
  68  rra[0].cdp_prep[1].value = nan
  69  rra[0].cdp_prep[1].unknown_datapoints = 0
  70
  71 =head1 ENVIRONMENT VARIABLES
  72
  73 The following environment variables may be used to change the behavior of
  74 C<rrdtoolE<nbsp>info>:
  75
  76 =over 4
  77
  78 =item B<RRDCACHED_ADDRESS>
  79
  80 If this environment variable is set it will have the same effect as specifying
  81 the C<--daemon> option on the command line. If both are present, the command
  82 line argument takes precedence.
  83
  84 =back
  85
  86 =head1 AUTHOR
  87
  88 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
  89