sensu-plugins-cgroups 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1651ede861e1dd7e2ecf1003707e21cb0a80d991
-  data.tar.gz: b462460e12937fa01f582fc41f838ddef4ca38ba
+  metadata.gz: 3977f9af71115c500dee0b3f0bdc39e709d9a436
+  data.tar.gz: 8fbaa70300354f52f516a7302b3582af2d362754
 SHA512:
-  metadata.gz: ee51b2d6e269b9b5355236f4615926366b4ec77674b544edee33cb44bc5f2eed58e9f1e563e5be35a099931b73e82418647af490cf24aadeb35dbde5cb212385
-  data.tar.gz: 8fdd7911513941ceba9fb1ff5537d874b40ff5002904446618bc359a3071b3ddd9a50c389bfcfc5977b3c0fed214cac13574a359ea1697b4ac5a06b8ea1552fe
+  metadata.gz: aeeb3613c62f59cd70beebd3525019ad609932e2089d88b9a8278b35c9a933ccab0426d7b02f2b3c588b2ef4307e4ab270de021b305db4f9653bc97397f78eb4
+  data.tar.gz: 36e68af14d019d76664ecc32b92344b641dbfefab2a26b3495284b8631fc9f581b352312e009f18cb9989fd45735b221a3007e5972c763d639ab9561f3c82c1b

data/CHANGELOG.md

@@ -5,10 +5,14 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [1.1.0] - 2017-08-01
+### Added
+- New metrics script implemented in ruby (@bergerx)
+
 ## [1.0.0] - 2017-07-12
 ### Added
-- Support for Ruby 2.3.0
-- Support for Ruby 2.4.1
+- Testing for Ruby 2.3.0
+- Testing for Ruby 2.4.1
 ### Breaking Changes
 - Drop support for Ruby 1.9.3
 
@@ -27,7 +31,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-cgroups/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-cgroups/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-cgroups/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-cgroups/compare/0.0.3...1.0.0
 [0.0.3]: https://github.com/sensu-plugins/sensu-plugins-cgroups/compare/0.0.2...0.0.3
 [0.0.2]: https://github.com/sensu-plugins/sensu-plugins-cgroups/compare/0.0.1...0.0.2

data/README.md

@@ -10,9 +10,55 @@
 
 ## Files
  * bin/metrics-cgroup.sh
+ * bin/metrics-cgroup.rb
 
 ## Usage
 
