sensu-plugins-docker 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5d47d0604805095860811b66cc120009fc1cb61b05927986499c6db4a6bb420
-  data.tar.gz: 500444a84707e89a229aad4fbdfd3b0529df2a6b20e40d56e01aff9560bd87f3
+  metadata.gz: 00d6b43c8b66736073dd792abffe2d13f99034f0981795bf21663412ec64865e
+  data.tar.gz: 3f1fd2aedfcd7ac02eb06a8f5656b3527d670ef77fc61d192901b5d78770af37
 SHA512:
-  metadata.gz: 8d9b0ae9d2e34e33a54b19a4f8685b4cc6cdaad21de250cd195f83344876185c0fea9c79beee05082962d1388c6447c3e1095eb140945bf93d6a6ea259b83ae6
-  data.tar.gz: 96728604303b452f6d8955d56c3e537c9ab3260c0805c91b6605e77b9987282b66ecb55f2ff7fb9651b04f8dbe31dbf31f75b30e7e694321da084c4f8b64e766
+  metadata.gz: 58a4c4cf16098e2e57d0b28b38e6061b842d54df4deecca9c4e08f0bbca288541ac4faf095801b5f33627438aa56d2d4db01d99a7170e3f05cb8ec4a5225654f
+  data.tar.gz: 57fcb788326eee5cdb4a4df9aa731637f7407b8d51eacd901da12d1573e035c4f060884304bb00478a6ba48f35aae3610107c10429a43982fbed85bd3990e369

data/CHANGELOG.md

