prometheus-splash 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fd95d116c0f265b310c0ea710e909ab4022a5920c3c234524f2a1dcf9d21d0e
-  data.tar.gz: e21840114c3ea30be45b3766a14f00991b2a6629a44084ff6898ae39d88090c6
+  metadata.gz: 762fd0659906d6b1360ce3d430faca573b1a2aded2675a298b35172811f18e13
+  data.tar.gz: 7d45440cd560b97ad893d07e95faaf3fbafc7343d52eaf36f652eee5ad5181e7
 SHA512:
-  metadata.gz: ae5a2ed4a5100284605b7688e73f3fb59d008a7be9ce6e4050bfc5b9656663e4c2bb72f24f962b98544702a2bf0f2d889f6bd757a12ecb22c52a085cb70857b3
-  data.tar.gz: f9cf202cb9d0818e164fb35c705ab1593ae77e6ce28d06dc18d095d6e7c8c46cb45854f8bad0a661e0edba8f145acbc850ea5163e734b54094cfa50d4db5836b
+  metadata.gz: 5afd8f284807b1c0abfa0f68177bd5d75bf5f5941a38c02ad54047ed450a24b08a6d9d1a8b2c455655e30f4fd9d93f49fa81a5ec8d027906b85e45626cbde1a6
+  data.tar.gz: 2c3f67a0d5736ae24de861593df2b3b1ad397c2544b18c3d05d3b826ab3fc9bc7d0e06989064f0aa5964e269949db8315bd983f5c4ba9de1a0450f6aa8ba96ae

data/CHANGELOG.md

@@ -112,3 +112,16 @@
 * Ansible Splash role logrotate copytruncate for splash logs
 * Prometheus Registry mismatch=> cumulative metrics on each groups #42
 * logger Dual level conservation #43
+
+## V 0.5.2 2020/04/18
+
+### FIX
+
+* dual logger daemon shutdown foreground error
+
+## V 0.5.3 2020/04/18
+
+### FEATURE
+
+* processes monitoring #23
+ 

data/config/splash.yml

@@ -35,6 +35,8 @@
     :logmon_scheduling:
       :every: 20s
     :metrics_scheduling:
+      :every: 15s
+    :procmon_scheduling:
       :every: 20s
     :process_name: "Splash : daemon."
     :paths:
@@ -108,3 +110,10 @@
       :pattern: ERROR
     - :log: /tmp/test2
       :pattern: ERROR
+
+
+### configuration of monitored processes
+  :processes:
+    - :process: cron
+      :patterns:
+        - cron

data/lib/splash/cli/logs.rb

@@ -7,12 +7,12 @@ module CLISplash
     include Splash::Logs
 
 
-    desc "analyse", "analyze logs in config"
+    desc "analyse", "analyze logs defined in Splash config"
     def analyse
       log  = get_logger
       results = LogScanner::new
       res = results.analyse
-      log.info "SPlash Configured logs status :"
+      log.info "SPlash Configured log monitors :"
       full_status = true
       results.output.each do |result|
         if result[:status] == :clean then
@@ -30,7 +30,7 @@ module CLISplash
 
         full_status = false unless result[:status] == :clean
       end
-      display_status = (full_status)? "OK": "KO"
+
       if full_status then
         log.ok "Global status : no error found"
       else
@@ -39,7 +39,7 @@ module CLISplash
       splash_exit case: :quiet_exit
     end
 
-    desc "monitor", "monitor logs in config"
+    desc "monitor", "monitor logs defined in Splash config"
     def monitor
       log = get_logger
       log.level = :fatal if options[:quiet]
@@ -49,7 +49,7 @@ module CLISplash
 
     end
 
-    desc "show LOG", "show configured log monitoring for LOG"
+    desc "show LOG", "show Splash configured log monitoring for LOG"
     def show(logrecord)
       log = get_logger
       log_record_set = get_config.logs.select{|item| item[:log] == logrecord }
@@ -63,7 +63,7 @@ module CLISplash
       end
     end
 
-    desc "list", "Show configured logs monitoring"
+    desc "list", "List all Splash configured logs monitoring"
     long_desc <<-LONGDESC
     Show configured logs monitoring\n
     with --detail, show logs monitor details
@@ -77,7 +77,7 @@ module CLISplash
       log_record_set.each do |record|
         log.item "log monitor : #{record[:log]}"
         if options[:detail] then
-          log.flat "  ->   pattern : /#{record[:pattern]}/"
+          log.arrow "pattern : /#{record[:pattern]}/"
         end
       end
       splash_exit case: :quiet_exit