+Collect all cgroup metrics, tested only on CentOS.
+
+```
+metrics-cgroup.rb -g "/sys/fs/cgroup/**/**"
+```
+
+Collect only systemd service metrics
+
+```
+metrics-cgroup.rb -g "/sys/fs/cgroup/**/system.slice/*"
+```
+
+Collect only user.slice only
+
+```
+metrics-cgroup.rb -g "/sys/fs/cgroup/**/user.slice"
+```
+
+Collect only mesos task metrics
+
+```
+metrics-cgroup.rb -g "/sys/fs/cgroup/**/mesos/*"
+```
+
+Collect only docker container metrics (may not be meaningful if you already collect metrics from docker)
+
+```
+metrics-cgroup.rb -g "/sys/fs/cgroup/**/docker/*"
+```
+
+Collect only system.slice, user.slice, docker and mesos and nothing else
+
+```
+metrics-cgroup.rb -g "/sys/fs/cgroup/**/{system.slice,user.slice,docker,mesos}{,/*}"
+```
+
+Instead of collecting breakdown of each docker instance, or
+mesos task, or systemd service metric; this could let to
+collect/compare overall docker, mesos, systemd and user recources
+in total.
+
+```
+metrics-cgroup.rb -g "/sys/fs/cgroup/**/{system.slice,user.slice,docker,mesos}"
+```
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/metrics-cgroup.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+#
+#   metrics-cgroup
+#
+# DESCRIPTION:
+#   This plugin collects cgroup metrics.
+#
+# OUTPUT:
+#   metrics data in graphite
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   # Collect all cgroup metrics, tested only on CentOS.
+#   metrics-cgroup.rb -g "/sys/fs/cgroup/**/**"
+#
+#   # Collect only systemd service metrics
+#   metrics-cgroup.rb -g "/sys/fs/cgroup/**/system.slice/*"
+#
+#   # Collect only user.slice only
+#   metrics-cgroup.rb -g "/sys/fs/cgroup/**/user.slice"
+#
+#   # Collect only mesos task metrics
+#   metrics-cgroup.rb -g "/sys/fs/cgroup/**/mesos/*"
+#
+#   # Collect only docker container metrics
+#   # (may not be meaningful if you already collect metrics from docker)
+#   metrics-cgroup.rb -g "/sys/fs/cgroup/**/docker/*"
+#
+#   # collect only system.slice, user.slice, docker and mesos and nothing else
+#   metrics-cgroup.rb -g "/sys/fs/cgroup/**/{system.slice,user.slice,docker,mesos}{,/*}"
+#
+#   # Instead of collecting breakdown of each docker instance, or
+#   # mesos task, or systemd service metric; this could let to
+#   # collect/compare overall docker, mesos, systemd and user recources
+#   # in total.
+#   metrics-cgroup.rb -g "/sys/fs/cgroup/**/{system.slice,user.slice,docker,mesos}"
+#
+# LICENCE:
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+class CgroupMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to queue_name.metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.cgroup"
+  option :glob,
+         description: 'This should match a cgroup directories in a cgroup filesystem. '\
+                      '(default: /sys/fs/cgroup/**/**)',
+         short: '-g GLOB',
+         long: '--glob GLOB',
+         default: '/sys/fs/cgroup/**/**'
+  option :files_whitelist,
+         description: 'Limit metric collection to this files, comma seperated '\
+                      'list of files in cgroup directories. (default is to '\
+                      'collect all files)',
+         short: '-f FILES_WHITELIST',
+         long: '--files-whitelist FILES_WHITELIST',
+         default: NIL
+  option :files_blacklist,
+         description: 'Don\'t collect these files, comma seperated list of file '\
+                      'names in cgroup directories. This list will override '\
+                      'whitelist if confict. "tasks" and "cgroup.procs" will '\
+                      'always appended to the list. (default: '\
+                      '"cgroup.clone_children,notify_on_release")',
+         short: '-b FILES_BLACKLIST',
+         long: '--files-blacklist FILES_BLACKLIST',
+         default: 'cgroup.clone_children,notify_on_release'
+  option :smart_paths,
+         description: 'Instead of using full cgroup path in metrics this '\
+                      'enabling smarter metrics names',
+         short: '-p',
+         long: '--no-smart-paths',
+         boolean: true
+
+  def get_tag(cgroup_dir)
+    if config[:smart_paths]
+      "path.#{cgroup_dir.gsub(/[.\/]/, '_')}"
+    else
+      # use cgroup consumer specific tags
+      type, val = cgroup_dir.split(File::SEPARATOR)[-2..-1]
+      case type
+      when 'docker'
+        "docker_id.#{val}"
+      when 'mesos'
+        "mesos_container_id.#{val}"
+      when 'system.slice'
+        "systemd_unit.#{val.gsub(/[.\/]/, '_')}"
+      else
+        "path.#{cgroup_dir.gsub(/[.\/]/, '_')}"
+      end
+    end
+  end
+
+  def run
+    matching_dirs = Dir.glob(config[:glob])
+    if matching_dirs.empty?
+      critical "No matching directory for glob: #{config[:glob]}"
+    end
+
+    # Add 'tasks' and 'cgroup.procs' to blacklist
+    files_to_skip = config[:files_blacklist].split(',') + ['tasks', 'cgroup.procs']
+
+    matching_dirs.each do |cgroup_dir|
+      # Each matching object needs to be a cgroup directory, which always have a tasks file
+      next if !File.directory?(cgroup_dir) || !File.file?("#{cgroup_dir}/tasks")
+
+      Dir.glob("#{cgroup_dir}/*").each do |file|
+        next if !File.file?(file) || !File.readable?(file)
+
+        filename = File.basename(file)
+
+        files_whitelist = config[:files_whitelist]
+        unless files_whitelist.nil?
+          # skip if there is a whitelisted files list and it's not in the list
+          next unless files_whitelist.split(',').include?(filename)
+        end
+
+        # skip if the file is in blacklisted files list
+        next if files_to_skip.include?(filename)
+
+        # Skip files that can't be read
+        begin
+          lines = File.readlines(file)
+        rescue Errno::EIO
+          next
+        end
+
+        tag = get_tag(cgroup_dir)
+        metric_prefix = [config[:scheme], tag, filename.tr('.', '_')].join('.')
+
+        # block that parses most types of files under cgroup file system
+        if lines.size == 1
+          if /^(?<value>[\d-]+)$/=~ lines[0]
+            output(metric_prefix, value)
+          elsif /^(?<key>\w+) (?<value>[\d-]+)$/ =~ lines[0]
+            output([metric_prefix, key].join('.'), value)
+          elsif /^(?<values>([\d-]+ ?)+)$/ =~ lines[0]
+            values.split.each_with_index do |val, index|
+              output([metric_prefix, index].join('.'), val)
+            end
+          end
+        else
+          lines.each_with_index do |line, index|
+            if /^(?<value>[\d-]+)$/=~ line
+              output([metric_prefix, index].join('.'), value)
+            elsif /^(?<key>\w+) (?<value>[\d-]+)$/ =~ line
+              output([metric_prefix, key].join('.'), value)
+            elsif /^(?<dev>[\w:]+) (?<key>\w+) (?<value>[\d-]+)$/ =~ line
+              output([metric_prefix, dev.tr(':', '_'), key].join('.'), value)
+            end
+          end
+        end
+      end
+    end
+
+    ok
+  end
+end

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

@@ -1,7 +1,7 @@
 module SensuPluginsCgroups
   module Version
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-cgroups
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -152,13 +152,15 @@ dependencies:
         version: '0.8'
 description: Sensu plugins for workign with cgroups
 email: "<sensu-users@googlegroups.com>"
-executables: []
+executables:
+- metrics-cgroup.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/metrics-cgroup.rb
 - bin/metrics-cgroup.sh
 - lib/sensu-plugins-cgroups.rb
 - lib/sensu-plugins-cgroups/version.rb