sensu-plugins-process-checks 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a359a27504b2f6f1129f1221775b3e7d081be20a4b9bc092683f9a4f112ed961
-  data.tar.gz: 9a0665cdde92261c3726d9a4dc641fffb3196dc0c19d5468bf7050d3b1e76ac7
+  metadata.gz: 876caee1acc9312011319211530a65c0277ba8827397e5b0efb1855417e95f64
+  data.tar.gz: 7d353e6e88a47b7d9edb50586f08e4569a2b4ebe578df3a91ececdf5c9cb01fb
 SHA512:
-  metadata.gz: 820865ef5103241ff3d1a4747239b6c7444d0bde906bcea7a248ee6549795a55bbb60b58d90326823be549a302f1ad56d5c52c2ff408ac9695038965a4bfecac
-  data.tar.gz: 9496e6fa7679ad4afb56134260f6e453bf10b15a935595ea959b91e91d85a59baebbb15d9842427adec5a80b1ab23281236b8c6eb658dfeece23e4975a2103fc
+  metadata.gz: e9cb951943643d96a22cd791b742db5dc7c5b1540a966373597149fabd365e5ae3e4fdbcf4a36844def13ce0a6c85106afef2bab9fb302eaba226b717e00743a
+  data.tar.gz: 8a07af4a8bc3eacb1b8ed6829a08db70cdc392cdc8e25bdf7bcbcf4460d6971ab451fdb048f40ef0cbe8b9308872930822ebb339a19fd9979f3d9ff9ea2691df

data/CHANGELOG.md

@@ -6,6 +6,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [2.7.0] - 2018-01-06
+### Changed
+- metrics-per-processes.py: Add option to find processes by username (@rthouvenin)
+
 ## [2.6.0] - 2017-12-05
 ### Changed
 - loosen dependency of `sys-proctable` (@majormoses)
@@ -156,7 +160,8 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 - built against 1.9.3, 2.0, 2.1
 - cryptographically signed
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.6.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.7.0...HEAD
+[2.7.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.6.0...2.7.0
 [2.6.0]: https://github.com/sensu-plugins/sensu-plugins-process-checks/compare/2.5.0...2.6.0
 [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

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>] [-m <metrics_regexes>]
+#  metrics-per-process.py -n <process_name> | -p <path_to_process_pid_file> | -u <username> [-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 pwd
 import re
 import sys
 import time
@@ -92,23 +93,46 @@ TCP_CONN_STATUSES = [
 ]
 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'''
+def find_pids(matcher):
+  '''Find process PID using /proc/<pids> with given matcher'''
 
   pids_in_proc = [ pid for pid in os.listdir(PROC_ROOT_DIR) if pid.isdigit() ]
   pids = []
   for pid in pids_in_proc:
     path = PROC_ROOT_DIR + pid
     try:
-        if 'comm' in os.listdir(path):
-          file_handler = open(path + '/comm', 'r')
-          if file_handler.read().rstrip() == process_name:
-            pids.append(int(pid))
+      if matcher(path):
+        pids.append(int(pid))
     except OSError, e:
-        if e.errno == 2:
-            pass
+      if e.errno == 2:
+        pass
   return pids
 
+def find_pids_from_name(process_name):
+  '''Find process PID from name using /proc/<pids>/comm'''
+
+  def matcher(path):
+    if 'comm' in os.listdir(path):
+      file_handler = open(path + '/comm', 'r')
+      return file_handler.read().rstrip() == process_name
+
+  return find_pids(matcher)
+
+def find_pids_from_user(username):
+  '''Find process PID from username using ownership of /proc/<pids>'''
+
+  try:
+    user = pwd.getpwnam(username)
+    uid = user.pw_uid
+  except KeyError:
+    return []
+
+  def matcher(path):
+    stat = os.stat(path)
+    return stat.st_uid == uid
+
+  return find_pids(matcher)
+
 def additional_stats(process_handler, metrics_regexp):
   stats = {}
 
@@ -250,15 +274,20 @@ def main():
   parser = optparse.OptionParser()
 
   parser.add_option('-n', '--process-name',
-    help    = 'name of process to collect stats (imcompatible with -p)',
+    help    = 'name of process to collect stats (imcompatible with -p or -u)',
     dest    = 'process_name',
     metavar = 'PROCESS_NAME')
 
   parser.add_option('-p', '--pid-file',
-    help    = 'path to pid file for process to collect stats (imcompatible with -n)',
+    help    = 'path to pid file for process to collect stats (imcompatible with -n or -u)',
     dest    = 'process_pid_file',
     metavar = 'PROCESS_PID_FILE')
 
+  parser.add_option('-u', '--user',
+    help    = 'username of user running the process to collect stats (incompatible with -n or -p)',
+    dest    = 'username',
+    metavar = 'USERNAME')
+
   parser.add_option('-s', '--graphite_scheme',
     help    = 'graphite scheme to prepend, default to <process_stats>',
     default = 'per_process_stats',
@@ -272,13 +301,15 @@ def main():
     metavar = 'METRICS_REGEXES')
 
   (options, args) = parser.parse_args()
+  options_list = [options.process_name, options.process_pid_file, options.username]
+  options_count = len(filter(lambda x: x is not None, options_list))
 
-  if options.process_name and options.process_pid_file:
-    print 'Specify a process name or a process pid file path, but not both'
+  if options_count > 1:
+    print 'Specify a process name or a process pid file path or username, but only one of them'
     sys.exit(1)
 
-  if not options.process_name and not options.process_pid_file:
-    print 'A process name or a process pid file path is needed'
+  if options_count == 0:
+    print 'A process name or a process pid file path or username is needed'
     sys.exit(1)
 
   options.metrics_regexes = [re.compile(regex) for regex in options.metrics_regexes.split(',')]
@@ -287,6 +318,10 @@ def main():
     pids = find_pids_from_name(options.process_name)
     graphite_printer(multi_pid_process_stats(pids, options.metrics_regexes), options.graphite_scheme)
 
+  if options.username:
+    pids = find_pids_from_user(options.username)
+    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.metrics_regexes), options.graphite_scheme)

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

@@ -1,7 +1,7 @@
 module SensuPluginsProcessChecks
   module Version
     MAJOR = 2
-    MINOR = 6
+    MINOR = 7
     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.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2018-01-07 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.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for checking running processes