sensu-plugins-mesos 2.1.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f47811de2e1c9561493b853c17c7798a928756a3a833dbd84f443f232ea401
-  data.tar.gz: a702867f72846ecc058f68a81c02a6f1e5ceb4376fd730c14ea7a272aac85626
+  metadata.gz: e10b24c48670147d1b92bd26eb23f9d3d41cc8898a9eceae4e8eec37337c275d
+  data.tar.gz: 36f43ad36b03fa997bd3658d2f918a503d1a5e0ae74cab0bbef9bc40cedeef44
 SHA512:
-  metadata.gz: 67698870e977112d92d95a3615b51041ee4d69e0f68366d3bdf70ac4152b1f130fd566de63b619e960a3c5456da4ad808f9a5b25d8d39ecec3431a894769ab05
-  data.tar.gz: cea4ad31176d7c96a326b5c50832a3a7b57c92d4ea241b8c96007f8fde84c51a741147561608731c4cc1fba9d203b4754b6f61777b8673391f1e0924fbe33fa4
+  metadata.gz: 7f1dd2f114f1179da80e69c48555a700e64bde5ac561827e8353aec76c305d92def4afec8b00110f7d6b2be832def154716bb178bd378976d0d3511c35967222
+  data.tar.gz: e6e8302cd5a95ba10e2f6dafe8556e32eb2c718245f212664b6316224f2e883509093abff12e0b7e234edb527f12a43639ac293dbd416c6c43f6131693850078

data/CHANGELOG.md

@@ -1,10 +1,18 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
 
+## [2.3.0] - 2018-03-17
+### Added
+- testing skeleton for `test-kitchen`, `kitchen-docker`, and `serverspec` (@majormoses)
+- check-marathon-apps.rb: create a check result per Marathon app (@bergerx, @epierotto)
+
+### Changed
+- updated CHANGELOG guidelines location (@majormoses)
+
 ## [2.2.2] - 2017-12-05
 ### Fixed
 - metrics-marathon.rb: ignore 2 new keys (start, end) in Marathon 1.5 /metrics endpoint (@bergerx)
@@ -86,7 +94,9 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mesos/compare/2.1.2...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mesos/compare/2.3.0...HEAD
+[2.3.0]: https://github.com/sensu-plugins/sensu-plugins-mesos/compare/2.2.2...2.3.0
+[2.2.2]: https://github.com/sensu-plugins/sensu-plugins-mesos/compare/2.1.2...2.2.2
 [2.1.2]: https://github.com/sensu-plugins/sensu-plugins-mesos/compare/2.1.1...2.1.2
 [2.1.1]: https://github.com/sensu-plugins/sensu-plugins-mesos/compare/2.1.0...2.1.1
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-mesos/compare/2.0.0...2.1.0

data/README.md

@@ -12,6 +12,7 @@
  * bin/check-chronos.rb
  * bin/check-metronome.rb
  * bin/check-marathon.rb
+ * bin/check-marathon-apps.rb
  * bin/check-mesos.rb
  * bin/check-mesos-cpu-balance.rb
  * bin/check-mesos-disk-balance.rb

data/bin/check-marathon-apps.rb

