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