GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  POE::COMPONENT::RRDTOOL (3)

.ds Aq ’

NAME

POE::Component::RRDTool - POE interface to Tobias Oetiker’s RRDtool

CONTENTS

SYNOPSIS



  use POE qw( Component::RRDTool );

  my $alias = controller;

  my @create_args = qw(
      test.rrd
      --start now
      --step 30
      DS:X:GAUGE:60:0:10
      RRA:MAX:0.5:1:1
  );

  # start up the rrdtool component
  POE::Component::RRDTool->new( 
      Alias      => $alias,
      RRDtool    => /usr/local/bin/rrdtool,
      ErrorEvent => rrd_error,
      StatusEvent=> rrd_status,
  );

  POE::Session->create(
      inline_states => {
          _start => sub {
               # set a session alias so that we can receive events from RRDtool
               $_[KERNEL]->alias_set($_[ARG0]);

               # create a round robin database
               $_[KERNEL]->post( rrdtool, create, @create_args );

               # stop the rrdtool component
               $_[KERNEL]->post( rrdtool, stop );
          },
          rrd_error => sub {
              print STDERR "ERROR: " . $_[ARG0] . "\n";
          },
          rrd_status => sub {
               my ($user, $system, $real) = @_[ARG0 .. ARG2];
               print "u: $user\ts: $system\tr: $real\n";
          },
      },
      args => [ $alias ],
  );

  $poe_kernel->run();



DESCRIPTION

RRDtool refers to round robin database tool. Round robin databases have a fixed number of data points in them and contain a pointer to the current element. Since the databases have a fixed number of data points the database size doesn’t change after creation. RRDtool allows you to define a set of archives which consolidate the primary data points in higher granularity. RRDtool is specialized for time series data and can be used to create RRD files, update RRDs, retreive data from RRDs, and generate graphs from the databases. This module provides a POE wrapper around the rrdtool command line interface.

METHODS

<B>newB> - creates a POE RRDTool component new() is the constructor for POE::Component::RRDTool. The constructor is POE::Component::RRDTool’s only public method. It has two optional named parameters <B>aliasB> and <B>rrdtoolB>.

The <B>aliasB> parameter is the alias of the session that the POE::Component::RRDTool instance will send events to as callbacks. It defaults to <B>componentB>. It is important to understand that an RRDTool instance ALWAYS uses the <B>rrdtoolB> alias to reference itself. Events are posted to the rrdtool alias and callbacks are posted to the alias set via the constructor.

The <B>rrdtoolB> parameter is the name of the RRDtool command line utility. It defaults to /usr/local/bin/rrdtool or the location that was found when building and installing on your system. You can use the <B>rrdtoolB> parameber to override this default location.

In the calling convention below the []s indicate optional parameters.



  POE::Component::RRDTool->new(
      [-alias       => controller],
      [-rrdtool     => /usr/local/bin/rrdtool],
      [-errorevent  => error_handler],
      [-statusevent => status_handler],
  );



EVENTS

POE::Component::RRDTool events take the same parameters as their rrdtool counterpart. Use the RRDtool manual as a reference for rrdtool command parameters.

The following events can be posted to an RRDtool component.
<B>createB> - create a round robin database


  my @create_args = qw(
      test.rrd
      --start now
      --step 30
      DS:X:GAUGE:60:0:10
      RRA:MAX:0.5:1:1
  );

  $_[KERNEL]->post( qw( rrdtool create ), @create_args);



<B>updateB> - update a round robin database


  $_[KERNEL]->post( qw( rrdtool update test.rrd N:1 ) );



<B>fetchB> - fetch data from a RRD


  my $callback = rrd_fetch_handler;

  my @fetch_args = qw(
      test.rrd
      MAX
      --start -1s
  );

  $_[KERNEL]->post( qw( rrdtool fetch ), $callback, @fetch_args );



<B>graphB> - generate a graph image from RRDs


  my $callback = rrd_graph_handler;

  my @graph_args = (
      graph.png,
      --start, -86400,
      --imgformat, PNG,
      DEF:x=test.rrd:X:MAX,
      CDEF:y=1,x,+,
      PRINT:y:MAX:%lf,
      AREA:x#00FF00:test_data,
  );

  $_[KERNEL]->post( qw( rrdtool udpate ), $callback, @graph_args );

  sub rrd_graph_handler {
      my $graph = $_[ARG0];
      printf("Image Size: %dx%d\n", $graph->{xsize}, $graph->{ysize});
      printf("PRINT output: %s\n", join(\n, @$graph->{output}) if @$graph;
      print "graph.png was created" if -e "graph.png";
      warn "no image was created" unless -e "graph.png";
  }



<B>infoB> - get information about a RRD


  my $callback = rrd_info_handler;

  $_[KERNEL]->post( qw( rrdtool info ), $callback, test.rrd );



<B>xportB> - generate xml reports from RRDs


  my $callback = rrd_xport_handler;

  my @xport_args = (
    --start, -300,
    --step, 300,
    DEF:x=test.rrd:X:MAX,
    XPORT:x:foobar,
  );

  $_[KERNEL]->post( qw( rrdtool xport ), $callback, @xport_args );



<B>dumpB> - dump a RRD in XML format


  my $callback = rrd_dump_handler;

  $_[KERNEL]->post( qw( rrdtool dump ), $callback, test.rrd );



<B>stopB> - stop an RRDTool component


  $_[KERNEL]->post( qw( rrdtool stop ) );



CALLBACKS

The callbacks listed below are sent by the RRDTool component to the session alias passed to it’s constructor. You can provide event handlers for them in the controlling session’s constructor. However it is not required to handle any of the callbacks.
<B>rrd_statusB> - notification of rrdtool runtimes Returns the user, system, and real time of the rrdtool process in ARG0, ARG1, and ARG2 respectively. This event name can be overriden by using the StatusEvent parameter to POE::Component::RRDTool->new();



  POE::Session->create(
    inline_states => {
      rrd_status => sub {
        my ($user, $system, $real) = @_[ARG0 .. ARG2];
        print "u: $user\ts: $system\tr: $real\n";
      },
      ....,
    }
  );



<B>rrd_errorB> - rrdtool error notification Returns error messages returned from rrdtool in ARG0.



  POE::Session->create(
    inline_states => {
      rrd_error => sub {
        my $error = $_[ARG0];
        print "Error: $error\n";
      },
      ....,
    }
  );



<B>rrd_stoppedB> - rrdtool process stopped This callback provides a hook to do something when the rrdtool process is stopped.



  POE::Session->create(
    inline_states => {
      rrd_stopped => sub {
        print "rrdtool stopped\n";
      },
      ....,
    }
  );



AUTHOR

Todd Caine <todd@pobox.com>

SEE ALSO

An RRDtool Tutorial http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/tutorial/rrdtutorial.html

The Main RRDtool Website http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/index.html

The RRDtool Manual http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/manual/index.html

TROUBLESHOOTING

The rrdtool command line utility does not support the xport subcommand until version 1.0.38. If you try to use the xport event using an older version of rrdtool you will receive an rrdtool usage message as an rrd_error callback.

BUGS

The rrdtool command line utility is being controlled by POE::Wheel::Run. I’m increasing the block size on the POE::Driver::SysRW instance used for the rrdtool output so that each command generates only one event. This should probably be fixed by using the default block size and a custom filter instead.

If you notice that more than one event is being generated from a single rrdtool command you may need to increase the blocksize used.

COPYRIGHT AND LICENSE

Copyright (c) 2003 Todd Caine. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 RRDTOOL (3) 2005-05-10

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.