NAME

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

SYNOPSIS

    use Monitor::MetricsAPI;

    my $collector = Monitor::MetricsAPI->new(
        metrics => { process => { threads => 'gauge' } }
    );

    # Later on, when your application modifies its worker thread pool:
    $collector->metric('process/threads')->set(4);

DESCRIPTION

Gauge counters are numeric metrics providing an arbitrary point-in-time value. Gauges may increase and decrease, and may do either by varying amounts each time. They are useful for tracking things like current memory usage, number of child threads or processes, temperature of a sensor, and any other arbitrary values of interest.

All gauges are initialized at zero, but may be set to any numeric value even negative values.

METHODS

Gauge metrics do not provide any additional methods beyond the base methods offered by Monitor::MetricsAPI::Metric.

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.