data/lib/splash/cli/process.rb

@@ -0,0 +1,94 @@
+module CLISplash
+
+  class Processes < Thor
+    include Splash::Config
+    include Splash::Exiter
+    include Splash::Processes
+
+    desc "analyse", "analyze processes defined in Splash config"
+    def analyse
+      log  = get_logger
+      results = ProcessScanner::new
+      res = results.analyse
+      log.info "Splash Configured process records :"
+      full_status = true
+      results.output.each do |result|
+        if result[:status] == :running then
+          log.ok "Process : #{result[:process]} : running"
+          log.item "Detected patterns : "
+          result[:patterns].each do |pattern|
+            log.arrow "/#{pattern}/"
+          end
+          log.item "CPU usage in % : #{result[:cpu]} "
+          log.item "Memory usage in % : #{result[:mem]} "
+        else
+          log.ko "Process : #{result[:process]} : inexistant"
+          log.item "Detected patterns : "
+          result[:patterns].each do |pattern|
+            log.arrow "/#{pattern}/"
+          end
+        end
+
+        full_status = false unless result[:status] == :running
+      end
+
+      if full_status then
+        log.ok "Global status : no error found"
+      else
+        log.error "Global status : some error found"
+      end
+      splash_exit case: :quiet_exit
+    end
+
+    desc "monitor", "monitor processes defined in Splash config"
+    def monitor
+      log = get_logger
+      log.level = :fatal if options[:quiet]
+      result = ProcessScanner::new
+      result.analyse
+      splash_exit result.notify
+    end
+
+    desc "show PROCESS", "show Splash configured process record for PROCESS"
+    def show(record)
+      log = get_logger
+      process_recordset = get_config.processes.select{|item| item[:process] == record }
+      unless process_recordset.empty? then
+        record = process_recordset.first
+        log.item "Process monitor : #{record[:process]}"
+        log.arrow "patterns :"
+        record[:patterns].each do |pattern|
+          log.flat "   - /#{pattern}/"
+        end
+        splash_exit case: :quiet_exit
+      else
+        splash_exit case: :not_found, :more => "Process not configured"
+      end
+    end
+
+    desc "list", "List all Splash configured process records"
+    long_desc <<-LONGDESC
+    List all Splash configured processes record\n
+    with --detail, show process records details
+    LONGDESC
+    option :detail, :type => :boolean,  :aliases => "-D"
+    def list
+      log = get_logger
+      log.info "Splash configured process records :"
+      process_recordset = get_config.processes
+      log.ko 'No configured process found' if process_recordset.empty?
+      process_recordset.each do |record|
+        log.item "Process monitor : #{record[:process]}"
+        if options[:detail] then
+          log.arrow "patterns :"
+          record[:patterns].each do |pattern|
+            log.flat "   - /#{pattern}/"
+          end
+        end
+      end
+      splash_exit case: :quiet_exit
+    end
+
+  end
+
+end

data/lib/splash/cli.rb

@@ -24,14 +24,19 @@ class CLI < Thor
 
 
   include CLISplash
-  desc "commands SUBCOMMAND ...ARGS", "Managing commands/batchs supervision"
+  desc "commands SUBCOMMAND ...ARGS", "Managing commands/batchs supervision & orchestration"
   subcommand "commands", Commands
   desc "logs SUBCOMMAND ...ARGS", "Managing Files/Logs supervision"
   subcommand "logs", Logs
-  desc "daemon SUBCOMMAND ...ARGS", "Logs monitor daemon contoller"
+  desc "processes SUBCOMMAND ...ARGS", "Managing processes supervision"
+  subcommand "processes", Processes
+  desc "daemon SUBCOMMAND ...ARGS", "Splash daemon contoller"
   subcommand "daemon", CLIController
-  desc "config SUBCOMMAND ...ARGS", "config tools for Splash"
+  desc "config SUBCOMMAND ...ARGS", "Config tools for Splash"
   subcommand "config", Config
   desc "documentation SUBCOMMAND ...ARGS", "Documentation for Splash"
   subcommand "documentation", Documentation
+
+
+
 end

data/lib/splash/config.rb

@@ -22,6 +22,7 @@ module Splash
         self[:daemon_process_name] = (config_from_file[:daemon][:process_name])? config_from_file[:daemon][:process_name] : DAEMON_PROCESS_NAME
         self[:daemon_logmon_scheduling] = (config_from_file[:daemon][:logmon_scheduling])? config_from_file[:daemon][:logmon_scheduling] : DAEMON_LOGMON_SCHEDULING
         self[:daemon_metrics_scheduling] = (config_from_file[:daemon][:metrics_scheduling])? config_from_file[:daemon][:metrics_scheduling] : DAEMON_METRICS_SCHEDULING
