/ 
Monitor-MetricsAPI-0.900
River stage zero No dependents
/ Monitor::MetricsAPI::Metric::Callback

NAME

Monitor::MetricsAPI::Metric::Callback - Callback metric class for Monitor::MetricsAPI

SYNOPSIS

use Monitor::MetricsAPI;
use DateTime;

# Put into scope first so we can capture it as part of the callback sub.
my $collector;
$collector = Monitor::MetricsAPI->new(
    metrics => {
        process  => {
            started => 'timestamp'
        },
        messages => {
            incoming => {
                total   => 'counter',
                per_min => sub {
                    $collector->metric('messages/incoming/total')->value
                    /
                    DateTime->now()->delta_ms(
                        $collector->metric('process/started')->dt
                    )->in_units('minutes')
                },
            }
        }
    }
);

$collector->metric('process/started')->now;

DESCRIPTION

Boolean metrics allow you to track the true/false/unknown state of something in your application. All boolean metrics are initialized as unknown and must be explicitly set to either true or false.

METHODS

Callback metrics do not provide any additional methods not already offered by Monitor::MetricsAPI::Metric. You may call the set() method at any time to updated the callback function that will be used when the metric is displayed.

callback (sub { ... })

Allows you to provide a new subroutine to be invoked for the callback metric.

value

Overrides the value() method provided by the base Metric class. Invoking this method will run the callback subroutine. For expensive callbacks, you are very strongly advised to consider incorporating some reasonable caching mechanism so that unnecessary computations can be avoided during metrics reporting.

AUTHORS

Jon Sime <jonsime@gmail.com>

LICENSE AND COPYRIGHT

This software is copyright (c) 2015 by OmniTI Computer Consulting, Inc.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.