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.2005;
  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
  35 =head1 DESCRIPTION
  36
  37 =head2 Calling Sequence
  38
  39 This module accesses RRDtool functionality directly from within perl. The
  40 arguments to the functions listed in the SYNOPSIS are explained in the regular
  41 RRDtool documentation. The commandline call
  42
  43  rrdtool update mydemo.rrd --template in:out N:12:13
  44
  45 gets turned into
  46
  47  RRDs::update ("mydemo.rrd", "--template", "in:out", "N:12:13");
  48
  49 Note that
  50
  51  --template=in:out
  52
  53 is also valid.
  54
  55 The RRDs::times function takes two parameters:  a "start" and "end" time.
  56 These should be specified in the B<AT-STYLE TIME SPECIFICATION> format
  57 used by RRDtool.  See the B<rrdfetch> documentation for a detailed
  58 explanation on how to specify time.
  59
  60 =head2 Error Handling
  61
  62 The RRD functions will not abort your program even when they can not make
  63 sense out of the arguments you fed them.
  64
  65 The function RRDs::error should be called to get the error status
  66 after each function call. If RRDs::error does not return anything
  67 then the previous function has completed its task successfully.
  68
  69  use RRDs;
  70  RRDs::update ("mydemo.rrd","N:12:13");
  71  my $ERR=RRDs::error;
  72  die "ERROR while updating mydemo.rrd: $ERR\n" if $ERR;
  73
  74 =head2 Return Values
  75
  76 The functions RRDs::last, RRDs::graph, RRDs::info, RRDs::fetch and RRDs::times
  77 return their findings.
  78
  79 B<RRDs::last> returns a single INTEGER representing the last update time.
  80
  81  $lastupdate = RRDs::last ...
  82
  83 B<RRDs::graph> returns an pointer to an ARRAY containing the x-size and y-size of the
  84 created image and results of the PRINT arguments.
  85
  86  ($averages,$xsize,$ysize) = RRDs::graph ...
  87  print "Imagesize: ${xsize}x${ysize}\n";
  88  print "Averages: ", (join ", ", @$averages);
  89
  90 B<RRDs::info> returns a pointer to a hash. The keys of the hash
  91 represent the property names of the RRD and the values of the hash are
  92 the values of the properties.
  93
  94  $hash = RRDs::info "example.rrd";
  95  foreach my $key (keys %$hash){
  96    print "$key = $$hash{$key}\n";
  97  }
  98
  99 B<RRDs::updatev> also returns a pointer to hash. The keys of the hash
 100 are concatenated strings of a timestamp, RRA index, and data source name for
 101 each consolidated data point (CDP) written to disk as a result of the
 102 current update call. The hash values are CDP values.
 103
 104 B<RRDs::fetch> is the most complex of
 105 the pack regarding return values. There are 4 values. Two normal
 106 integers, a pointer to an array and a pointer to a array of pointers.
 107
 108   my ($start,$step,$names,$data) = RRDs::fetch ...
 109   print "Start:       ", scalar localtime($start), " ($start)\n";
 110   print "Step size:   $step seconds\n";
 111   print "DS names:    ", join (", ", @$names)."\n";
 112   print "Data points: ", $#$data + 1, "\n";
 113   print "Data:\n";
 114   foreach my $line (@$data) {
 115     print "  ", scalar localtime($start), " ($start) ";
 116     $start += $step;
 117     foreach my $val (@$line) {
 118       printf "%12.1f ", $val;
 119     }
 120     print "\n";
 121   }
 122
 123 B<RRDs::times> returns two integers which are the number of seconds since
 124 epoch (1970-01-01) for the supplied "start" and "end" arguments, respectively.
 125
 126 See the examples directory for more ways to use this extension.
 127
 128 =head1 NOTE
 129
 130 If you are manipulating the TZ variable you should also call the posixs
 131 function tzset to initialize all internal state of the library for properly
 132 operating in the timezone of your choice.
 133
 134  use POSIX qw(tzset);
 135  $ENV{TZ} = 'CET';
 136  POSIX::tzset();
 137
 138
 139 =head1 AUTHOR
 140
 141 Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
 142
 143 =cut