sensu-plugins-docker-swarm 3.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7aa1313a3ad4fccbc1b55e0528da2a29113f94503d65fa8ec4b214cf1c6f514
+  data.tar.gz: b62b1d57e984f3f347d25f95105edeb517476677b5eced33a6284c7bae7ac6ac
+SHA512:
+  metadata.gz: 3c6238ef3415a0e440b484a182514cc902ff807f75cac05ba5d19a1971cab7631d2f4f1a410a14a9bd3e4cd9304fe6bdbbc5af161b35de391d323e7fc046f66b
+  data.tar.gz: 5d61e3439df34a494d65dc8f966c32c0dd808ae173c101c55251a001006b56ec53de8b04ee322ae324edaefc7e936a26c59fa13cc55ad12f94542d2cdd75157e

data/CHANGELOG.md

@@ -0,0 +1,179 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Our CHANGELOG Guidelines ](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md).
+Which is based on [Keep A Changelog](http://keepachangelog.com/)
+
+## [Unreleased]
+### Added
+ - check-service.rb: a new check similar to check-cotainer but for docker services when running in swarm mode
+ - check-service-logs.rb: a new check mirroring check-container-logs.rb but for docker services
+
+## [3.2.0] - 2018-11-22
+### Fixed
+ - metrics-docker-stats.rb: fix #16 -n option causes metrics-docker-stats.rb to fail, in case containers are linked together
+
+## [3.1.1] - 2018-06-29
+### Fixed
+ - check-container-logs.rb: fix nil.gsub condition on empty log lines
+
+## [3.1.0] - 2018-05-07
+### Added
+ - intergration test for container check (@antonidabek)
+ - check-container.rb: -x (--allow-exited) to avoid raising alerts when container exited without error, useful for task oriented containers monitoring. (@antonidabek)
+
+## [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)
+
+### Breaking Change
+- bumped dependency of `sensu-plugin` to 2.x you can read about it  [here](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#v145---2017-03-07) (@majormoses)
+
+## [1.5.0] - 2017-09-09
+### Added
+- metrics-docker-stats.rb: Include metric with cpu usage percentage calculated based on docker stats (@alcasim)
+
+### Changed
+- updated CHANGELOG guidelines location (@majormoses)
+
+## [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)
+
+## [1.3.0] - 2017-06-04
+### Added
+- metrics-docker-stats.rb: Add an option to ouput a portion of the docker
+  container name using by splitting on a delimiter of the users choice.
+
+### Fixed
+- check-container.rb: Fix support for docker versions >= 1.18. The key-pair [State][Status] was replaced with [State][Running] and also logic was updated (#45)
+
+## [1.2.0] - 2017-02-08
+### Added
+- check-container.rb: add an option to test image's tag (@obazoud)
+
+## [1.1.5] - 2016-11-26
+### Changed
+- Loosen `sensu-plugin` dependency to `~> 1.2` (#44)
+
+## [1.1.4] - 2016-11-26
+### Changed
+- metrics-docker-stats.rb: Fix JSON parse error if there is more than one chunk
+  of response data needed to result in valid JSON because of large datasets.
+  (#18)
+
+## [1.1.3] - 2016-08-11
+### Changed
+- dependencies: use net\_http\_unix = 0.2.2
+
+## [1.1.2] - 2016-06-20
+### Changed
+- dependencies: use sensu-plugin ~> 1.2.0, docker-api = 1.21.0
+
+## [1.1.1] - 2016-06-10
+### Fixed
+- metrics-docker-stats.rb: Fix error from trying to collect stats with multiple values. Stats that return array values are now excluded. (#29)
+
+### Changed
+- improved help messages
+- check-container.rb: issue a critical event if container state != running
+
+## [1.1.0] - 2016-06-03
+### Added
+- check-container-logs.rb: added `-s|--seconds-ago` option to be able to set time interval more precisely
+
+## [1.0.0] - 2016-05-24
+Note: this release changes how connections are made to the Docker API and also
+changes some options. Review your check commands before deploying this version.
+
+### Added
+- Added check-container-logs.rb to check docker logs for matching strings
+- Support for Ruby 2.3.0
+- metrics-docker-container.rb: add option to override the default path to cgroup.proc
+
+### Removed
+- Support for Ruby 1.9.3
+
+### Changed
+- check-docker-container.rb: output the number of running containers
+- Refactor to connect to the Docker API socket directly instead of using the `docker` or `docker-api` gems
+- Update to rubocop 0.40 and cleanup
+
+## [0.0.4] - 2015-08-10
+### Changed
+- updated dependencies (added missing dependency `sys-proctable`)
+- added docker metrics using docker api
+
+## [0.0.3] - 2015-07-14
+### Changed
+- updated sensu-plugin gem to 1.2.0
+
+## [0.0.2] - 2015-06-02
+### Fixed
+- added binstubs
+
+### Changed
+- removed cruft from /lib
+
+## 0.0.1 - 2015-04-30
+### Added
+- initial release
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/3.1.1...HEAD
+[3.1.1]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/3.1.0...3.1.1
+[3.1.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/3.0.0...3.1.0
+[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
+[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
+[1.1.5]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.1.4...1.1.5
+[1.1.4]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.1.3...1.1.4
+[1.1.3]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.1.2...1.1.3
+[1.1.2]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.1.1...1.1.2
+[1.1.1]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.1.0...1.1.1
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/1.0.0...1.1.0
+[1.0.0]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/0.0.4...1.0.0
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-docker/compare/0.0.1...0.0.2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+## Sensu-Plugins-docker
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-docker.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-docker)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-docker.svg)](http://badge.fury.io/rb/sensu-plugins-docker)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-docker/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-docker)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-docker/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-docker)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-docker.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-docker)
+
+## Functionality
+This check supports docker versions >= 1.18. Check docker-engine API for more information  
+
+The check-service.rb and check-service-logs.rb are only supported for docker when run in swarm mode
+
+## Files
+ * check-container.rb
+ * check-service.rb
+ * check-container-logs.rb
+ * check-service-logs.rb
+ * check-docker-container.rb
+ * metrics-docker-container.rb
+ * metrics-docker-stats.rb
+ * metrics-docker-info.rb
+
+## 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)
+
+## Notes
+[docker-engine API](https://docs.docker.com/engine/api/v1.29/#section/Versioning)

data/bin/check-container-logs.rb

@@ -0,0 +1,199 @@
+#! /usr/bin/env ruby
+#
+#   check-container-logs
+#
+# DESCRIPTION:
+#   Checks docker logs for specified strings
+#   with the option to ignore lines if they contain specified substrings.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: net_http_unix
+#
+# USAGE:
+#   # 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
+#   versions if you don't want to limit the timestamps of logs.
+#
+# LICENSE:
+#   Author: Nathan Newman  <newmannh@gmail.com>, Kel Cecil <kelcecil@praisechaos.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'sensu-plugins-docker/client_helpers'
+
+class ContainerLogChecker < Sensu::Plugin::Check::CLI
+  option :docker_host,
+         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 :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',
+         default: [],
+         proc: proc { |flag| (@options[:container][:accumulated] ||= []).push(flag) }
+
+  option :red_flags,
+         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: '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',
+         short: '-c',
+         long: '--case-sensitive',
+         boolean: true
+
+  option :hours_ago,
+         description: 'Amount of time in hours to look back for log strings',
+         short: '-t HOURS',
+         long: '--hours-ago HOURS',
+         required: false
+
+  option :seconds_ago,
+         description: 'Amount of time in seconds to look back for log strings',
+         short: '-s SECONDS',
+         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)
+    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}"
+    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! do |line|
+      # Check only logs generated with the 8 bits control
+      if !line.nil? && line.bytesize > 8 && /^(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)
+    array_of_substrings.each do |substring|
+      return true if str.include? substring
+    end
+    false
+  end
+
+  def detect_problem(logs)
+    whiteflags = config[:ignore_list]
+    redflags = config[:red_flags]
+    unless config[:case_sensitive]
+      logs = logs.downcase
+      whiteflags.map!(&:downcase)
+      redflags.map!(&:downcase)
+    end
+
+    logs.split("\n").each do |line|
+      return line if !includes_any?(line, whiteflags) && includes_any?(line, redflags)
+    end
+    nil
+  end
+
+  def run
+    @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
+    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