File Coverage

blib/lib/Net/Async/Graphite.pm

Criterion	Covered	Total	%
statement	14	14	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod			n/a
total	19	19	100.0

package Net::Async::Graphite;

our $VERSION = '0.1_1';

=head1 NAME

Net::Async::Graphite - Request data from graphite

=head1 SYNOPSIS

  use Net::Async::Graphite;

  my $graphite = Net::Async::Graphite->new(
      endpoint => 'https://graphite.example.com/',
  );

  # Find (requires graphite-api)
  my $metrics = $graphite->metrics_asperl('foo.*.datum')->get;

  # Download
  my $data = $graphite->render_asperl('foo.*.datum')->get;

  # Draw
  my $png = $graphite->render(png => 'foo.*.datum')->get;
  # or my $png = $graphite->png('foo.*.datum')->get;

  # Draw with gnuplot (requires gnuplot)
  my $ascii = $graphite->plot('foo.*.datum')->get;
  print $ascii;

=head1 DESCRIPTION

An interface to Graphite's data-request APIs graphite-web and
graphite-api (which include's graphite-web's /render API).

Preliminary support exists in this version for most of the
functionality of C, C, C and
C which is described in detail in
L.

There is also support to pass the raw data obtained from C
into gnuplot, which includes the ability to format it for terminal
output. This support will probably be made optional at some point or
maybe split into its own package.

=head1 BUGS

No attempt is made to configure a timeout for the HTTP request.

See individual components for their bugs that I know about.

=cut

use v5.14;
use strictures 2;
use Moo;
use Carp;

use namespace::clean;

=head1 OBJECT

Net::Async::Graphite is an object built from individual roles using
L. It uses L internally to provide an asynchronous
interface to the remote API and so all methods return a L
object.

If you don't know about L or don't want to, you must only
remember to call C on the return value of any
L method:

    my $data_when_it_comes = $graphite->render('me.tr.ic');
    ...; # Later
    my $data_finally = $data_when_it_comes->get();

    # or

    my $data_now = $graphite->render('me.tr.ic')->get();

L's API consists of all of the methods,
attributes and accessors defined in its roles (and theirs (and theirs
(etc.))) which do not begin with an C<_>. Being perl you are welcome
to use these private methods, and even dig around inside the object's
guts if you wish, but they do not constitute any part of the stable[*]
API. You are thus also welcome to deal with the ensuing breakage.

[*] Hahaha.

L's functionality comes from these roles:

=over

=item L

Interface between perl and Graphite's APIs (C and
C). Of most interest are:

=begin comment

usename and password don't both need a description but then it looks silly.

=end comment

=over

=item username

Mixed in by L.

=item password

Mixed in by L.

=item endpoint

=item metrics()

=item render()

=item find_target_from_spec()

=back

=item L

Render data in various ways after it has been downloaded. Note that
Graphite's C API include its own drawing routines which are
not related to or affected by this role. This role uses data obtained
from C API call with C; the relationship ends
there.

Of most interest are:

=over

=item last_value()

=item plot()

=back

=cut

with 'Net::Async::Graphite::API';

with 'Net::Async::Graphite::Draw';

=back

=head1 ATTRIBUTES

I don't know if I want these.

=over

=item default_from

=item default_until

Default values for C and C URI parameters.

=cut

has default_from => is => rw => predicate => 1;

has default_until => is => rw => predicate => 1;

1;

=back

=head1 SEE ALSO

L

L

L

L

L

=head1 AUTHOR

Matthew King

=cut