@@ -6,6 +6,36 @@ Which is based on [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [3.0.0] - 2018-02-17
+### Breaking Changes
+- Default docker host defined by DockerApi Class ( ENV[DOCKER_URL] => ENV[DOCKER_HOST] => /var/run/docker.sock )
+- check-container-logs.rb: -N (--container-name) instead of -n for container name. Now a 'CRITICAL' is trigger if a container doesn't exist (previously, a 'OK' was trigger)
+- check-docker-container.rb: -H (--docker-host) instead of -h (--host) for docker Host
+- check-container.rb: -H (--docker-host) for docker Host instead of -h (--host) for docker host, -N (--container-name) instead of -c (--container) for container name
+- metrics-docker-stats.rb: -N (--container-name) instead of -c (--container) for Container name
+
+### Added
+- client_helpers.rb: Add a simple DockerApi class. Add parse_json method.
+- metrics-docker-container.rb: Friendly names option added
+- check-container-logs.rb: Add an option to check logs from stopped containers if all containers are checked. Add an option to don't check stderr logs. Add an option to don't check stdout logs. Add timestamp in logs output. Add the possibility to use -n multiple times to check multiple containers at once.
+
+### Changed
+- metrics-docker-stats.rb: Make use of DockerApi class. Default docker_host defined by DockerApi class. Remove docker_api method.
+- metrics-docker-info.rb: Make use of DockerApi class. Default docker_host defined by DockerApi class. Remove docker_api method.
+- metrics-docker-container.rb: Make use of DockerApi class. Re-enable rubocop for container_metrics method.
+- check-container.rb: Make use of DockerApi class.
+- check-docker-container.rb: Make use of DockerApi class.
+- check-container-logs.rb: Make use of DockerApi class. Check only logs generated with the 8 bits control to prevent to check logs generated in interactive mode. Check the newest logs rows first instead the oldest. Option -n is not required anymore, if -n option is not provided, the check will be applied to all running containers. Changed the messages displayed with ok and critical
+
+### Fixed
+- metrics-docker-stats.rb: Remove trailing / in name value.
+
+### Removed
+- Remove unnecessary `docker_api` dependency
+- check-container-logs.rb: Logs generated in interactive mode are not checked anymore
+- metrics-docker-stats.rb: option -p (--protocol) have been removed because new DockerApi don't use it
+- metrics-docker-info.rb: option -p (--protocol) have been removed because new DockerApi don't use it
+
 ## [2.0.0] - 2017-11-06
 ### Fixed
 - metrics-docker-stats.rb:: Fix gsub on nil docker environment variable (@epierotto)
@@ -111,7 +141,8 @@ changes some options. Review your check commands before deploying this version.
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/2.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/2.0.0...3.0.0
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.5.0...2.0.0
 [1.5.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.4.0..1.5.0
 [1.4.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.3.1...1.4.0

data/README.md

@@ -19,6 +19,15 @@ This check supports docker versions >= 1.18. Check docker-engine API for more in
 
 ## Usage
 
+### Default docker host
+By default, all the checks will try to use a default docker host if a specific docker host is not provided to the check on the command line (-H <docker_host> / --docker-host <docker_host>).
+
+Those paramaters will be tried in this order as default docker host :
+
+    DOCKER_URL environnement variable
+    DOCKER_HOST environnement variable
+    /var/run/docker.sock file
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/check-container-logs.rb

@@ -17,10 +17,21 @@
 #   gem: net_http_unix
 #
 # USAGE:
-#   check-container-logs.rb -H /tmp/docker.sock -n logspout -r 'problem sending' -r 'i/o timeout' -i 'Remark:' -i 'The configuration is'
+#   # Check only one container
+#   check-container-logs.rb -H /tmp/docker.sock -N logspout -r 'problem sending' -r 'i/o timeout' -i 'Remark:' -i 'The configuration is'
 #   => 1 container running = OK
 #   => 4 container running = CRITICAL
 #
+#   # Check multiple containers
+#   check-container-logs.rb -H /tmp/docker.sock -N logspout -N logtest -r 'problem sending' -r 'i/o timeout' -i 'Remark:' -i 'The configuration is'
+#   => 1 container running = OK
+#   => 4 container running = CRITICAL
+#
+#   # Check all containers
+#   check-container-logs.rb -H /tmp/docker.sock -r 'problem sending' -r 'i/o timeout' -i 'Remark:' -i 'The configuration is'
+#   => 1 containers running = OK
+#   => 4 containers running = CRITICAL
+#
 # NOTES:
 #   The API parameter required to use the limited lookback (-t) was introduced
 #   the Docker server API version 1.19. This check may still work on older API
@@ -37,36 +48,33 @@ require 'sensu-plugins-docker/client_helpers'
 
 class ContainerLogChecker < Sensu::Plugin::Check::CLI
   option :docker_host,
-         description: 'Docker socket to connect. TCP: "host:port" or Unix: "/path/to/docker.sock" (default: "127.0.0.1:2375")',
+         description: 'Docker API URI. https://host, https://host:port, http://host, http://host:port, host:port, unix:///path',
          short: '-H DOCKER_HOST',
-         long: '--docker-host DOCKER_HOST',
-         default: '127.0.0.1:2375'
+         long: '--docker-host DOCKER_HOST'
 
   option :container,
-         description: 'name of container',
-         short: '-n CONTAINER',
+         description: 'name of container; can be used multiple times. /!\ All running containers will be check if this options is not provided',
+         short: '-N CONTAINER',
          long: '--container-name CONTAINER',
-         required: true
+         default: [],
+         proc: proc { |flag| (@options[:container][:accumulated] ||= []).push(flag) }
 
   option :red_flags,
-         description: 'substring whose presence (case-insensitive by default) in a log line indicates an error; can be used multiple t
-imes',
-         short: '-r "error occurred" -r "problem encountered" -r "error status"',
-         long: '--red-flag "error occurred" --red-flag "problem encountered" --red-flag "error status"',
+         description: 'String whose presence (case-insensitive by default) in a log line indicates an error; can be used multiple times',
+         short: '-r ERR_STRING',
+         long: '--red-flag ERR_STRING',
          default: [],
          proc: proc { |flag| (@options[:red_flags][:accumulated] ||= []).push(flag) }
 
   option :ignore_list,
-         description: 'substring whose presence (case-insensitive by default) in a log line indicates the line should be ignored; can
-be used multiple times',
-         short: '-i "configuration:" -i "# Remark:"',
-         long: '--ignore-lines-with "configuration:" --ignore-lines-with "# remark:"',
+         description: 'String whose presence (case-insensitive by default) in a log line indicates the line should be ignored; can be used multiple times',
+         short: '-i IGNSTR',
+         long: '--ignore-lines-with IGNSTR',
          default: [],
          proc: proc { |flag| (@options[:ignore_list][:accumulated] ||= []).push(flag) }
 
   option :case_sensitive,
-         description: 'indicates all red_flag and ignore_list substring matching should be case-sensitive instead of the default case-
-insensitive',
+         description: 'indicates all red_flag and ignore_list substring matching should be case-sensitive instead of the default case-insensitive',
          short: '-c',
          long: '--case-sensitive',
          boolean: true
@@ -83,33 +91,60 @@ insensitive',
          long: '--seconds-ago SECONDS',
          required: false
 
+  option :check_all,
+         description: 'If all containers are checked (no container name provided with -n) , check offline containers too',
+         short: '-a',
+         long: '--all',
+         default: false,
+         boolean: true
+
+  option :disable_stdout,
+         description: 'Disable the check on STDOUT logs. By default both STDERR and STDOUT are checked',
+         short: '-1',
+         long: '--no-stdout',
+         default: true,
+         boolean: true,
+         proc: proc { false } # used to negate the false(default)->true boolean option behaviour to true(default)->false
+
+  option :disable_stderr,
+         description: 'Disable the check on STDERR logs. By default both STDERR and STDOUT are checked',
+         short: '-2',
+         long: '--no-stderr',
+         default: true,
+         boolean: true,
+         proc: proc { false } # used to negate the false(default)->true boolean option behaviour to true(default)->false
+
   def calculate_timestamp(seconds_ago = nil)
     seconds_ago = yield if block_given?
     (Time.now - seconds_ago).to_i
   end
 
   def process_docker_logs(container_name)
-    client = create_docker_client
-    path = "/containers/#{container_name}/logs?stdout=true&stderr=true"
+    path = "/containers/#{container_name}/logs?stdout=#{config[:disable_stdout]}&stderr=#{config[:disable_stderr]}&timestamps=true"
     if config.key? :hours_ago
       timestamp = calculate_timestamp { config[:hours_ago].to_i * 3600 }
     elsif config.key? :seconds_ago
       timestamp = calculate_timestamp config[:seconds_ago].to_i
     end
     path = "#{path}&since=#{timestamp}"
-    req = Net::HTTP::Get.new path
-
-    client.request req do |response|
-      response.read_body do |chunk|
-        yield remove_headers chunk
-      end
+    response = @client.call(path, false)
+    if response.code.to_i == 404
+      critical "Container '#{container_name}' not found on #{@client.uri}"
     end
+    yield remove_headers response.read_body
   end
 
   def remove_headers(raw_logs)
     lines = raw_logs.split("\n")
-    lines.map! { |line| line.byteslice(8, line.bytesize) }
-    lines.join("\n")
+    lines.map! do |line|
+      # Check only logs generated with the 8 bits control
+      if !line.nil? && /^(0|1|2)000$/ =~ line.byteslice(0, 4).unpack('C*').join('')
+        # Remove the first 8 bits and ansii colors too
+        line.byteslice(8, line.bytesize).gsub(/\x1b\[[\d;]*?m/, '')
+      end
+    end
+    # We want the most recent logs lines first
+    lines.compact.reverse.join("\n")
   end
 
   def includes_any?(str, array_of_substrings)
@@ -135,11 +170,30 @@ insensitive',
   end
 
   def run
-    container = config[:container]
-    process_docker_logs(container) do |log_chunk|
-      problem = detect_problem log_chunk
-      critical "#{container} container logs indicate problem: '#{problem}'." unless problem.nil?
+    @client = DockerApi.new(config[:docker_host])
+    problem = []
+    problem_string = nil
+    path = "/containers/json?all=#{config[:check_all]}"
+    containers = config[:container]
+    if config[:container].none?
+      warn_msg = %(
+        Collecting logs from all containers is dangerous and could lead to sensu client hanging depending on volume of logs.
+        This not recommended for production environments.
+      ).gsub(/\s+/, ' ').strip
+      message warn_msg
+    end
+    containers = @client.parse(path).map { |p| p['Names'][0].delete('/') } if containers.none?
+    critical 'Check all containers was asked but no containers was found' if containers.none?
+    containers.each do |container|
+      process_docker_logs container do |log_chunk|
+        problem_string = detect_problem(log_chunk)
+        break unless problem_string.nil?
+      end
+      problem << "\tError found inside container : '#{container}'\n\t\t#{problem_string}" unless problem_string.nil?
     end
-    ok "No errors detected from #{container} container logs."
+    problem_string = problem.join("\n")
+    critical "Container(s) logs indicate problems :\n#{problem_string}" unless problem.none?
+    containers_string = containers.join(', ')
+    ok "No errors detected from logs inside container(s) : \n#{containers_string}"
   end
 end

data/bin/check-container.rb

@@ -16,11 +16,11 @@
 #   gem: sensu-plugin
 #
 # USAGE:
-#   check-container.rb -h /var/run/docker.sock -c c92d402a5d14
+#   check-container.rb -H /var/run/docker.sock -N c92d402a5d14
 #   CheckDockerContainer OK: c92d402a5d14 is running on /var/run/docker.sock.
 #
-#   check-container.rb -h /var/run/docker.sock -c circle_burglar
-#   CheckDockerContainer CRITICAL: circle_burglar is not running on /var/run/docker.sock
+#   check-container.rb -H https://127.0.0.1:2376 -N circle_burglar
+#   CheckDockerContainer CRITICAL: circle_burglar is not running on https://127.0.0.1:2376
 #
 # NOTES:
 #     => State.running == true   -> OK
@@ -37,52 +37,45 @@
 
 require 'sensu-plugin/check/cli'
 require 'sensu-plugins-docker/client_helpers'
-require 'json'
 
 #
 # Check Docker Container
 #
 class CheckDockerContainer < Sensu::Plugin::Check::CLI
   option :docker_host,
-         short: '-h DOCKER_HOST',
-         long: '--host DOCKER_HOST',
-         description: 'Docker socket to connect. TCP: "host:port" or Unix: "/path/to/docker.sock" (default: "127.0.0.1:2375")',
-         default: '127.0.0.1:2375'
+         short: '-H DOCKER_HOST',
+         long: '--docker-host DOCKER_HOST',
+         description: 'Docker API URI. https://host, https://host:port, http://host, http://host:port, host:port, unix:///path'
+
   option :container,
-         short: '-c CONTAINER',
-         long: '--container CONTAINER',
+         short: '-N CONTAINER',
+         long: '--container-name CONTAINER',
          required: true
+
   option :tag,
          short: '-t TAG',
          long: '--tag TAG'
 
   def run
-    client = create_docker_client
+    @client = DockerApi.new(config[:docker_host])
     path = "/containers/#{config[:container]}/json"
-    req = Net::HTTP::Get.new path
-    begin
-      response = client.request(req)
-      if response.code.to_i == 404
-        critical "#{config[:container]} is not running on #{config[:docker_host]}"
-      end
-      body = JSON.parse(response.body)
-      container_running = body['State']['Running']
-      if container_running
-        if config[:tag]
-          image = body['Config']['Image']
-          match = image.match(/^(?:([^\/]+)\/)?(?:([^\/]+)\/)?([^@:\/]+)(?:[@:](.+))?$/)
-          unless match && match[4] == config[:tag]
-            critical "#{config[:container]}'s tag is '#{match[4]}', excepting '#{config[:tag]}'"
-          end
+    response = @client.call(path, false)
+    if response.code.to_i == 404
+      critical "Container #{config[:container]} is not running on #{@client.uri}"
+    end
+    body = parse_json(response)
+    container_running = body['State']['Running']
+    if container_running
+      if config[:tag]
+        image = body['Config']['Image']
+        match = image.match(/^(?:([^\/]+)\/)?(?:([^\/]+)\/)?([^@:\/]+)(?:[@:](.+))?$/)
+        unless match && match[4] == config[:tag]
+          critical "#{config[:container]}'s tag is '#{match[4]}', especting '#{config[:tag]}'"
         end
-        ok "#{config[:container]} is running on #{config[:docker_host]}."
-      else
-        critical "#{config[:container]} is #{body['State']['Status']} on #{config[:docker_host]}."
       end
-    rescue JSON::ParserError => e
-      critical "JSON Error: #{e.inspect}"
-    rescue => e
-      warning "Error: #{e.inspect}"
+      ok "#{config[:container]} is running on #{@client.uri}."
+    else
+      critical "#{config[:container]} is #{body['State']['Status']} on #{@client.uri}."
     end
   end
 end

data/bin/check-docker-container.rb

@@ -20,6 +20,14 @@
 #   => 1 container running = OK.
 #   => 4 container running = CRITICAL
 #
+#   check-docker-container.rb -H /var/run/docker.sock -w 3 -c 3
+#   => 1 container running = OK.
+#   => 4 container running = CRITICAL
+#
+#   check-docker-container.rb -H https://127.0.0.1:2376  -w 3 -c 3
+#   => 1 container running = OK.
+#   => 4 container running = CRITICAL
+#
 # NOTES:
 #
 # LICENSE:
@@ -30,16 +38,15 @@
 
 require 'sensu-plugin/check/cli'
 require 'sensu-plugins-docker/client_helpers'
-require 'json'
+
 #
 # Check Docker Containers
 #
 class CheckDockerContainers < Sensu::Plugin::Check::CLI
   option :docker_host,
-         short: '-h docker_host',
-         long: '--host DOCKER_HOST',
-         description: 'Docker socket to connect. TCP: "host:port" or Unix: "/path/to/docker.sock" (default: "127.0.0.1:2375")',
-         default: '127.0.0.1:2375'
+         description: 'Docker API URI. https://host, https://host:port, http://host, http://host:port, host:port, unix:///path',
+         short: '-H DOCKER_HOST',
+         long: '--docker-host DOCKER_HOST'
 
   option :warn_over,
          short: '-W N',
@@ -94,17 +101,8 @@ class CheckDockerContainers < Sensu::Plugin::Check::CLI
   end
 
   def run
-    client = create_docker_client
-    path = '/containers/json'
-    req = Net::HTTP::Get.new path
-    begin
-      response = client.request(req)
-      containers = JSON.parse(response.body)
-      evaluate_count containers.size
-    rescue JSON::ParserError => e
-      critical "JSON Error: #{e.inspect}"
-    rescue => e
-      warning "Error: #{e.inspect}"
-    end
+    @client = DockerApi.new(config[:docker_host])
+    containers = @client.parse('/containers/json')
+    evaluate_count containers.size
   end
 end

data/bin/metrics-docker-container.rb

@@ -14,7 +14,22 @@
 #   gem: sensu-plugin
 #
 # USAGE:
-#   #YELLOW
+#
+# metrics-docker-container.rb -H /var/run/docker.sock -n
+#   docker.host.sensu.sh.rss 1 1508825823
+#   docker.host.sensu.sh.vsize 1572864 1508825823
+#   docker.host.sensu.sh.nswap 0 1508825823
+#   docker.host.sensu.sh.pctmem 0.0 1508825823
+#   docker.host.sensu.sh.fd 0 1508825823
+#   docker.host.sensu.sh.cpu 0 1508825823
+#
+# metrics-docker-container.rb -H https://127.0.0.1:2376
+#   docker.host.ff5240e079488d248c021f8da5d13074a6a9db72ffaf1129eded445f4e16cf50.sh.rss 183 1508825793
+#   docker.host.ff5240e079488d248c021f8da5d13074a6a9db72ffaf1129eded445f4e16cf50.sh.vsize 4616192 1508825793
+#   docker.host.ff5240e079488d248c021f8da5d13074a6a9db72ffaf1129eded445f4e16cf50.sh.nswap 0 1508825793
+#   docker.host.ff5240e079488d248c021f8da5d13074a6a9db72ffaf1129eded445f4e16cf50.sh.pctmem 0.01 1508825793
+#   docker.host.ff5240e079488d248c021f8da5d13074a6a9db72ffaf1129eded445f4e16cf50.sh.fd 0 1508825793
+#   docker.host.ff5240e079488d248c021f8da5d13074a6a9db72ffaf1129eded445f4e16cf50.sh.cpu 0 1508825793
 #
 # NOTES:
 #
@@ -25,7 +40,7 @@
 #
 
 require 'sensu-plugin/metric/cli'
-require 'socket'
+require 'sensu-plugins-docker/client_helpers'
 require 'pathname'
 require 'sys/proctable'
 
@@ -46,23 +61,30 @@ class DockerContainerMetrics < Sensu::Plugin::Metric::CLI::Graphite
          default: '/sys/fs/cgroup'
 
   option :docker_host,
-         description: 'Docker host. TCP: "tcp://host:port" or Unix: "unix:///path/to/docker.sock" (default: "tcp://127.0.1.1:2376")',
+         description: 'Docker API URI. https://host, https://host:port, http://host, http://host:port, host:port, unix:///path',
          short: '-H DOCKER_HOST',
-         long: '--docker-host DOCKER_HOST',
-         default: 'tcp://127.0.1.1:2376'
+         long: '--docker-host DOCKER_HOST'
 
   option :cgroup_template,
          description: 'cgroup_template',
-         short: '-T <template string>',
-         long: '--cgroup-template template_string',
+         short: '-T TPL_STRING',
+         long: '--cgroup-template TPL_STRING',
          default: 'cpu/docker/%{container}/cgroup.procs'
 
+  option :friendly_names,
+         description: 'use friendly name if available',
+         short: '-n',
+         long: '--names',
+         boolean: true,
+         default: false
+
   def run
+    @client = DockerApi.new(config[:docker_host])
     container_metrics
     ok
   end
 
-  def container_metrics #rubocop:disable all
+  def container_metrics
     cgroup = "#{config[:cgroup_path]}/#{config[:cgroup_template]}"
 
     timestamp = Time.now.to_i
@@ -72,18 +94,24 @@ class DockerContainerMetrics < Sensu::Plugin::Metric::CLI::Graphite
 
     fields = [:rss, :vsize, :nswap, :pctmem]
 
-    ENV['DOCKER_HOST'] = config[:docker_host]
-    containers = `docker ps --quiet --no-trunc`.split("\n")
+    path = '/containers/json'
+    containers = @client.parse(path)
 
     containers.each do |container|
-      path = Pathname(format(cgroup, container: container))
+      path = Pathname(format(cgroup, container: container['Id']))
       pids = path.readlines.map(&:to_i)
 
+      container_name = if config[:friendly_names]
+                         container['Names'][0].delete('/')
+                       else
+                         container['Id']
+                       end
+
       processes = ps.values_at(*pids).flatten.compact.group_by(&:comm)
       processes2 = ps2.values_at(*pids).flatten.compact.group_by(&:comm)
 
       processes.each do |comm, process|
-        prefix = "#{config[:scheme]}.#{container}.#{comm}"
+        prefix = "#{config[:scheme]}.#{container_name}.#{comm}"
         fields.each do |field|
           output "#{prefix}.#{field}", process.map(&field).reduce(:+), timestamp
         end

data/bin/metrics-docker-info.rb

@@ -21,10 +21,10 @@
 #
 # USAGE:
 #   Gather stats using unix socket:
-#   metrics-docker-info.rb -p unix -H /var/run/docker.sock
+#   metrics-docker-info.rb -H /var/run/docker.sock
 #
-#   Gather stats from localhost using TCP:
-#   metrics-docker-info.rb -p http -H localhost:2375
+#   Gather stats from localhost using HTTP:
+#   metrics-docker-info.rb -H localhost:2375
 #
 #   See metrics-docker-info.rb --help for full usage flags
 #
@@ -37,9 +37,7 @@
 #
 
 require 'sensu-plugin/metric/cli'
-require 'socket'
-require 'net_http_unix'
-require 'json'
+require 'sensu-plugins-docker/client_helpers'
 
 class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
   option :scheme,
@@ -49,43 +47,19 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
          default: "#{Socket.gethostname}.docker"
 
   option :docker_host,
-         description: 'Docker socket to connect. TCP: "host:port" or Unix: "/path/to/docker.sock" (default: "127.0.0.1:2375")',
+         description: 'Docker API URI. https://host, https://host:port, http://host, http://host:port, host:port, unix:///path',
          short: '-H DOCKER_HOST',
-         long: '--docker-host DOCKER_HOST',
-         default: '/var/run/docker.sock'
-
-  option :docker_protocol,
-         description: 'http or unix',
-         short: '-p PROTOCOL',
-         long: '--protocol PROTOCOL',
-         default: 'unix'
+         long: '--docker-host DOCKER_HOST'
 
   def run
     @timestamp = Time.now.to_i
-    path = 'info'
-    infolist = docker_api(path)
+    @client = DockerApi.new(config[:docker_host])
+    path = '/info'
+    infolist = @client.parse(path)
     filtered_list = infolist.select { |key, _value| key.match(/NCPU|NFd|Containers|Images|NGoroutines|NEventsListener|MemTotal/) }
     filtered_list.each do |key, value|
       output "#{config[:scheme]}.#{key}", value, @timestamp
     end
     ok
   end
-
-  def docker_api(path)
-    if config[:docker_protocol] == 'unix'
-      session = NetX::HTTPUnix.new("unix://#{config[:docker_host]}")
-      request = Net::HTTP::Get.new "/#{path}"
-    else
-      uri = URI("#{config[:docker_protocol]}://#{config[:docker_host]}/#{path}")
-      session = Net::HTTP.new(uri.host, uri.port)
-      request = Net::HTTP::Get.new uri.request_uri
-    end
-
-    session.start do |http|
-      http.request request do |response|
-        response.value
-        return JSON.parse(response.read_body)
-      end
-    end
-  end
 end

data/bin/metrics-docker-stats.rb

@@ -19,13 +19,13 @@
 #
 # USAGE:
 #   Gather stats from all containers on a host using socket:
-#   metrics-docker-stats.rb -p unix -H /var/run/docker.sock
+#   metrics-docker-stats.rb -H /var/run/docker.sock
 #
-#   Gather stats from all containers on a host using TCP:
-#   metrics-docker-stats.rb -p http -H localhost:2375
+#   Gather stats from all containers on a host using HTTP:
+#   metrics-docker-stats.rb -H localhost:2375
 #
 #   Gather stats from a specific container using socket:
-#   metrics-docker-stats.rb -p unix -H /var/run/docker.sock -c 5bf1b82382eb
+#   metrics-docker-stats.rb -H /var/run/docker.sock -N 5bf1b82382eb
 #
 #   See metrics-docker-stats.rb --help for full usage flags
 #
@@ -38,9 +38,7 @@
 #
 
 require 'sensu-plugin/metric/cli'
-require 'socket'
-require 'net_http_unix'
-require 'json'
+require 'sensu-plugins-docker/client_helpers'
 
 class Hash
   def self.to_dotted_hash(hash, recursive_key = '')
@@ -64,21 +62,14 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
 
   option :container,
          description: 'Name of container to collect metrics for',
-         short: '-c CONTAINER',
-         long: '--container CONTAINER',
+         short: '-N CONTAINER',
+         long: '--container-name CONTAINER',
          default: ''
 
   option :docker_host,
-         description: 'Docker socket to connect. TCP: "host:port" or Unix: "/path/to/docker.sock" (default: "127.0.0.1:2375")',
+         description: 'Docker API URI. https://host, https://host:port, http://host, http://host:port, host:port, unix:///path',
          short: '-H DOCKER_HOST',
-         long: '--docker-host DOCKER_HOST',
-         default: '127.0.0.1:2375'
-
-  option :docker_protocol,
-         description: 'http or unix',
-         short: '-p PROTOCOL',
-         long: '--protocol PROTOCOL',
-         default: 'http'
+         long: '--docker-host DOCKER_HOST'
 
   option :friendly_names,
          description: 'use friendly name if available',
@@ -88,8 +79,8 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
          default: false
 
   option :name_parts,
-         description: 'Partial names by spliting and returning at index(es). \
-                       eg. -m 3,4 my-docker-container-process_name-b2ffdab8f1aceae85300 for process_name.b2ffdab8f1aceae85300',
+         description: 'Partial names by spliting and returning at index(es).
+         eg. -m 3,4 my-docker-container-process_name-b2ffdab8f1aceae85300 for process_name.b2ffdab8f1aceae85300',
          short: '-m index',
          long: '--match index'
 
@@ -101,8 +92,8 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
 
   option :environment_tags,
          description: 'Name of environment variables on each container to be appended to metric name, separated by commas',
-         short: '-e ENVIRONMENT_VARIABLES',
-         long: '--environment-tags ENVIRONMENT_VARIABLES'
+         short: '-e ENV_VARS',
+         long: '--environment-tags ENV_VARS'
 
   option :ioinfo,
          description: 'enable IO Docker metrics',
@@ -120,6 +111,7 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
 
   def run
     @timestamp = Time.now.to_i
+    @client = DockerApi.new(config[:docker_host])
 
     list = if config[:container] != ''
              [config[:container]]
@@ -150,6 +142,7 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
     dotted_stats.each do |key, value|
       next if key == 'read' # unecessary timestamp
       next if value.is_a?(Array)
+      value.delete!('/') if key == 'name'
       output "#{config[:scheme]}.#{container}.#{key}", value, @timestamp
     end
     if config[:ioinfo]
@@ -160,30 +153,12 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
     output "#{config[:scheme]}.#{container}.cpu_stats.usage_percent", calculate_cpu_percent(stats), @timestamp if config[:cpupercent]
   end
 
-  def docker_api(path)
-    if config[:docker_protocol] == 'unix'
-      session = NetX::HTTPUnix.new("unix://#{config[:docker_host]}")
-      request = Net::HTTP::Get.new "/#{path}"
-    else
-      uri = URI("#{config[:docker_protocol]}://#{config[:docker_host]}/#{path}")
-      session = Net::HTTP.new(uri.host, uri.port)
-      request = Net::HTTP::Get.new uri.request_uri
-    end
-
-    session.start do |http|
-      http.request request do |response|
-        response.value
-        return JSON.parse(response.read_body)
-      end
-    end
-  end
-
   def list_containers
     list = []
-    path = 'containers/json'
-    @containers = docker_api(path)
+    path = '/containers/json'
+    containers = @client.parse(path)
 
-    @containers.each do |container|
+    containers.each do |container|
       list << if config[:friendly_names]
                 container['Names'][0].delete('/')
               elsif config[:name_parts]
@@ -196,17 +171,25 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
   end
 
   def container_stats(container)
-    path = "containers/#{container}/stats?stream=0"
-    @stats = docker_api(path)
+    path = "/containers/#{container}/stats?stream=0"
+    response = @client.call(path)
+    if response.code.to_i == 404
+      critical "#{config[:container]} is not running on #{@client.uri}"
+    end
+    parse_json(response)
   end
 
   def container_tags(container)
     tags = ''
-    path = "containers/#{container}/json"
-    @inspect = docker_api(path)
+    path = "/containers/#{container}/json"
+    response = @client.call(path)
+    if response.code.to_i == 404
+      critical "#{config[:container]} is not running on #{@client.uri}"
+    end
+    inspect = parse_json(response)
     tag_list = config[:environment_tags].split(',')
     tag_list.each do |value|
-      tags << @inspect['Config']['Env'].select { |tag| tag.to_s.match(/#{value}=/) }.first.to_s.gsub(/#{value}=/, '') + '.'
+      tags << inspect['Config']['Env'].select { |tag| tag.to_s.match(/#{value}=/) }.first.to_s.gsub(/#{value}=/, '') + '.'
     end
     tags
   end

data/lib/sensu-plugins-docker/client_helpers.rb

@@ -1,18 +1,60 @@
 require 'net_http_unix'
+require 'json'
 
-def create_docker_client
-  client = nil
-  if config[:docker_host][0] == '/'
-    host = 'unix://' + config[:docker_host]
-    client = NetX::HTTPUnix.new(host)
-  else
-    split_host = config[:docker_host].split ':'
-    client = if split_host.length == 2
-               NetX::HTTPUnix.new(split_host[0], split_host[1])
-             else
-               NetX::HTTPUnix.new(config[:docker_host], 2375)
-             end
+class DockerApi
+  def initialize(uri = nil)
+    @client = nil
+    @docker_uri = uri || ENV['DOCKER_URL'] || ENV['DOCKER_HOST'] || '/var/run/docker.sock'
+    if @docker_uri.sub!(%r{^(unix://)?/}, '')
+      @docker_uri = 'unix:///' + @docker_uri
+      @client = NetX::HTTPUnix.new(@docker_uri)
+    else
+      protocol = %r{^(https?|tcp)://}.match(@docker_uri) || 'http://'
+      @docker_uri.sub!(protocol.to_s, '')
+      split_host = @docker_uri.split ':'
+      @client = if split_host.length == 2
+                  NetX::HTTPUnix.new("#{protocol}#{split_host[0]}", split_host[1])
+                else
+                  NetX::HTTPUnix.new("#{protocol}#{@docker_uri}", 2375)
+                end
+    end
+    @client.start
   end
 
-  client
+  def uri
+    @docker_uri
+  end
+
+  def call(path, halt = true, limit = 10)
+    raise ArgumentError, "HTTP redirect too deep. Last url called : #{path}" if limit.zero?
+    if %r{^unix:///} =~ @docker_uri
+      request = Net::HTTP::Get.new path.to_s
+    else
+      uri = URI("#{@docker_uri}#{path}")
+      request = Net::HTTP::Get.new uri.request_uri
+    end
+    response = @client.request(request)
+    case response
+    when Net::HTTPSuccess     then response
+    when Net::HTTPRedirection then call(response['location'], true, limit - 1)
+    else
+      return response.error! unless halt == false
+      return response
+    end
+  end
+
+  def parse(path, halt = true, limit = 10)
+    parsed = parse_json(call(path, halt, limit))
+    parsed
+  end
+end
+
+def parse_json(response)
+  parsed = nil
+  begin
+    parsed = JSON.parse(response.read_body)
+  rescue JSON::ParserError => e
+    raise "JSON Error: #{e.inspect}"
+  end
+  parsed
 end

data/lib/sensu-plugins-docker/version.rb

@@ -1,6 +1,6 @@
 module SensuPluginsDocker
   module Version
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 0
     PATCH = 0
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-docker
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: docker-api
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.21.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
@@ -199,12 +185,12 @@ description: |-
                                 metrics via `docker ps`
 email: "<sensu-users@googlegroups.com>"
 executables:
-- metrics-docker-container.rb
 - metrics-docker-info.rb
-- check-container.rb
+- metrics-docker-container.rb
+- check-docker-container.rb
 - check-container-logs.rb
 - metrics-docker-stats.rb
-- check-docker-container.rb
+- check-container.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -246,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for docker