@@ -0,0 +1,398 @@
+#! /usr/bin/env ruby
+#
+#   check-marathon-apps
+#
+# DESCRIPTION:
+#   This plugin creates checks results for each Marathon app that is running,
+#   and reports the status of the app based on Marathon Application Status Reference.
+#   https://mesosphere.github.io/marathon/docs/marathon-ui.html#application-status-reference
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   Exclude apps matching "test"
+#   check-marathon-apps.rb -x test
+#   CheckMarathonApps OK: Marathon Apps Status and Health check is running properly
+#
+#   Only apps matching "test"
+#   check-marathon-task.rb -i test
+#   CheckMarathonApps OK: Marathon Apps Status and Health check is running properly
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2018, Sensu Plugins
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+
+# This plugin checks Marathon apps based on https://mesosphere.github.io/marathon/docs/marathon-ui.html#application-status-reference
+#
+# It produces a check result for `health` and another check result for `status`
+# Check results can be customised by providing default values on '--default-check-config JSON' or by populating Marathon app labels, example:
+# SENSU_MARATHON_STATUS_UNSCHEDULED_TTL = 10
+# SENSU_MARATHON_STATUS_UNSCHEDULED_SOURCE = my_source
+#
+# Those labels will override the default values and create the following check result if the status is Unscheduled:
+# {
+#   "name": "check_marathon_app_test_status",
+#   "executed": 1519305736,
+#   "marathon": {
+#     "id": "/test",
+#     "version": "2018-02-20T15:09:43.086Z",
+#     "versionInfo": {
+#       "lastScalingAt": "2018-02-20T15:09:43.086Z",
+#       "lastConfigChangeAt": "2018-02-20T15:09:43.086Z"
+#     },
+#     "tasksStaged": 0,
+#     "tasksRunning": 1,
+#     "tasksHealthy": 1,
+#     "tasksUnhealthy": 0
+#   },
+#   "source": "my_source",
+#   "output": "STATUS Unscheduled - tasksRunning(1), tasksStaged(0), tasksHealthy(1), tasksUnhealthy(0)",
+#   "ttl": 10,
+#   "status": 0
+# }
+#
+class MarathonAppsCheck < Sensu::Plugin::Check::CLI
+  REFERENCES = %w(health status).freeze
+  STATUS_STATES = %w(waiting delayed suspended deploying running).freeze
+  HEALTH_STATES = %w(unscheduled overcapacity staged unknown unhealthy healthy).freeze
+  APPS_EMBED_RESOURCES = %w(apps.task apps.count apps.deployments apps.lastTaskFailure apps.failures apps.taskStats).freeze
+  DEFAULT_CHECK_CONFIG = <<-CONFIG.gsub(/^\s+\|/, '').freeze
+    |{
+    |  "_": {"ttl": 70},
+    |  "status":{
+    |    "running":   {"status": 0},
+    |    "delayed":   {"status": 1},
+    |    "deploying": {"status": 1},
+    |    "suspended": {"status": 1},
+    |    "waiting":   {"status": 1}
+    |  },
+    |  "health":{
+    |    "healthy":      {"status": 0},
+    |    "overcapacity": {"status": 1},
+    |    "staged":       {"status": 1},
+    |    "unhealthy":    {"status": 2},
+    |    "unscheduled":  {"status": 2},
+    |    "unknown":      {"status": 0}
+    |  }
+    |}
+  CONFIG
+
+  check_name 'CheckMarathonApps'
+  banner <<-BANNER.gsub(/^\s+\|/, '')
+    |Usage: ./check-marathon-apps.rb (options)
+    |
+    |This check will always return OK and publish two check results (health and status) per Marathon app.
+    |Marathon applications can override default_check_config by using labels as described below.
+    |
+    |Some example labels that can be used in Marathon application manifests:
+    |
+    |# Publish '"aggregate": "component"' field in the check results for all health and status checks.
+    |- SENSU_MARATHON_AGGREGATE=component
+    |# similar for some other fields
+    |- SENSU_MARATHON_CONTACT=support
+    |
+    |# Publish '"aggregate": "component"' field in the check results only for status checks.
+    |- SENSU_MARATHON_STATUS_AGGREGATE=component
+    |# Don't handle status check results
+    |- SENSU_MARATHON_STATUS_HANDLE=false
+    |
+    |# Generate UNKNOWN result for unknown health status, rather then the default OK result
+    |- SENSU_MARATHON_HEALTH_UNKNOWN_STATUS=3
+    |
+    |Similar logic could be applied for the provided default_check_config. Values
+    |under the special '_' key will be used as a default value for deeper levels.
+    |
+    |Here is the default value for default_check_config:
+    |#{DEFAULT_CHECK_CONFIG}
+    |
+    |Options:
+  BANNER
+
+  option :url,
+         description: 'Marathon API URL',
+         short: '-u url',
+         long: '--url url',
+         default: 'http://localhost:8080'
+
+  option :username,
+         short: '-u USERNAME',
+         long: '--username USERNAME',
+         default: nil,
+         required: false,
+         description: 'Marathon API username'
+
+  option :password,
+         long: '--password PASSWORD',
+         default: nil,
+         required: false,
+         description: 'Marathon API password'
+
+  option :match_pattern,
+         short: '-m PATTERN',
+         long: '--match-pattern PATTERN',
+         required: false,
+         description: 'Match app names against a pattern, exlude pattern takes precedence if both provided'
+
+  option :exclude_pattern,
+         short: '-x PATTERN',
+         long: '--exclude-pattern PATTERN',
+         required: false,
+         description: 'Exclude apps that match a pattern, takes precedence over match pattern'
+
+  option :marathon_keys,
+         long: '--marathon-keys KEY1,KEY2,KEY3',
+         default: 'id,version,versionInfo,tasksStaged,tasksRunning,tasksHealthy,tasksUnhealthy,lastTaskFailure',
+         required: false,
+         description: 'Keys retrieved from Marathon API that will be included in the output'
+
+  option :default_check_config,
+         long: '--default-check-config "{"status":{"running":{"valid":"json"}},"health":{"healthy":{"valid":"json"}}}"',
+         required: false,
+         description: 'Default values to be used while creating the check results, '\
+                      'can be overridden in a per-marathon application config via Marathon labels.'
+
+  option :default_check_config_file,
+         long: '--default-check-config-file CONFIG_FILE',
+         required: false,
+         description: 'Similar to `--default-check-config` but read from given file. If both parameters are provided  '\
+                      '`--default-check-config` will override this one.'
+
+  option :sensu_client_url,
+         description: 'Sensu client HTTP URL socket',
+         long: '--sensu-client-url url',
+         default: 'http://localhost:3031'
+
+  option :timeout,
+         description: 'timeout in seconds',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         proc: proc(&:to_i),
+         default: 5
+
+  def run
+    if !config[:username].nil? && config[:password].nil? || config[:username].nil? && !config[:password].nil?
+      unknown 'You must provide both username and password to authenticate on Marathon API'
+    end
+
+    # Get Marathon API apps
+    apps = fetch_apps
+
+    # Get Marathon API queue
+    queue = fetch_queue
+
+    # Get and parse default check config
+    check_config_str = if !config[:default_check_config].nil?
+                         config[:default_check_config]
+                       elsif !config[:default_check_config_file].nil?
+                         File.read(config[:default_check_config_file])
+                       else
+                         DEFAULT_CHECK_CONFIG
+                       end
+    check_config = parse_json(check_config_str)
+
+    # Filter apps, if both exists exclude pattern will override match pattern
+    apps.keep_if { |app| app['id'][/#{config[:match_pattern]}/] } if config[:match_pattern]
+    apps.delete_if { |app| app['id'][/#{config[:exclude_pat]}/] } if config[:exclude_pat]
+
+    apps.each do |app|
+      # Select app queue if any
+      app_queue = queue.select { |q| q['app']['id'][/^#{app['id']}$/] }.to_a.first
+
+      # Build check result
+      check_result = check_result_scaffold(app)
+
+      # Parse Marathon app labels
+      labels_config = parse_app_labels(app['labels'].to_h)
+
+      REFERENCES.each do |reference|
+        # / is and invalid character
+        check_result['name'] = "check_marathon_app#{app['id'].tr('/', '_')}_#{reference}"
+
+        state = case reference
+                when 'health'
+                  get_marathon_app_health(app)
+                when 'status'
+                  get_marathon_app_status(app, app_queue.to_h)
+                end
+
+        # Merge user provided check config
+        check_result.merge!(check_config.dig('_').to_h)
+        check_result.merge!(check_config.dig(reference, '_').to_h)
+        check_result.merge!(check_config.dig(reference, state).to_h)
+
+        # Merge Marathon parsed check config
+        check_result.merge!(labels_config.dig('_').to_h)
+        check_result.merge!(labels_config.dig(reference, '_').to_h)
+        check_result.merge!(labels_config.dig(reference, state).to_h)
+
+        # Build check result output
+        check_result['output'] = "#{reference.upcase} #{state.capitalize} - "\
+          "tasksRunning(#{app['tasksRunning'].to_i}), tasksStaged(#{app['tasksStaged'].to_i}), "\
+          "tasksHealthy(#{app['tasksHealthy'].to_i}), tasksUnhealthy(#{app['tasksUnhealthy'].to_i})"
+
+        # Make sure that check result data types are correct
+        sanitize_check_result(check_result)
+
+        # Send the result to sensu-client HTTP socket
+        post_check_result(check_result)
+      end
+    end
+
+    ok 'Marathon Apps Status and Health check is running properly'
+  end
+
+  def check_result_scaffold(app)
+    {
+      'name' => '',
+      'executed' => Time.now.to_i,
+      'marathon' => app.select { |k, _| config[:marathon_keys].split(',').include?(k) },
+      'source' => 'marathon',
+      'output' => '',
+      'status' => 3
+    }
+  end
+
+  def sanitize_check_result(check_result)
+    # Force data types of different fields on the check result
+    # https://sensuapp.org/docs/latest/reference/checks.html#example-check-definition
+    # https://sensuapp.org/docs/latest/reference/checks.html#check-result-specification
+    check_result.each do |k, v|
+      if %w(publish standalone auto_resolve force_resolve handle truncate_output).include?(k)
+        # Boolean
+        check_result[k] = v.to_s.eql?('true')
+      elsif %w(status interval issued executed timeout ttl ttl_status low_flap_threshold high_flap_threshold truncate_output_length).include?(k)
+        # Integer
+        check_result[k] = Integer(v)
+      elsif %w(subscribers handlers aggregates).include?(k)
+        # Array
+        check_result[k] = Array(v.split(','))
+      end
+    end
+  end
+
+  def get(path)
+    RestClient.get("#{config[:url]}#{path}",
+                   user: config[:username],
+                   password: config[:password],
+                   accept: 'application/json',
+                   timeout: config[:timeout]).body
+  rescue RestClient::ExceptionWithResponse => e
+    critical "Error while trying to GET (#{config[:url]}#{path}): #{e.response}"
+  end
+
+  def fetch_apps
+    # http://mesosphere.github.io/marathon/api-console/index.html
+    resources_query = APPS_EMBED_RESOURCES.map { |resource| "embed=#{resource}" }.join('&')
+    parse_json(get("/v2/apps?#{resources_query}"))['apps']
+  end
+
+  def fetch_queue
+    # http://mesosphere.github.io/marathon/api-console/index.html
+    parse_json(get('/v2/queue'))['queue']
+  end
+
+  def post_check_result(data)
+    RestClient.post("#{config[:sensu_client_url]}/results",
+                    data.to_json,
+                    content_type: 'application/json',
+                    timeout: config[:timeout])
+  rescue RestClient::ExceptionWithResponse => e
+    critical "Error while trying to POST check result (#{config[:sensu_client_url]}/results): #{e.response}"
+  end
+
+  def parse_json(json)
+    JSON.parse(json.to_s)
+  rescue JSON::ParserError => e
+    critical "Failed to parse JSON: #{e}\nJSON => #{json}"
+  end
+
+  def parse_app_labels(app_labels)
+    config = {}
+    # Only grab labels that starts with SENSU_MARATHON
+    labels = app_labels.to_h.select { |e| /^SENSU_MARATHON/.match(e) }
+
+    labels.each do |label, value|
+      config_keys = label.split('_')
+
+      # Delete SENSU and MARATHON element
+      config_keys.delete_if { |k| /^SENSU$|^MARATHON$/.match(k) }
+
+      # Downcase
+      config_keys.map!(&:downcase)
+
+      reference = config_keys.shift if REFERENCES.include? config_keys[0]
+      if (reference == 'health' && HEALTH_STATES.include?(config_keys[0])) ||
+         (reference == 'status' && STATUS_STATES.include?(config_keys[0]))
+        state = config_keys.shift
+      end
+      key = config_keys.join(' ')
+
+      # Add nested keys and value
+      unless reference
+        config['_'] ||= {}
+        config['_'][key] = value
+        next
+      end
+      config[reference] ||= {}
+      unless state
+        config[reference]['_'] ||= {}
+        config[reference]['_'][key] = value
+        next
+      end
+      config[reference][state] ||= {}
+      config[reference][state][key] = value
+    end
+    config
+  end
+
+  def get_marathon_app_status(app, app_queue)
+    # https://mesosphere.github.io/marathon/docs/marathon-ui.html#application-status-reference
+    if app_queue.to_h.dig('delay', 'overdue') == true
+      'waiting'
+    elsif app_queue.to_h.dig('delay', 'overdue') == false
+      'delayed'
+    elsif app['instances'].to_i.zero? && app['tasksRunning'].to_i.zero?
+      'suspended'
+    elsif app['deployments'].to_a.any?
+      'deploying'
+    elsif app['instances'].to_i == app['tasksRunning'].to_i
+      'running'
+    else
+      ''
+    end
+  end
+
+  def get_marathon_app_health(app)
+    # https://mesosphere.github.io/marathon/docs/marathon-ui.html#application-health-reference
+    if app['tasks'].to_a.length.zero? && app['deployments'].to_a.length.zero?
+      'unscheduled'
+    elsif app['instances'].to_i < app['tasksRunning'].to_i
+      'overcapacity'
+    elsif app['tasksStaged'].to_i > 0
+      'staged'
+    elsif app['healthChecks'].to_a.empty?
+      'unknown'
+    elsif app['tasksUnhealthy'].to_i > 0
+      'unhealthy'
+    elsif app['healthChecks'].to_a.any? && app['tasksHealthy'].to_i > 0
+      'healthy'
+    else
+      ''
+    end
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-mesos
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2018-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -94,6 +94,54 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: kitchen-docker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: kitchen-localhost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +212,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -204,21 +266,22 @@ description: |-
                                 for Mesos, Chronos, and Marathon.
 email: "<sensu-users@googlegroups.com>"
 executables:
-- check-chronos.rb
+- metrics-mesos.rb
 - check-marathon-task.rb
-- check-marathon.rb
 - check-mesos-cpu-balance.rb
-- check-mesos-disk-balance.rb
+- check-mesos-running-tasks.rb
+- check-metronome.rb
+- metrics-marathon.rb
 - check-mesos-failed-tasks.rb
 - check-mesos-gpu-balance.rb
-- check-mesos-leader-status.rb
-- check-mesos-lost-tasks.rb
 - check-mesos-mem-balance.rb
-- check-mesos-running-tasks.rb
+- check-chronos.rb
+- check-mesos-disk-balance.rb
+- check-mesos-leader-status.rb
 - check-mesos.rb
-- check-metronome.rb
-- metrics-marathon.rb
-- metrics-mesos.rb
+- check-marathon.rb
+- check-mesos-lost-tasks.rb
+- check-marathon-apps.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -226,6 +289,7 @@ files:
 - LICENSE
 - README.md
 - bin/check-chronos.rb
+- bin/check-marathon-apps.rb
 - bin/check-marathon-task.rb
 - bin/check-marathon.rb
 - bin/check-mesos-cpu-balance.rb
@@ -268,7 +332,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for checking mesos