1 =head1 NAME
3 rrdinfo - extract header information from an RRD
5 =head1 SYNOPSIS
7 B<rrdtool> B<info> I<filename>
8 S<[B<--daemon> I<address>]>
10 =head1 DESCRIPTION
12 The B<info> function prints the header information from an RRD in
13 a parsing friendly format.
15 Check L<rrdcreate> if you are uncertain about the meaning of the
16 individual keys.
18 =over 8
20 =item I<filename>
22 The name of the B<RRD> you want to examine.
24 =item B<--daemon> I<address>
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.
31 rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
33 =item B<--noflush>
35 Omit the C<flush> command usually sent to the daemon prior to retrieving the
36 data. If all you are interested in the the RRD Structure, and not the last update
37 time or current values, then this will improve efficiency.
39 =back
41 =head1 EXAMPLE
43 This is the output generated by running B<info> on a simple RRD which
44 contains two data sources and one RRA. Note that the number after the
45 I<last_update> keyword is in seconds since 1970. The string B<NaN>
46 stands for I<*UNKNOWN*> data. In the example it means that this RRD
47 has neither minimum nor maximum values defined for either of its
48 data sources.
50 filename = "random.rrd"
51 rrd_version = "0001"
52 step = 300
53 last_update = 955892996
54 header_size = 2872
55 ds[a].type = "GAUGE"
56 ds[a].minimal_heartbeat = 600
57 ds[a].min = NaN
58 ds[a].max = NaN
59 ds[a].last_ds = "UNKN"
60 ds[a].value = 2.1824421548e+04
61 ds[a].unknown_sec = 0
62 ds[b].type = "GAUGE"
63 ds[b].minimal_heartbeat = 600
64 ds[b].min = NaN
65 ds[b].max = NaN
66 ds[b].last_ds = "UNKN"
67 ds[b].value = 3.9620838224e+03
68 ds[b].unknown_sec = 0
69 rra[0].cf = "AVERAGE"
70 rra[0].pdp_per_row = 1
71 rra[0].cdp_prep[0].value = nan
72 rra[0].cdp_prep[0].unknown_datapoints = 0
73 rra[0].cdp_prep[1].value = nan
74 rra[0].cdp_prep[1].unknown_datapoints = 0
76 =head1 ENVIRONMENT VARIABLES
78 The following environment variables may be used to change the behavior of
79 C<rrdtoolE<nbsp>info>:
81 =over 4
83 =item B<RRDCACHED_ADDRESS>
85 If this environment variable is set it will have the same effect as specifying
86 the C<--daemon> option on the command line. If both are present, the command
87 line argument takes precedence.
89 =back
91 =head1 AUTHOR
93 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>