sensu-plugins-process-checks 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4c1e16b051ae71d9479b95387e22c504ab7a7f0
-  data.tar.gz: 43d7d36c527666e51220a43a05c26793ea420397
+  metadata.gz: 2d2298603cc93f7fa246cfae47fe4abf183fbe12
+  data.tar.gz: 0df7445dde46ef1df869d6f35470c78b3cf00859
 SHA512:
-  metadata.gz: 4d4cca0b109f96d84089aa5855841a9bc50e8214949c883092850c16d43ada5af4912ec5da7f7cac1915ee81fe2c9e34e46e9731f0b379d5f61c6836ed621829
-  data.tar.gz: 512a08cd43764730059955e144f7dd3772ae9944b517a7bc5ac969ad5b07be2d6b7a8e136a73ff8693436b6e442638a34a17c758209cff2c1dd62be80164b791
+  metadata.gz: 19dc7d11cd249a108ef10e6e52001754f1d560d5dbdcd85566107b6d2a2479982a08b81daeec8870c3fb125f4da9f3e5f5cf1b28ab70ce657909339e26c3d480
+  data.tar.gz: 02e090d85944b1dda4eadb8e500f838c0ca42a84e479127632571c45666a10be5d5d253549b9cdaa613c71b9c5d1ed42c0c3e37c02852685a627fc6a18ee0040

data/CHANGELOG.md

@@ -1,11 +1,21 @@
 # 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.5.0] - 2017-10-04
+### Added
+- metric-per-processes.py: Add metrics filter (@rthouvenin)
+
+### Changed
+- updated changelog guidelines (@majormoses)
+
+### Fixed
+- spelling in PR template (@majormoses)
+
 ## [2.4.0] - 2017-07-18
 ### Added
 - ruby 2.4 testing (@majormoses)
