RRDcached patch. This implements an infrastructure, where rrd updates can be
[rrdtool.git] / doc / rrdlastupdate.pod
1 =head1 NAME
2
3 rrdlastupdate - Return the most recent update to an RRD
4
5 =head1 SYNOPSIS
6
7 B<rrdtool> B<lastupdate> I<filename>
8 S<[B<--daemon> I<address>]>
9
10 =head1 DESCRIPTION
11
12 The B<lastupdate> function returns the UNIX timestamp and the 
13 value stored for each datum in the most recent update of an RRD.
14
15 =over 8
16
17 =item I<filename>
18
19 The name of the B<RRD> that contains the data.
20
21 =item B<--daemon> I<address>
22
23 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
24 to the server before reading the RRD files. This allows B<rrdtool> to return
25 fresh data even if the daemon is configured to cache values for a long time. To
26 specify a UNIX domain socket use the prefix C<unix:>, see example below. Other
27 addresses are interpreted as normal network addresses, i.E<nbsp>e. IPv4 or IPv6
28 addresses in most cases.
29
30  rrdtool lastupdate --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
31
32 =back
33
34 =head1 ENVIRONMENT VARIABLES
35
36 The following environment variables may be used to change the behavior of
37 C<rrdtoolE<nbsp>lastupdate>:
38
39 =over 4
40
41 =item B<RRDCACHED_ADDRESS>
42
43 If this environment variable is set it will have the same effect as specifying
44 the C<--daemon> option on the command line. If both are present, the command
45 line argument takes precedence.
46
47 =back
48
49 =head1 AUTHOR
50
51 Andy Riebs E<lt>andy.riebs@hp.comE<gt>
52
53
54