Metadata-Version: 1.1
Name: check_docker
Version: 1.0.4
Summary: NRPE plugin for monitoring Docker containers
Home-page: https://github.com/timdaman/check_docker
Author: Tim Laurence
Author-email: timdaman@gmail.com
License: UNKNOWN
Download-URL: https://github.com/timdaman/check_docker/archive/master.zip
Description: |Build Status| |Code Climate| |Test Coverage|
        
        
        ============
        check_docker
        ============
        
        This a nagios/NRPE compatible plugin for checking docker containers. So far you
        can use it to check and alert on
        
        -  memory consumption in absolute units (bytes, kb, mb, gb) and as a percentage (0-100%)
           of the container limit.
        -  CPU usages as a percentage (0-100%) of container limit.
        -  automatic restarts performed by the docker daemon
        -  container status, i.e. is it running?
        -  container health checks are passing?
        -  uptime, i.e. is it able to stay running for a long enough time?
        -  the presence of a container or containers matching specified names
        -  image version (experimental!), does the running image match that in
           the remote registry?
        
        This check can communicate with a local docker daemon socket file (default) or with local
        or remote docker daemons using secure and non-secure TCP connections.
        
        This plugin requires python 3. It is tested on 3.3 and greater but may work on older
        versions of 3.
        
        Usage
        -----
        
        ::
        
          usage: check_docker [-h]
                              [--connection [/<path to>/docker.socket|<ip/host address>:<port>]
                              | --secure-connection [<ip/host address>:<port>]]
                              [--timeout TIMEOUT]
                              [--containers CONTAINERS [CONTAINERS ...]] [--present]
                              [--cpu WARN:CRIT] [--memory WARN:CRIT:UNITS]
                              [--status STATUS] [--health] [--uptime WARN:CRIT]
                              [--version] [--restarts WARN:CRIT]
        
          Check docker containers.
        
          optional arguments:
            -h, --help            show this help message and exit
            --connection [/<path to>/docker.socket|<ip/host address>:<port>]
                                  Where to find docker daemon socket. (default:
                                  /var/run/docker.sock)
            --secure-connection [<ip/host address>:<port>]
                                  Where to find TLS protected docker daemon socket.
            --timeout TIMEOUT     Connection timeout in seconds. (default: 10.0)
            --containers CONTAINERS [CONTAINERS ...]
                                  One or more RegEx that match the names of the
                                  container(s) to check. If omitted all containers are
                                  checked. (default: ['all'])
            --present             Modifies --containers so that each RegEx must match at
                                  least one container.
            --cpu WARN:CRIT       Check cpu usage percentage taking into account any
                                  limits. Valid values are 0 - 100.
            --memory WARN:CRIT:UNITS
                                  Check memory usage taking into account any limits.
                                  Valid values for units are %,b,k,m,g.
            --status STATUS       Desired container status (running, exited, etc).
                                  (default: None)
            --health              Check container's health check status
            --uptime WARN:CRIT    Minimum container uptime in seconds. Use when
                                  infrequent crashes are tolerated.
            --version             Check if the running images are the same version as
                                  those in the registry. Useful for finding stale
                                  images. Only works with public registry.
            --restarts WARN:CRIT  Container restart thresholds.
        
        Gotchas:
        
        - When using this with older versions of docker (I have seen 1.4 and 1.5) –status only supports ‘running’, ‘restarting’, and ‘paused’.
        - When no container is specified all containers are checked. Some containers will return critcal status because the selected check(s) require a running container.
        
        .. |Build Status| image:: https://travis-ci.org/timdaman/check_docker.svg?branch=master
           :target: https://travis-ci.org/timdaman/check_docker
        .. |Build Status2| image:: https://travis-ci.org/timdaman/check_docker.svg?branch=master
           :target: https://travis-ci.org/timdaman/check_docker
        .. |Code Climate| image:: https://codeclimate.com/github/timdaman/check_docker/badges/gpa.svg
           :target: https://codeclimate.com/github/timdaman/check_docker
        .. |Test Coverage| image:: https://codeclimate.com/github/timdaman/check_docker/badges/coverage.svg
           :target: https://codeclimate.com/github/timdaman/check_docker/coverage
        
Keywords: nrpe,nagios,docker,monitoring
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: System Administrators
Classifier: Environment :: Other Environment
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Networking