@@ -139,8 +149,9 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 - built against 1.9.3, 2.0, 2.1
 - cryptographically signed
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.3.0...HEAD
-[2.4.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.3.0...
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.5.0...HEAD
+[2.5.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.4.0...2.5.0
+[2.4.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.3.0...2.4.0
 [2.3.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.2.0...2.3.0
 [2.2.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.0.0...2.1.0

data/README.md

@@ -26,8 +26,40 @@
 
 ## Usage
 
+Check if an arbitrary process seems to be running or not. Our arbitrary process in this example is called `gutrot`.
+Usage of `check-process.rb` would look something similar to the following:
+
+    $ /opt/sensu/embedded/bin/ruby /opt/sensu/embedded/bin/check-process.rb -p gutrot
+    CheckProcess OK: Found 3 matching processes; cmd /gutrot/
+
+The `-p` argument is for a pattern to match against the list of running processes reported by `ps`.
+
+Example configuration at `/etc/sensu/conf.d/check_gutrot_running.json`:
+
+    {
+      "checks": {
+        "check_gutrot_running": {
+          "command": "check-process.rb -p gutrot",
+          "standalone": true,
+          "interval": 60,
+          "handlers": ["default"]
+        }
+      }
+    }
+
+The check is named `check_gutrot_running` and it runs `check-process.rb -p gutrot` every `60` seconds (interval)
+then lets the `default` handler handle the result.
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
 
+Quick install after following the steps above:
+
+    $ sensu-install process-checks
+
+The checks will be installed at:
+
+    /opt/sensu/embedded/bin/
+
 ## Notes

data/bin/metrics-per-process.py

@@ -16,7 +16,7 @@
 #
 # USAGE:
 #
-#  metrics-per-process.py -n <process_name> | -p <path_to_process_pid_file> [-s <graphite_scheme>]
+#  metrics-per-process.py -n <process_name> | -p <path_to_process_pid_file> [-s <graphite_scheme>] [-m <metrics_regexes>]
 #
 # NOTES:
 # The plugin requires to read files in the /proc file system, make sure the owner
@@ -66,6 +66,7 @@
 import os
 import optparse
 import psutil
+import re
 import sys
 import time
 
@@ -89,6 +90,7 @@ TCP_CONN_STATUSES = [
 'CLOSING',
 'NONE'
 ]
+MEMORY_STATS = ['rss', 'vms', 'shared', 'text', 'lib', 'data', 'dirty']
 
 def find_pids_from_name(process_name):
   '''Find process PID from name using /proc/<pids>/comm'''
@@ -107,60 +109,115 @@ def find_pids_from_name(process_name):
             pass
   return pids
 
-def stats_per_pid(pid):
-  '''Gets process stats using psutil module
+def additional_stats(process_handler, metrics_regexp):
+  stats = {}
 
-  details at http://pythonhosted.org/psutil/#process-class'''
+  if metrics_regexp.match('cpu.user'): 
+    stats['cpu.user'] = process_handler.cpu_times().user
 
-  stats = {}
-  process_handler = psutil.Process(pid)
+  if metrics_regexp.match('cpu.system'): 
+    stats['cpu.system'] = process_handler.cpu_times().system
+
+  if metrics_regexp.match('cpu.percent'): 
+    stats['cpu.percent'] = process_handler.cpu_percent()
+
+  if metrics_regexp.match('threads'): 
+    stats['threads'] = process_handler.num_threads()
+
+  if metrics_regexp.match('memory.percent'): 
+    stats['memory.percent'] = process_handler.memory_percent()
+
+  if metrics_regexp.match('fds'): 
+    stats['fds'] = process_handler.num_fds()
+
+  if metrics_regexp.match('ctx_switches.voluntary'): 
+    stats['ctx_switches.voluntary'] = process_handler.num_ctx_switches().voluntary
+
+  if metrics_regexp.match('ctx_switches.involuntary'): 
+    stats['ctx_switches.involuntary'] = process_handler.num_ctx_switches().involuntary
+
+  if metrics_regexp.match('io_counters.read_count'): 
+    stats['io_counters.read_count'] = process_handler.io_counters().read_count
+
+  if metrics_regexp.match('io_counters.write_count'): 
+    stats['io_counters.write_count'] = process_handler.io_counters().write_count
+
+  if metrics_regexp.match('io_counters.read_bytes'): 
+    stats['io_counters.read_bytes'] = process_handler.io_counters().read_bytes
+
+  if metrics_regexp.match('io_counters.write_bytes'): 
+    stats['io_counters.write_bytes'] = process_handler.io_counters().write_bytes
+
+  return stats
+
+# Memory info
+def memory_stats(process_handler, metrics_regexp):
   if psutil.version_info < (4,0,0):
     process_memory_info = process_handler.memory_info_ex()
   else:
     process_memory_info = process_handler.memory_info()
-  stats['cpu.user'] = process_handler.cpu_times().user
-  stats['cpu.system'] = process_handler.cpu_times().system
-  stats['cpu.percent'] = process_handler.cpu_percent()
-  stats['threads'] = process_handler.num_threads()
-  stats['memory.rss'] = process_memory_info.rss
-  stats['memory.vms'] = process_memory_info.vms
-  stats['memory.shared'] = process_memory_info.shared
-  stats['memory.text'] = process_memory_info.text
-  stats['memory.lib'] = process_memory_info.lib
-  stats['memory.data'] = process_memory_info.data
-  stats['memory.dirty'] = process_memory_info.dirty
-  stats['memory.percent'] = process_handler.memory_percent()
-  stats['fds'] = process_handler.num_fds()
-  stats['ctx_switches.voluntary'] = process_handler.num_ctx_switches().voluntary
-  stats['ctx_switches.involuntary'] = process_handler.num_ctx_switches().involuntary
-  stats['io_counters.read_count'] = process_handler.io_counters().read_count
-  stats['io_counters.write_count'] = process_handler.io_counters().write_count
-  stats['io_counters.read_bytes'] = process_handler.io_counters().read_bytes
-  stats['io_counters.write_bytes'] = process_handler.io_counters().write_bytes
-  # TCP/UDP/Unix Socket Connections
-  tcp_conns = process_handler.connections(kind='tcp')
+
+  stats = {}
+  for stat in MEMORY_STATS:
+    if metrics_regexp.match('memory.' + stat):
+      stats['memory.' + stat] = getattr(process_memory_info, stat)
+
+  return stats
+
+# TCP/UDP/Unix Socket Connections
+def connection_stats(process_handler, metrics_regexp):
+  tcp_stats = ['total'] + [s.lower() for s in TCP_CONN_STATUSES]
+  tcp_conns = None
+  tcp_conns_count = {}
+  for stat in tcp_stats:
+    if metrics_regexp.match('conns.tcp.' + stat):
+      if tcp_conns is None:
+        tcp_conns = process_handler.connections(kind='tcp')
+
+  stats = {}
   if tcp_conns:
     stats['conns.tcp.total'] = len(tcp_conns)
-    tcp_conns_count = {}
     for tcp_status in TCP_CONN_STATUSES:
-      tcp_conns_count['conns.tcp.' + tcp_status.lower()] = 0
-      for conn in tcp_conns:
-        if conn.status == tcp_status:
-          tcp_conns_count['conns.tcp.' + tcp_status.lower()] = tcp_conns_count[
-              'conns.tcp.' + tcp_status.lower()] + 1
+      stat = 'conns.tcp.' + tcp_status.lower()
+      if metrics_regexp.match(stat):
+        tcp_conns_count[stat] = 0
+        for conn in tcp_conns:
+          if conn.status == tcp_status:
+            tcp_conns_count[stat] = tcp_conns_count[stat] + 1
     stats.update(tcp_conns_count)
-  udp_conns = process_handler.connections(kind='udp')
-  if udp_conns:
-    stats['conns.udp.total'] = len(udp_conns)
-  unix_conns = process_handler.connections(kind='unix')
-  if unix_conns:
-    stats['conns.unix_sockets.total'] = len(unix_conns)
+
+  if metrics_regexp.match('conns.udp.total'):
+    udp_conns = process_handler.connections(kind='udp')
+    if udp_conns:
+      stats['conns.udp.total'] = len(udp_conns)
+
+  if metrics_regexp.match('conns.unix_sockets.total'):
+    unix_conns = process_handler.connections(kind='unix')
+    if unix_conns:
+      stats['conns.unix_sockets.total'] = len(unix_conns)
+
+  return stats
+
+def stats_per_pid(pid, metrics_regexes):
+  '''Gets process stats using psutil module
+
+  Returns only the stats with a name that matches one of the metrics_regexes
+  details at http://pythonhosted.org/psutil/#process-class'''
+
+  stats = {}
+  process_handler = psutil.Process(pid)
+
+  for metrics_regexp in metrics_regexes:
+    stats.update(memory_stats(process_handler, metrics_regexp))
+    stats.update(connection_stats(process_handler, metrics_regexp))
+    stats.update(additional_stats(process_handler, metrics_regexp))
+
   return stats
 
-def multi_pid_process_stats(pids):
+def multi_pid_process_stats(pids, metrics_regexes):
   stats = {'total_processes': len(pids)}
   for pid in pids:
-    stats = Counter(stats) + Counter(stats_per_pid(pid))
+    stats = Counter(stats) + Counter(stats_per_pid(pid, metrics_regexes))
   return stats
 
 def recursive_dict_sum(dictionnary):
@@ -208,6 +265,12 @@ def main():
     dest    = 'graphite_scheme',
     metavar = 'GRAPHITE_SCHEME')
 
+  parser.add_option('-m', '--metrics-regexes',
+    help    = 'comma-separated list of regexes used to match the metric names to collect, default to .*',
+    default = '.*',
+    dest    = 'metrics_regexes',
+    metavar = 'METRICS_REGEXES')
+
   (options, args) = parser.parse_args()
 
   if options.process_name and options.process_pid_file:
@@ -218,13 +281,15 @@ def main():
     print 'A process name or a process pid file path is needed'
     sys.exit(1)
 
+  options.metrics_regexes = [re.compile(regex) for regex in options.metrics_regexes.split(',')]
+
   if options.process_name:
     pids = find_pids_from_name(options.process_name)
-    graphite_printer(multi_pid_process_stats(pids), options.graphite_scheme)
+    graphite_printer(multi_pid_process_stats(pids, options.metrics_regexes), options.graphite_scheme)
 
   if options.process_pid_file:
     pid = get_pid_from_pid_file(options.process_pid_file)
-    graphite_printer(stats_per_pid(pid), options.graphite_scheme)
+    graphite_printer(stats_per_pid(pid, options.metrics_regexes), options.graphite_scheme)
 #
 if __name__ == '__main__':
   main()

data/lib/sensu-plugins-process-checks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-process-checks
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: english
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for checking running processes