File Coverage

blib/lib/Uninets/Check/Modules/Redis.pm

Criterion	Covered	Total	%
statement	24	53	45.2
branch	0	2	0.0
condition			n/a
subroutine	8	17	47.0
pod	2	4	50.0
total	34	76	44.7

package Uninets::Check::Modules::Redis;

use 5.10.1;
use strict;
use warnings FATAL => 'all';
use Moo;
use Getopt::Long qw(GetOptionsFromArray);
use Redis;
use Try::Tiny;
use JSON;

=head1 NAME

Uninets::Check::Modules::Redis - Uninets::Check module to check redis servers.

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.02';


=head1 SYNOPSIS

Uninets::Check::Modules::Redis can check used memory and reachability of redis servers.

	# to show available information on parameters run
	unicheck --info Redis

=cut

sub run {
	my ($self, $action, @params) = @_;

	$self->$action(@params);
}

=head1 ACTIONS

=head2 reachable

Check if the server is reachable.

	# check default localhost:6379
	unicheck Redis reachable

	# check specific host:port
	unicheck Redis reachable --host example.com --port 1234

=cut

sub reachable {
	my ($self, @params) = @_;

	my $host = '127.0.0.1';
	my $port = 6379;
	my $format = 'num';

	GetOptionsFromArray([@params],
		'port=i' => \$port,
		'host=s' => \$host,
		'format=s' => \$format,
	);

	my $retval;
	try {
		Redis->new(server => "$host:$port");
		$retval = $self->_return(1, 'Connection successful', $format);
	} catch {
		$retval = $self->_return(0, $_, $format);
	};

	$retval;
}

=head2 size

Get the size redis uses in memory.

	unicheck Redis size

=cut

sub size {
	my ($self, @params) = @_;

	my $host = '127.0.0.1';
	my $port = 6379;
	my $format = 'num';

	GetOptionsFromArray([@params],
		'port=i' => \$port,
		'host=s' => \$host,
		'format=s' => \$format,
	);

	my $size = 0;
	my $retval;
	try {
		$size = Redis->new(server => "$host:$port")->info->{used_memory};
		$retval = $self->_return($size, $size, $format);
	} catch {
		$retval = $self->_return(-1, $_, $format);
	};

	$retval;
}

sub _return {
	my ($self, $status, $value, $format) = @_;

	return JSON->new->encode(
		{
			message => $value,
			status  => $status,
		}
	) if $format eq 'json';
	# default last in case some non supported format was given
	return $status; # if $format eq 'num'
}

sub help {
	{
		description => 'Check redis status',
		actions => {
			reachable => {
				description => 'Check if redis server is reachable',
				params => {
					'--host' => 'Default: 127.0.0.1',
					'--port' => 'Default: 6379',
					'--format' => 'Default: num',
				},
				formats => {
					'num'  => 'Returns the status code',
					'json' => 'Returns a JSON structure',
				},
			},
			size => {
				description => 'Check redis RAM consumption',
				params => {
					'--host' => 'Default: 127.0.0.1',
					'--port' => 'Default: 6379',
					'--format' => 'Default: num',
				},
				formats => {
					'num'  => 'Returns the size in bytes',
					'json' => 'Returns a JSON structure',
				},
			},
		},
	}
}

=head1 AUTHOR

Matthias Krull, C<< <> >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.




=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Uninets::Check::Modules::Redis


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2013 Matthias Krull.

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


=cut

1; # End of Uninets::Check::Modules::Redis