+        self[:daemon_procmon_scheduling] = (config_from_file[:daemon][:procmon_scheduling])? config_from_file[:daemon][:procmon_scheduling] : DAEMON_PROCMON_SCHEDULING
         self[:execution_template_tokens] = EXECUTION_TEMPLATE_TOKENS_LIST
         self[:execution_template_path] = (config_from_file[:templates][:execution][:path])? config_from_file[:templates][:execution][:path] : EXECUTION_TEMPLATE
         self[:pid_path] = (config_from_file[:daemon][:paths][:pid_path])? config_from_file[:daemon][:paths][:pid_path] : DAEMON_PID_PATH
@@ -34,6 +35,7 @@ module Splash
         self[:backends] = {} ; self[:backends].merge! BACKENDS_STRUCT ; self[:backends].merge! config_from_file[:backends] if config_from_file[:backends]
         self[:loggers] = {} ; self[:loggers].merge! LOGGERS_STRUCT ; self[:loggers].merge! config_from_file[:loggers] if config_from_file[:loggers]
 
+        self[:processes] = (config_from_file[:processes])? config_from_file[:processes] : {}
         self[:logs] = (config_from_file[:logs])? config_from_file[:logs] : {}
         self[:commands] = (config_from_file[:commands])? config_from_file[:commands] : {}
 
@@ -57,6 +59,10 @@ module Splash
         return self[:daemon_logmon_scheduling]
       end
 
+      def daemon_procmon_scheduling
+        return self[:daemon_procmon_scheduling]
+      end
+
       def daemon_metrics_scheduling
         return self[:daemon_metrics_scheduling]
       end
@@ -75,6 +81,10 @@ module Splash
         return self[:commands]
       end
 
+      def processes
+        return self[:processes]
+      end
+
       def author
         return self[:author]
       end

data/lib/splash/constants.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 module Splash
   module Constants
-    VERSION = "0.5.2"
+    VERSION = "0.5.3"
 
     # the path to th config file, not overridable by config
     CONFIG_FILE = "/etc/splash.yml"
@@ -11,8 +11,10 @@ module Splash
 
     # default scheduling criteria for log monitoring
     DAEMON_LOGMON_SCHEDULING={ :every => '20s'}
-    # default scheduling criteria for log metrics notifications
-    DAEMON_METRICS_SCHEDULING={ :every => '20s'}
+    # default scheduling criteria for  metrics notifications
+    DAEMON_METRICS_SCHEDULING={ :every => '15s'}
+    # default scheduling criteria for process monitoring
+    DAEMON_PROCMON_SCHEDULING={ :every => '20s'}
 
     # the display name of daemon in proc info (ps/top)
     DAEMON_PROCESS_NAME="Splash : daemon."

data/lib/splash/daemon/metrics.rb

@@ -18,21 +18,26 @@ module Splash
       class Manager
 
         attr_reader :execution_count
-        attr_reader :monitoring_count
+        attr_reader :monitoring_logs_count
+        attr_reader :monitoring_processes_count
 
         def initialize
           @config = get_config
           @starttime = Time.now
           @execution_count = 0
-          @monitoring_count = 0
+          @monitoring_logs_count = 0
+          @monitoring_processes_count = 0
+
 
           @registry = Prometheus::Client::Registry::new
           @metric_uptime = Prometheus::Client::Gauge.new(:splash_uptime, docstring: 'SPLASH self metric uptime')
           @metric_execution = Prometheus::Client::Gauge.new(:splash_execution, docstring: 'SPLASH self metric total commands execution count')
-          @metric_monitoring = Prometheus::Client::Gauge.new(:splash_monitoring, docstring: 'SPLASH self metric total logs monitoring count')
+          @metric_logs_monitoring = Prometheus::Client::Gauge.new(:splash_logs_monitoring, docstring: 'SPLASH self metric total logs monitoring count')
+          @metric_processes_monitoring = Prometheus::Client::Gauge.new(:splash_processes_monitoring, docstring: 'SPLASH self metric total processes monitoring count')
           @registry.register(@metric_uptime)
           @registry.register(@metric_execution)
-          @registry.register(@metric_monitoring)
+          @registry.register(@metric_logs_monitoring)
+          @registry.register(@metric_processes_monitoring)
         end
 
 
@@ -45,10 +50,13 @@ module Splash
         end
 
 
