NAME

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

SYNOPSIS

    use Monitor::MetricsAPI;

    my $collector = Monitor::MetricsAPI->new(
        metrics => { protocols => { ssl { enabled => 'boolean' } } }
    );

    # Later on, when your app validates its config and turns on SSL:
    $collector->metric('protocols/ssl/enabled')->true;

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

Boolean metrics disable the set() method from Monitor::MetricsAPI::Metric (a warn() is emitted and no action is taken), and provide only the following methods for manipulating their values.

true

Sets the metric to true.

false

Sets the metric to false.

unknown

Sets the metric to unknown (will emit a blank value in reporting output).

set

Overrides the set() method provided by the base Metric class. Emits a warning whenever called, and performs no other actions.

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.