centreon-plugins/cloud/docker/restapi/custom/api.pm

#
# Copyright 2017 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
# service performance.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

package cloud::docker::restapi::custom::api;

use strict;
use warnings;
use centreon::plugins::misc;
use centreon::plugins::http;
use JSON::XS;
use FileHandle;

sub new {
    my ($class, %options) = @_;
    my $self  = {};
    bless $self, $class;

    if (!defined($options{output})) {
        print "Class Custom: Need to specify 'output' argument.\n";
        exit 3;
    }
    if (!defined($options{options})) {
        $options{output}->add_option_msg(short_msg => "Class Custom: Need to specify 'options' argument.");
        $options{output}->option_exit();
    }

    if (!defined($options{noptions})) {
        $options{options}->add_options(arguments =>
                    {
                        "hostname:s@"   => { name => 'hostname' },
                        "port:s"        => { name => 'port', default => 8080 },
                        "proto:s"       => { name => 'proto' },
						"credentials"   => { name => 'credentials' },
						"username:s"    => { name => 'username' },
						"password:s"    => { name => 'password' },
						"proxyurl:s"    => { name => 'proxyurl' },
                        "proxypac:s"    => { name => 'proxypac' },
                        "timeout:s"     => { name => 'timeout', default => 10 },
                        "ssl:s"         => { name => 'ssl' },
                        "cert-file:s"   => { name => 'cert_file' },
                        "key-file:s"    => { name => 'key_file' },
                        "cacert-file:s" => { name => 'cacert_file' },
                        "cert-pwd:s"    => { name => 'cert_pwd' },
                        "cert-pkcs12"   => { name => 'cert_pkcs12' },
                        "api-display"       => { name => 'api_display' },
                        "api-write-file:s"  => { name => 'api_write_file' },
                        "api-read-file:s"   => { name => 'api_read_file' },
				    });
    }
    $options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1);

    $self->{output} = $options{output};
    $self->{mode} = $options{mode};

    return $self;

}

sub set_options {
    my ($self, %options) = @_;

    $self->{option_results} = $options{option_results};
}

sub set_defaults {
    my ($self, %options) = @_;

    foreach (keys %{$options{default}}) {
        if ($_ eq $self->{mode}) {
            for (my $i = 0; $i < scalar(@{$options{default}->{$_}}); $i++) {
                foreach my $opt (keys %{$options{default}->{$_}[$i]}) {
                    if (!defined($self->{option_results}->{$opt}[$i])) {
                        $self->{option_results}->{$opt}[$i] = $options{default}->{$_}[$i]->{$opt};
                    }
                }
            }
        }
    }
}

sub check_options {
    my ($self, %options) = @_;
    # return 1 = ok still hostname
    # return 0 = no hostname left

    $self->{hostname} = (defined($self->{option_results}->{hostname})) ? $self->{option_results}->{hostname} : undef;

    return 0 if (defined($self->{option_results}->{api_read_file}) && $self->{option_results}->{api_read_file} ne '');

    if (!defined($self->{hostname})) {
        $self->{output}->add_option_msg(short_msg => "Need to specify hostname option.");
        $self->{output}->option_exit();
    }
    $self->{http} = {};
    foreach my $node_name (@{$self->{hostname}}) {
        if ($node_name ne '') {
            $self->{http}->{$node_name} = centreon::plugins::http->new(output => $self->{output});
            $self->{options_results}->{hostname} = $node_name;
            $self->{http}->{$node_name}->set_options(%{$self->{option_results}});
        }
    }

    return 0;
}

sub api_display {
    my ($self, %options) = @_;
    
    if (defined($self->{option_results}->{api_display})) {
        if (!defined($self->{option_results}->{api_write_file}) || $self->{option_results}->{api_write_file} eq '') {
            $self->{output}->output_add(severity => 'OK',
                                        short_msg => $options{content});
            $self->{output}->display(nolabel => 1, force_ignore_perfdata => 1, force_long_output => 1);
            $self->{output}->exit();
        }
        
        if (!open (FH, '>', $self->{option_results}->{api_write_file})) {
            $self->output_add(severity => 'UNKNOWN',
                              short_msg => "cannot open file  '" . $self->{option_results}->{api_write_file} . "': $!");
            
        }
        
        FH->autoflush(1);
        print FH $options{content};
        close FH;
        $self->output_add(severity => 'OK',
                          short_msg => "Data written in file '" . $self->{option_results}->{api_write_file} . "': $!");
        $self->{output}->exit();
    }
}