-        def inc_monitoring
-          @monitoring_count += 1
+        def inc_logs_monitoring
+          @monitoring_logs_count += 1
         end
 
+        def inc_processes_monitoring
+          @monitoring_processes_count += 1
+        end
 
         def notify
           log = get_logger
@@ -60,7 +68,9 @@ module Splash
           log.debug "Sending Splash self metrics to PushGateway." , session
           @metric_uptime.set uptime
           @metric_execution.set execution_count
-          @metric_monitoring.set monitoring_count
+          @metric_logs_monitoring.set monitoring_logs_count
+          @metric_processes_monitoring.set monitoring_processes_count
+
           hostname = Socket.gethostname
           url = "http://#{@config.prometheus_pushgateway_host}:#{@config.prometheus_pushgateway_port}"
           Prometheus::Client::Push.new('Splash',hostname, url).add(@registry)

data/lib/splash/daemon/orchestrator.rb

@@ -13,6 +13,7 @@ module Splash
         include Splash::Daemon::Orchestrator::Grammar
         include Splash::Loggers
         include Splash::Logs
+        include Splash::Processes
         include Splash::Commands
 
 
@@ -25,28 +26,53 @@ module Splash
           @server  = Rufus::Scheduler::new
           @server.extend SchedulerHooks
           @config = get_config
-          @result = LogScanner::new
+
           @log.info "Splash Orchestrator starting :"
           if options[:scheduling] then
             @log.item "Initializing commands Scheduling."
             init_commands_scheduling
           end
-          sched,value = @config.daemon_logmon_scheduling.flatten
-          @log.item "Initializing logs monitorings & notifications."
-          @server.send sched,value do
-            begin
-              session = get_session
-              @metric_manager.inc_monitoring
-              @log.trigger "Logs monitoring for Scheduling : #{sched.to_s} #{value.to_s}", session
-              @result.analyse
-              @result.notify :session => session
-            rescue Errno::ECONNREFUSED
-              @log.error "PushGateway seems to be done, please start it.", session
+
+          if @config.logs.empty? then
+            @log.item "No logs to monitor"
+          else
+            sched,value = @config.daemon_procmon_scheduling.flatten
+            @log.item "Initializing logs monitorings & notifications."
+            @log_result = LogScanner::new
+            @server.send sched,value do
+              begin
+                session = get_session
+                @metric_manager.inc_logs_monitoring
+                @log.trigger "Logs monitoring for Scheduling : #{sched.to_s} #{value.to_s}", session
+                @log_result.analyse
+                @log_result.notify :session => session
+              rescue Errno::ECONNREFUSED
+                @log.error "PushGateway seems to be done, please start it.", session
+              end
+            end
+          end
+
+          if @config.processes.empty? then
+            @log.item "No processes to monitor"
+          else
+            sched,value = @config.daemon_logmon_scheduling.flatten
+            @log.item "Initializing processes monitorings & notifications."
+            @process_result = ProcessScanner::new
+            @server.send sched,value do
+              begin
+                session = get_session
+                @metric_manager.inc_processes_monitoring
+                @log.trigger "Processes monitoring for Scheduling : #{sched.to_s} #{value.to_s}", session
+                @process_result.analyse
+                @process_result.notify :session => session
+              rescue Errno::ECONNREFUSED
+                @log.error "PushGateway seems to be done, please start it.", session
+              end
             end
           end
 
-          sched,value = @config.daemon_metrics_scheduling.flatten
 
+          sched,value = @config.daemon_metrics_scheduling.flatten
           @log.item "Initializing Splash metrics notifications."
           @server.send sched,value do
             begin

data/lib/splash/dependencies.rb

@@ -48,6 +48,8 @@ module Splash
 
     require 'splash/commands'
     require 'splash/logs'
+    require 'splash/processes'
+    
     require 'splash/daemon'
 
 

data/lib/splash/helpers.rb

@@ -17,7 +17,8 @@ module Splash
     # @param [Hash] options
     # @option options [String] :pattern un motif de regexp
     # @option options [Array] :patterns Un tableau de motif de regexp
-    # @return [String] le PID
+    # @option options [Bool] :full renvoie tout les details si True
+    # @return [String|Array] le PID or tout les détails
     def get_processes(options = {})
       patterns = []
       patterns  = options[:patterns] if options[:patterns]
@@ -26,7 +27,11 @@ module Splash
       patterns.each do |item|
         res = res.find_processes item
       end
-      return res.pick_attr('PID')
+      if options[:full] then
+        return res
+      else
+        return res.pick_attr('PID')
+      end
     end
 
 

