sensu-plugins-docker 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a3931242d5ca4fe8b09b7aab0074f9e12ea485b
-  data.tar.gz: 57f1c0887909436b3b29268b14f42e4b2cd416b7
+  metadata.gz: 0a0c669db204f3d8f22810459efda23ae2deb92e
+  data.tar.gz: cc6319e61a7c19d261ab14a3c368173b6a428f60
 SHA512:
-  metadata.gz: 70317898990a8b5da33505d5eed11ef56989dc4d149d3cd0f9bc1d3395a0ab78a64cf8f96c1ce3c1d52bc8b4b02a72bf4770926d14096e23e8c0e80d51996b6e
-  data.tar.gz: 5e4abf0bad63eb81dd88e87b87521ff3f6b3e12fd3bb8c7289bf6e2b5ad4c6f3efcccfb67685e635f32a0e191693418dacae2503ac7fb34ef3266dcda8e77261
+  metadata.gz: a8290f04f055c64d86316f0cb2a1739a26ef1b078b0384a53fae609d96aa6f93d82ab412ab1f3549d4cca7089db9ce1423d26e78bd26d9ec2261ea04a74d522a
+  data.tar.gz: 28d541dee490616f29e48ff003aac8c77e2b849a8a3c75d7a3f21e10fd642b488e9e570c786934ce2a422cc0312d6cddeff6350adab4dca31d55c83896fbbc3c

data/CHANGELOG.md

@@ -1,10 +1,18 @@
-#Change Log
+# Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [1.4.0] - 2017-08-08
+### Added
+- metrics-docker-info.rb: general information metrics from docker (@alcasim)
+- metrics-docker-stats.rb: Added to include environment variables values as part of the metric. Added I/O stats option (@alcasim)
+
+### Added
+- Ruby 2.4.1 testing
+
 ## [1.3.1] - 2017-06-12
 ### Fixed
 - check-container.rb: fixes to work with docker >= 1.17 (@israelriibeiro)
@@ -88,7 +96,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/1.3.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.4.0...HEAD
+[1.4.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.3.1...1.4.0
 [1.3.1]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.3.0...1.3.1
 [1.3.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.2.0...1.3.0
 [1.2.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.1.5...1.2.0

data/README.md

@@ -15,6 +15,7 @@ This check supports docker versions >= 1.18. Check docker-engine API for more in
  * check-docker-container.rb
  * metrics-docker-container.rb
  * metrics-docker-stats.rb
+ * metrics-docker-info.rb
 
 ## Usage
 

data/bin/metrics-docker-info.rb

@@ -0,0 +1,91 @@
+#! /usr/bin/env ruby
+#
+#   metrics-docker-info
+#
+# DESCRIPTION:
+#
+# This check gather certain general stats from Docker (number of CPUs, number of containers, images...)
+# Supports the stats feature of the docker remote api ( docker server 1.5 and newer )
+# Supports connecting to docker remote API over Unix socket or TCP
+# Based on metrics-docker-stats by @paulczar
+#
+#
+# OUTPUT:
+#   metric-data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   Gather stats using unix socket:
+#   metrics-docker-info.rb -p unix -H /var/run/docker.sock
+#
+#   Gather stats from localhost using TCP:
+#   metrics-docker-info.rb -p http -H localhost:2375
+#
+#   See metrics-docker-info.rb --help for full usage flags
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2017 Alfonso Casimiro. Github @alcasim
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+require 'net_http_unix'
+require 'json'
+
+class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         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")',
+         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'
+
+  def run
+    @timestamp = Time.now.to_i
+    path = 'info'
+    infolist = docker_api(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

@@ -99,6 +99,18 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
          long: '--deliminator',
          default: '-'
 
+  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'
+
+  option :ioinfo,
+         description: 'enable IO Docker metrics',
+         short: '-i',
+         long: '--ioinfo',
+         boolean: true,
+         default: false
+
   def run
     @timestamp = Time.now.to_i
 
@@ -109,14 +121,17 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
            end
     list.each do |container|
       stats = container_stats(container)
+      scheme = ''
+      unless config[:environment_tags].nil?
+        scheme << container_tags(container)
+      end
       if config[:name_parts]
-        scheme = ''
         config[:name_parts].split(',').each do |key|
           scheme << '.' unless scheme == ''
           scheme << container.split(config[:delim])[key.to_i]
         end
       else
-        scheme = container
+        scheme << container
       end
       output_stats(scheme, stats)
     end
@@ -130,6 +145,11 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
       next if value.is_a?(Array)
       output "#{config[:scheme]}.#{container}.#{key}", value, @timestamp
     end
+    if config[:ioinfo]
+      blkio_stats(stats['blkio_stats']).each do |key, value|
+        output "#{config[:scheme]}.#{container}.#{key}", value, @timestamp
+      end
+    end
   end
 
   def docker_api(path)
@@ -171,4 +191,25 @@ class DockerStatsMetrics < Sensu::Plugin::Metric::CLI::Graphite
     path = "containers/#{container}/stats?stream=0"
     @stats = docker_api(path)
   end
+
+  def container_tags(container)
+    tags = ''
+    path = "containers/#{container}/json"
+    @inspect = docker_api(path)
+    tag_list = config[:environment_tags].split(',')
+    tag_list.each do |value|
+      tags << @inspect['Config']['Env'].select { |tag| tag.to_s.match(/#{value}=/) }.first.gsub(/#{value}=/, '') + '.'
+    end
+    tags
+  end
+
+  def blkio_stats(io_stats)
+    stats_out = {}
+    io_stats.each do |stats_type, stats_vals|
+      stats_vals.each do |value|
+        stats_out["#{stats_type}.#{value['op']}.#{value['major']}.#{value['minor']}"] = value['value']
+      end
+    end
+    stats_out
+  end
 end

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

@@ -1,8 +1,8 @@
 module SensuPluginsDocker
   module Version
     MAJOR = 1
-    MINOR = 3
-    PATCH = 1
+    MINOR = 4
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-docker
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -201,6 +201,7 @@ email: "<sensu-users@googlegroups.com>"
 executables:
 - check-container-logs.rb
 - metrics-docker-container.rb
+- metrics-docker-info.rb
 - metrics-docker-stats.rb
 - check-container.rb
 - check-docker-container.rb
@@ -214,6 +215,7 @@ files:
 - bin/check-container.rb
 - bin/check-docker-container.rb
 - bin/metrics-docker-container.rb
+- bin/metrics-docker-info.rb
 - bin/metrics-docker-stats.rb
 - lib/sensu-plugins-docker.rb
 - lib/sensu-plugins-docker/client_helpers.rb