madvise hints may not be ORed since they are enumerated ... #224
[rrdtool.git] / bindings / perl-shared / RRDs.pm
1 package RRDs;
2
3 use strict;
4 use vars qw(@ISA $VERSION);
5
6 @ISA = qw(DynaLoader);
7
8 require DynaLoader;
9
10 $VERSION=1.3002;
11
12 bootstrap RRDs $VERSION;
13
14 1;
15 __END__
16
17 =head1 NAME
18
19 RRDs - Access RRDtool as a shared module
20
21 =head1 SYNOPSIS
22
23   use RRDs;
24   RRDs::error
25   RRDs::last ...
26   RRDs::info ...
27   RRDs::create ...
28   RRDs::update ...
29   RRDs::updatev ...
30   RRDs::graph ...
31   RRDs::fetch ...
32   RRDs::tune ...
33   RRDs::times(start, end)
34   RRDs::dump ...
35   RRDs::restore ...
36   RRDs::flushcached ...
37
38 =head1 DESCRIPTION
39
40 =head2 Calling Sequence
41
42 This module accesses RRDtool functionality directly from within Perl. The
43 arguments to the functions listed in the SYNOPSIS are explained in the regular
44 RRDtool documentation. The command line call
45
46  rrdtool update mydemo.rrd --template in:out N:12:13
47
48 gets turned into
49
50  RRDs::update ("mydemo.rrd", "--template", "in:out", "N:12:13");
51
52 Note that
53
54  --template=in:out
55
56 is also valid.
57
58 The RRDs::times function takes two parameters:  a "start" and "end" time.
59 These should be specified in the B<AT-STYLE TIME SPECIFICATION> format
60 used by RRDtool.  See the B<rrdfetch> documentation for a detailed
61 explanation on how to specify time.
62
63 =head2 Error Handling
64
65 The RRD functions will not abort your program even when they can not make
66 sense out of the arguments you fed them.
67
68 The function RRDs::error should be called to get the error status
69 after each function call. If RRDs::error does not return anything
70 then the previous function has completed its task successfully.
71
72  use RRDs;
73  RRDs::update ("mydemo.rrd","N:12:13");
74  my $ERR=RRDs::error;
75  die "ERROR while updating mydemo.rrd: $ERR\n" if $ERR;
76
77 =head2 Return Values
78
79 The functions RRDs::last, RRDs::graph, RRDs::info, RRDs::fetch and RRDs::times
80 return their findings.
81
82 B<RRDs::last> returns a single INTEGER representing the last update time.
83
84  $lastupdate = RRDs::last ...
85
86 B<RRDs::graph> returns an ARRAY containing the x-size and y-size of the
87 created image and a pointer to an array with the results of the PRINT arguments.
88
89  ($result_arr,$xsize,$ysize) = RRDs::graph ...
90  print "Imagesize: ${xsize}x${ysize}\n";
91  print "Averages: ", (join ", ", @$averages);
92
93 B<RRDs::info> returns a pointer to a hash. The keys of the hash
94 represent the property names of the RRD and the values of the hash are
95 the values of the properties.  
96
97  $hash = RRDs::info "example.rrd";
98  foreach my $key (keys %$hash){
99    print "$key = $$hash{$key}\n";
100  }
101
102 B<RRDs::graphv> takes the same parameters as B<RRDs::graph> but it returns a
103 pointer to hash. The hash returned contains meta information about the
104 graph. Like its size as well as the position of the graph area on the image.
105 When calling with and empty filename than the contents of the graph will be
106 returned in the hash as well (key 'image').
107
108 B<RRDs::updatev> also returns a pointer to hash. The keys of the hash
109 are concatenated strings of a timestamp, RRA index, and data source name for
110 each consolidated data point (CDP) written to disk as a result of the
111 current update call. The hash values are CDP values.
112
113 B<RRDs::fetch> is the most complex of
114 the pack regarding return values. There are 4 values. Two normal
115 integers, a pointer to an array and a pointer to a array of pointers.
116
117   my ($start,$step,$names,$data) = RRDs::fetch ... 
118   print "Start:       ", scalar localtime($start), " ($start)\n";
119   print "Step size:   $step seconds\n";
120   print "DS names:    ", join (", ", @$names)."\n";
121   print "Data points: ", $#$data + 1, "\n";
122   print "Data:\n";
123   for my $line (@$data) {
124     print "  ", scalar localtime($start), " ($start) ";
125     $start += $step;
126     for my $val (@$line) {
127       printf "%12.1f ", $val;
128     }
129     print "\n";
130   }
131
132 B<RRDs::times> returns two integers which are the number of seconds since
133 epoch (1970-01-01) for the supplied "start" and "end" arguments, respectively.
134
135 See the examples directory for more ways to use this extension.
136
137 =head1 NOTE
138
139 If you are manipulating the TZ variable you should also call the POSIX
140 function L<tzset(3)> to initialize all internal state of the library for properly
141 operating in the timezone of your choice.
142
143  use POSIX qw(tzset);
144  $ENV{TZ} = 'CET';   
145  POSIX::tzset();     
146
147
148 =head1 AUTHOR
149
150 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
151
152 =cut