data/lib/splash/processes.rb

@@ -0,0 +1,71 @@
+module Splash
+  module Processes
+    class ProcessScanner
+      include Splash::Constants
+      include Splash::Config
+
+
+      # LogScanner Constructor
+      # return [LogScanner]
+      def initialize
+        @processes_target = get_config.processes
+        @config = get_config
+        @registry = Prometheus::Client::Registry::new
+        @metric_status = Prometheus::Client::Gauge.new(:process_status, docstring: 'SPLASH metric process status', labels: [:process ])
+        @metric_cpu_percent = Prometheus::Client::Gauge.new(:process_cpu_percent, docstring: 'SPLASH metric process CPU usage in percent', labels: [:process ])
+        @metric_mem_percent = Prometheus::Client::Gauge.new(:process_mem_percent, docstring: 'SPLASH metric process MEM usage in percent', labels: [:process ])
+        @registry.register(@metric_status)
+        @registry.register(@metric_cpu_percent)
+        @registry.register(@metric_mem_percent)
+
+      end
+
+
+      # start log analyse for log target in config
+      def analyse
+        @processes_target.each do |record|
+          list =  get_processes patterns: record[:patterns], full: true
+          if list.empty?
+            record[:status] = :inexistant
+            record[:cpu] = 0
+            record[:mem] = 0
+          else
+            record[:status] = :running
+            record[:cpu] = list[0]['%CPU']
+            record[:mem] = list[0]['%MEM']
+          end
+        end
+        return {:case => :quiet_exit }
+      end
+
+      # pseudo-accessor on @processes_target
+      def output
+        return @processes_target
+      end
+
+      # start notification on prometheus for metrics
+      def notify(options = {})
+        log = get_logger
+        unless verify_service host: @config.prometheus_pushgateway_host ,port: @config.prometheus_pushgateway_port then
+          return  { :case => :service_dependence_missing, :more => "Prometheus Notification not send." }
+        end
+        session = (options[:session]) ? options[:session] : log.get_session
+        log.info "Sending metrics to Prometheus Pushgateway", session
+        @processes_target.each do |item|
+          missing = (item[:status] == :missing)? 1 : 0
+          log.item "Sending metrics for #{item[:process]}", session
+          val = (item[:status] == :running )? 1 : 0
+          @metric_status.set(val, labels: { process: item[:process] })
+          @metric_cpu_percent.set(item[:cpu], labels: { process: item[:process] })
+          @metric_mem_percent.set(item[:mem], labels: { process: item[:process] })
+        end
+        hostname = Socket.gethostname
+        url = "http://#{@config.prometheus_pushgateway_host}:#{@config.prometheus_pushgateway_port}"
+        Prometheus::Client::Push.new('Splash',hostname, url).add(@registry)
+        log.ok "Sending to Prometheus PushGateway done.", session
+        return {:case => :quiet_exit }
+      end
+
+    end
+  end
+end

data/prometheus-splash.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = [Splash::Constants::EMAIL]
   spec.description   = %q{Prometheus Logs and Batchs supervision over PushGateway and commands orchestration}
   spec.summary       = %q{Supervision with Prometheus of Logs and Asynchronous tasks orchestration for Services or Hosts }
-  spec.homepage      = "http://www.ultragreen.net"
+  spec.homepage      = "https://github.com/Ultragreen/prometheus-splash"
   spec.license       = Splash::Constants::LICENSE
   spec.require_paths << 'bin'
   spec.bindir = 'bin'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-splash
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Romain GEORGES
@@ -265,6 +265,7 @@ files:
 - lib/splash/cli/daemon.rb
 - lib/splash/cli/documentation.rb
 - lib/splash/cli/logs.rb
+- lib/splash/cli/process.rb
 - lib/splash/commands.rb
 - lib/splash/config.rb
 - lib/splash/config/flush.rb
@@ -286,6 +287,7 @@ files:
 - lib/splash/loggers/daemon.rb
 - lib/splash/loggers/dual.rb
 - lib/splash/logs.rb
+- lib/splash/processes.rb
 - lib/splash/templates.rb
 - lib/splash/transports.rb
 - lib/splash/transports/rabbitmq.rb
@@ -317,7 +319,7 @@ files:
 - templates/splashd.service
 - test.sh
 - ultragreen_roodi_coding_convention.yml
-homepage: http://www.ultragreen.net
+homepage: https://github.com/Ultragreen/prometheus-splash
 licenses:
 - BSD-2-Clause
 metadata: {}