sub api_read_file {
    my ($self, %options) = @_;
    
    my $file_content = do {
        local $/ = undef;
        if (!open my $fh, "<", $self->{option_results}->{api_read_file}) {
            $self->{output}->add_option_msg(short_msg => "Could not open file $self->{option_results}->{api_read_file} : $!");
            $self->{output}->option_exit();
        }
        <$fh>;
    };
    
    my $content;
    eval {
        $content = JSON::XS->new->utf8->decode($file_content);
    };
    if ($@) {
        $self->{output}->add_option_msg(short_msg => "Cannot decode json response: $@");
        $self->{output}->option_exit();
    }
    
    return $content;
}

sub internal_api_list_containers {
    my ($self, %options) = @_;
    
    my $response = $self->{http}->{$options{node_name}}->request(
        url_path => '/containers/json?all=true',
        critical_status => '', warning_status => '');
    my $containers;
    eval {
        $containers = JSON::XS->new->utf8->decode($response);
    };
    if ($@) {
        $containers = [];
        $self->output_add(severity => 'UNKNOWN',
                         short_msg => "Node '$options{node_name}': cannot decode json get containers response: $@");
    }
    
    return $containers;
}

sub internal_api_get_container_stats {
    my ($self, %options) = @_;
    
    my $response = $self->{http}->{$options{node_name}}->request(
        url_path => '/containers/' . $options{container_id} . '/stats?stream=false',
        critical_status => '', warning_status => '');
    my $container_stats;
    eval {
        $container_stats = JSON::XS->new->utf8->decode($response);
    };
    if ($@) {
        $container_stats = {};
        $self->output_add(severity => 'UNKNOWN',
                          short_msg => "Node '$options{node_name}': cannot decode json get container stats response: $@");
    }
    
    return $container_stats;
}

sub api_get_containers {
    my ($self, %options) = @_;

    if (defined($self->{option_results}->{api_read_file}) && $self->{option_results}->{api_read_file} ne '') {
        return $self->api_read_file();
    }
    
    my $content_total = {};
    foreach my $node_name (keys %{$self->{http}}) {
        my $containers = $self->internal_api_list_containers(node_name => $node_name);
        foreach my $container (@$containers) {
            $content_total->{$container->{Id}} = {
                State => $container->{State},
                NodeName => $node_name,
                Name => join(':', @{$container->{Names}}),
            };
            $content_total->{$container->{Id}}->{Stats} = $self->internal_api_get_container_stats(node_name => $node_name, container_id => $container->{Id});
        }
    }
    
    return $content_total;
}

1;

__END__

=head1 NAME

Docker REST API

=head1 SYNOPSIS

Docker Rest API custom mode

=head1 REST API OPTIONS

=over 8

=item B<--hostname>

IP Addr/FQDN of the docker node (can be multiple).

=item B<--port>

Port used (Default: 8080)

=item B<--proto>

Specify https if needed (Default: 'http')

=item B<--credentials>

Specify this option if you access webpage over basic authentification

=item B<--username>

Specify username for basic authentification (Mandatory if --credentials is specidied)

=item B<--password>

Specify password for basic authentification (Mandatory if --credentials is specidied)

=item B<--proxyurl>

Proxy URL

=item B<--proxypac>

Proxy pac file (can be an url or local file)

=item B<--timeout>

Threshold for HTTP timeout (Default: 10)

=item B<--ssl>

Specify SSL version (example : 'sslv3', 'tlsv1'...)

=item B<--cert-file>

Specify certificate to send to the webserver

=item B<--key-file>

Specify key to send to the webserver

=item B<--cacert-file>

Specify root certificate to send to the webserver

=item B<--cert-pwd>

Specify certificate's password

=item B<--cert-pkcs12>

Specify type of certificate (PKCS12)

=item B<--api-display>

Print json api.

=item B<--api-write-display>

Print json api in a file (to be used with --api-display).

=item B<--api-read-file>

Read API from file.

=back

=head1 DESCRIPTION

B<custom>.

=cut