prometheus-splash 0.4.5 → 0.6.1

data/lib/splash/commands.rb

@@ -1,144 +1,170 @@
 # coding: utf-8
+
+# base Splash module
 module Splash
-  class CommandWrapper
-    include Splash::Templates
-    include Splash::Config
-    include Splash::Helpers
-    include Splash::Backends
-    include Splash::Exiter
-    include Splash::Transports
 
+  # Splash Commands module/namespace
+  module Commands
 
-    @@registry = Prometheus::Client.registry
-    @@metric_exitcode = Prometheus::Client::Gauge.new(:errorcode, docstring: 'SPLASH metric batch errorcode')
-    @@metric_time = Prometheus::Client::Gauge.new(:exectime, docstring: 'SPLASH metric batch execution time')
-    @@registry.register(@@metric_exitcode)
-    @@registry.register(@@metric_time)
+    # command execution wrapper
+    class CommandWrapper
+      include Splash::Templates
+      include Splash::Config
+      include Splash::Helpers
+      include Splash::Backends
+      include Splash::Exiter
+      include Splash::Transports
 
-    def initialize(name)
-      @config  = get_config
-      @url = "http://#{@config.prometheus_pushgateway_host}:#{@config.prometheus_pushgateway_port}"
-      @name = name
-      unless @config.commands.keys.include? @name.to_sym then
-        splash_exit case: :not_found, more: "command #{@name} is not defined in configuration"
-      end
-    end
 
-    def ack
-      get_logger.info "Sending ack for command : '#{@name}'"
-      notify(0,0)
-    end
+      @@registry = Prometheus::Client::Registry::new
+      @@metric_exitcode = Prometheus::Client::Gauge.new(:errorcode, docstring: 'SPLASH metric batch errorcode')
+      @@metric_time = Prometheus::Client::Gauge.new(:exectime, docstring: 'SPLASH metric batch execution time')
+      @@registry.register(@@metric_exitcode)
+      @@registry.register(@@metric_time)
 
-    def notify(value,time)
-      unless verify_service host: @config.prometheus_pushgateway_host ,port: @config.prometheus_pushgateway_port then
-        return { :case => :service_dependence_missing, :more => "Prometheus Notification not send."}
+      # Constructor
+      # @param [String] name the name of the command
+      def initialize(name)
+        @config  = get_config
+        @url = @config.prometheus_pushgateway_url
+        @name = name
+        unless @config.commands.keys.include? @name.to_sym then
+          splash_exit case: :not_found, more: "command #{@name} is not defined in configuration"
+        end
       end
-      @@metric_exitcode.set(value)
-      @@metric_time.set(time)
-      hostname = Socket.gethostname
-      Prometheus::Client::Push.new(@name, hostname, @url).add(@@registry)
-      get_logger.ok "Prometheus Gateway notified."
-      return { :case => :quiet_exit}
-    end
 
+      # wrapper for ack command ( return 0 to prometheus via notify)
+      def ack
+        get_logger.info "Sending ack for command : '#{@name}'"
+        notify(0,0)
+      end
 
-    def call_and_notify(options)
-      log = get_logger
-      acase = { :case => :quiet_exit }
-      exit_code = 0
-      if @config.commands[@name.to_sym][:delegate_to] then
-        return { :case => :options_incompatibility, :more => '--hostname forbidden with delagate commands'} if options[:hostname]
-        log.send "Remote command : #{@name} execution delegate to : #{@config.commands[@name.to_sym][:delegate_to][:host]} as : #{@config.commands[@name.to_sym][:delegate_to][:remote_command]}"
-        begin
-          transport = get_default_client
-          if transport.class == Hash  and transport.include? :case then
-            return transport
-          else
-            res = transport.execute({ :verb => :execute_command,
-              payload: {:name => @config.commands[@name.to_sym][:delegate_to][:remote_command].to_s},
-              :return_to => "splash.#{Socket.gethostname}.return",
-              :queue => "splash.#{@config.commands[@name.to_sym][:delegate_to][:host]}.input" })
-            exit_code = res[:exit_code]
-            log.receive "return with exitcode #{exit_code}"
-
-          end
+      # send metrics to Prometheus PushGateway
+      # @param [String] value numeric.to_s
+      # @param [String] time execution time numeric.to_s
+      # @return [Hash] Exiter case :quiet_exit
+      def notify(value,time)
+        unless verify_service url: @config.prometheus_pushgateway_url then
+          return { :case => :service_dependence_missing, :more => "Prometheus Notification not send."}
         end
-      else
-        log.info "Executing command : '#{@name}' "
-        start = Time.now
-        start_date = DateTime.now.to_s
-        unless options[:trace] then
-          log.item "Traceless execution"
-          if @config.commands[@name.to_sym][:user] then
-            log.item "Execute with user : #{@config.commands[@name.to_sym][:user]}."
-            system("sudo -u #{@config.commands[@name.to_sym][:user]} #{@config.commands[@name.to_sym][:command]} > /dev/null 2>&1")
-          else
-            system("#{@config.commands[@name.to_sym][:command]} > /dev/null 2>&1")
+        @@metric_exitcode.set(value)
+        @@metric_time.set(time)
+        hostname = Socket.gethostname
+        Prometheus::Client::Push.new(@name, hostname, @url).add(@@registry)
+        return { :case => :quiet_exit}
+      end
+
+      # execute commands or sequence via callbacks, remote or not, notify prometheus, templatize report to backends
+      # the big cheese
+      # @param [Hash] options
+      # @option options [String] :session a number of session in case of Daemon Logger
+      # @option options [String] :hostname for remote execution (can't be use with commands with delegate_to)
+      # @option options [Boolean] :notify to activate prometheus notifications
+      # @option options [Boolean] :trace to activate execution report
+      # @option options [Boolean] :callback to activate sequence and callbacks executions
+      # @return [Hash] Exiter case
+      def call_and_notify(options)
+        log = get_logger
+        session = (options[:session])? options[:session] : get_session
+        acase = { :case => :quiet_exit }
+        exit_code = 0
+        if @config.commands[@name.to_sym][:delegate_to] then
+          return { :case => :options_incompatibility, :more => '--hostname forbidden with delagate commands'} if options[:hostname]
+          log.send "Remote command : #{@name} execution delegate to : #{@config.commands[@name.to_sym][:delegate_to][:host]} as : #{@config.commands[@name.to_sym][:delegate_to][:remote_command]}", session
+          begin
+            transport = get_default_client
+            if transport.class == Hash  and transport.include? :case then
+              return transport
+            else
+              res = transport.execute({ :verb => :execute_command,
+                payload: {:name => @config.commands[@name.to_sym][:delegate_to][:remote_command].to_s},
+                :return_to => "splash.#{Socket.gethostname}.return",
+                :queue => "splash.#{@config.commands[@name.to_sym][:delegate_to][:host]}.input" })
+              exit_code = res[:exit_code]
+              log.receive "return with exitcode #{exit_code}", session
+
+            end
+          rescue Interrupt
+            splash_exit case: :interrupt, more: "Remote command exection"
           end
-          time = Time.now - start
-          exit_code = $?.exitstatus
         else
-          log.item "Tracefull execution"
-          if @config.commands[@name.to_sym][:user] then
-            log.item "Execute with user : #{@config.commands[@name.to_sym][:user]}."
-            stdout, stderr, status = Open3.capture3("sudo -u #{@config.commands[@name.to_sym][:user]} #{@config.commands[@name.to_sym][:command]}")
+          log.info "Executing command : '#{@name}' ", session
+          start = Time.now
+          start_date = DateTime.now.to_s
+          unless options[:trace] then
+            log.item "Traceless execution", session
+            if @config.commands[@name.to_sym][:user] then
+              log.item "Execute with user : #{@config.commands[@name.to_sym][:user]}.", session
+              system("sudo -u #{@config.commands[@name.to_sym][:user]} #{@config.commands[@name.to_sym][:command]} > /dev/null 2>&1")
+            else
+              system("#{@config.commands[@name.to_sym][:command]} > /dev/null 2>&1")
+            end
+            time = Time.now - start
+            exit_code = $?.exitstatus
           else
-            stdout, stderr, status = Open3.capture3(@config.commands[@name.to_sym][:command])
-          end
-          time = Time.now - start
-          tp = Template::new(
-            list_token: @config.execution_template_tokens,
-            template_file: @config.execution_template_path)
-          data = Hash::new
-          data[:start_date] = start_date
-          data[:end_date] = DateTime.now.to_s
-          data[:cmd_name] = @name
-          data[:cmd_line] = @config.commands[@name.to_sym][:command]
-          data[:desc] = @config.commands[@name.to_sym][:desc]
-          data[:status] = status.to_s
-          data[:stdout] = stdout
-          data[:stderr] = stderr
-          data[:exec_time] = time.to_s
-          backend = get_backend :execution_trace
-          key = @name
-          backend.put key: key, value: data.to_yaml
-          exit_code = status.exitstatus
-        end
-        log.ok "Command executed"
-        log.arrow "exitcode #{exit_code}"
-        if options[:notify] then
-          acase = notify(exit_code,time.to_i)
-        else
-          log.item "Without Prometheus notification"
-        end
-      end
+            log.item "Tracefull execution", session
+            if @config.commands[@name.to_sym][:user] then
+              log.item "Execute with user : #{@config.commands[@name.to_sym][:user]}.", session
+              stdout, stderr, status = Open3.capture3("sudo -u #{@config.commands[@name.to_sym][:user]} #{@config.commands[@name.to_sym][:command]}")
+            else
+              stdout, stderr, status = Open3.capture3(@config.commands[@name.to_sym][:command])
+            end
+            time = Time.now - start
+            tp = Template::new(
+              list_token: @config.execution_template_tokens,
+              template_file: @config.execution_template_path)
+            data = Hash::new
+            data[:start_date] = start_date
+            data[:end_date] = DateTime.now.to_s
+            data[:cmd_name] = @name
+            data[:cmd_line] = @config.commands[@name.to_sym][:command]
+            data[:desc] = @config.commands[@name.to_sym][:desc]
+            data[:status] = status.to_s
+            data[:stdout] = stdout
+            data[:stderr] = stderr
+            data[:exec_time] = time.to_s
+            backend = get_backend :execution_trace
+            key = @name
 
-      if options[:callback] then
-        on_failure = (@config.commands[@name.to_sym][:on_failure])? @config.commands[@name.to_sym][:on_failure] : false
-        on_success = (@config.commands[@name.to_sym][:on_success])? @config.commands[@name.to_sym][:on_success] : false
-        if on_failure and exit_code > 0 then
-          log.item "On failure callback : #{on_failure}"
-          if @config.commands.keys.include?  on_failure then
-            @name = on_failure.to_s
-            call_and_notify options
+            backend.put key: key, value: data.to_yaml
+            exit_code = status.exitstatus
+          end
+          log.ok "Command executed", session
+          log.arrow "exitcode #{exit_code}", session
+          if options[:notify] then
+            acase = notify(exit_code,time.to_i)
+            get_logger.ok "Prometheus Gateway notified.",session
           else
-            acase = { :case => :configuration_error , :more => "on_failure call error : #{on_failure} command inexistant."}
+            log.item "Without Prometheus notification", session
           end
         end
-        if on_success and exit_code == 0 then
-          log.item "On success callback : #{on_success}"
-          if @config.commands.keys.include?  on_success then
-            @name = on_success.to_s
-            call_and_notify options
-          else
-            acase = { :case => :configuration_error , :more => "on_success call error : #{on_failure} command inexistant."}
+        if options[:callback] then
+          on_failure = (@config.commands[@name.to_sym][:on_failure])? @config.commands[@name.to_sym][:on_failure] : false
+          on_success = (@config.commands[@name.to_sym][:on_success])? @config.commands[@name.to_sym][:on_success] : false
+          if on_failure and exit_code > 0 then
+            log.item "On failure callback : #{on_failure}", session
+            if @config.commands.keys.include?  on_failure then
+              @name = on_failure.to_s
+              call_and_notify options
+            else
+              acase = { :case => :configuration_error , :more => "on_failure call error : #{on_failure} command inexistant."}
+            end
           end
+          if on_success and exit_code == 0 then
+            log.item "On success callback : #{on_success}", session
+            if @config.commands.keys.include?  on_success then
+              @name = on_success.to_s
+              call_and_notify options
+            else
+              acase = { :case => :configuration_error , :more => "on_success call error : #{on_failure} command inexistant."}
+            end
+          end
+        else
+          log.item "Without callbacks sequences", session
         end
-      else
-        log.item "Without callbacks sequences"
+        acase[:exit_code] = exit_code
+        return acase
       end
-      acase[:exit_code] = exit_code
-      return acase
     end
   end
 end

data/lib/splash/config.rb

@@ -1,7 +1,10 @@
 # coding: utf-8
 Dir[File.dirname(__FILE__) + '/config/*.rb'].each {|file| require file  }
 
+# base Splash Module
 module Splash
+
+  # Config namespace
   module Config
     include Splash::Helpers
     include Splash::Constants
@@ -12,19 +15,37 @@ module Splash
     class Configuration < Hash
       include Splash::Constants
 
+      # constructor : read config file and map against Constants
       def initialize(config_file=CONFIG_FILE)
         config_from_file = readconf config_file
         self[:version] = VERSION
         self[:author] = "#{AUTHOR} <#{EMAIL}>"
         self[:copyright] = "#{COPYRIGHT} #{LICENSE}"
-        self[:prometheus_pushgateway_host] = (config_from_file[:prometheus][:pushgateway][:host])? config_from_file[:prometheus][:pushgateway][:host] : PROMETHEUS_PUSHGATEWAY_HOST
-        self[:prometheus_pushgateway_port] = (config_from_file[:prometheus][:pushgateway][:port])? config_from_file[:prometheus][:pushgateway][:port] : PROMETHEUS_PUSHGATEWAY_PORT
+
+        self[:prometheus_url] = (config_from_file[:prometheus][:url])? config_from_file[:prometheus][:url] : PROMETHEUS_URL
+        self[:prometheus_pushgateway_url] = (config_from_file[:prometheus][:pushgateway])? config_from_file[:prometheus][:pushgateway] : PROMETHEUS_PUSHGATEWAY_URL
+
         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[:webadmin_port] = (config_from_file[:webadmin][:port])? config_from_file[:webadmin][:port] : WEBADMIN_PORT
+        self[:webadmin_ip] = (config_from_file[:webadmin][:ip])? config_from_file[:webadmin][:ip] : WEBADMIN_IP
+        self[:webadmin_proxy] = (config_from_file[:webadmin][:proxy])? config_from_file[:webadmin][:proxy] : WEBADMIN_PROXY
+        self[:webadmin_process_name] = (config_from_file[:webadmin][:process_name])? config_from_file[:webadmin][:process_name] : WEBADMIN_PROCESS_NAME
+        self[:webadmin_pid_file] = (config_from_file[:webadmin][:files][:pid_file])? config_from_file[:webadmin][:files][:pid_file] : WEBADMIN_PID_FILE
+        self[:webadmin_stdout_trace] = (config_from_file[:webadmin][:files][:stdout_trace])? config_from_file[:webadmin][:files][:stdout_trace] : WEBADMIN_STDOUT_TRACE
+        self[:webadmin_stderr_trace] = (config_from_file[:webadmin][:files][:stderr_trace])? config_from_file[:webadmin][:files][:stderr_trace] : WEBADMIN_STDERR_TRACE
+
+
+        self[:pid_path] = (config_from_file[:daemon][:paths][:pid_path])? config_from_file[:daemon][:paths][:pid_path] : PID_PATH
+        self[:trace_path] = (config_from_file[:daemon][:paths][:trace_path])? config_from_file[:daemon][:paths][:trace_path] : TRACE_PATH
+
+
         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
-        self[:trace_path] = (config_from_file[:daemon][:paths][:trace_path])? config_from_file[:daemon][:paths][:trace_path] : TRACE_PATH
         self[:pid_file] = (config_from_file[:daemon][:files][:pid_file])? config_from_file[:daemon][:files][:pid_file] : DAEMON_PID_FILE
         self[:stdout_trace] = (config_from_file[:daemon][:files][:stdout_trace])? config_from_file[:daemon][:files][:stdout_trace] : DAEMON_STDOUT_TRACE
         self[:stderr_trace] = (config_from_file[:daemon][:files][:stderr_trace])? config_from_file[:daemon][:files][:stderr_trace] : DAEMON_STDERR_TRACE
@@ -33,81 +54,206 @@ 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] : {}
+        self[:sequences] = (config_from_file[:sequences])? config_from_file[:sequences] : {}
 
       end
 
       # @!group accessors on configurations Items
 
+      # getter for full Config Hash
+      # @return [Hash]
+      def full
+        return self
+      end
+
+      # getter for loggers Hash Config sample
+      # @return [Hash]
       def loggers
         return self[:loggers]
       end
 
+      # getter for backends Hash Config sample
+      # @return [Hash]
       def backends
         return self[:backends]
       end
 
+      # getter for transports Hash Config sample
+      # @return [Hash]
       def transports
         return self[:transports]
       end
 
+      # getter for daemon_logmon_scheduling Hash Config sample
+      # @return [Hash]
       def daemon_logmon_scheduling
         return self[:daemon_logmon_scheduling]
       end
 
+      # getter for daemon_procmon_scheduling Hash Config sample
+      # @return [Hash]
+      def daemon_procmon_scheduling
+        return self[:daemon_procmon_scheduling]
+      end
+
+      # getter for daemon_metrics_scheduling Hash Config sample
+      # @return [Hash]
+      def daemon_metrics_scheduling
+        return self[:daemon_metrics_scheduling]
+      end
+
+      # getter for execution_template_path Hash Config sample
+      # @return [String]
       def execution_template_path
         return self[:execution_template_path]
       end
+
+      # getter for execution_template_tokens Hash Config sample
+      # @return [Array]
       def execution_template_tokens
         return self[:execution_template_tokens]
       end
+
+
+      # getter for webadmin_port Hash Config sample
+      # @return [Fixnum]
+      def webadmin_port
+        return self[:webadmin_port]
+      end
+
+      # getter for webadmin_ip Hash Config sample
+      # @return [String]
+      def webadmin_ip
+        return self[:webadmin_ip]
+      end
+
+      # getter for webadmin_proxy Hash Config sample
+      # @return [TrueClass|FalseClass]
+      def webadmin_proxy
+        return self[:webadmin_proxy]
+      end
+
+      # getter for webadmin_process_name Config sample
+      # @return [String]
+      def webadmin_process_name
+        return self[:webadmin_process_name]
+      end
+
+      # getter for webadmin_full_pid_path Config sample
+      # @return [String]
+      def webadmin_full_pid_path
+        return "#{self[:pid_path]}/#{self[:webadmin_pid_file]}"
+      end
+
+      # getter for webadmin_full_stdout_trace_path Config sample
+      # @return [String]
+      def webadmin_full_stdout_trace_path
+        return "#{self[:trace_path]}/#{self[:webadmin_stdout_trace]}"
+      end
+
+      # getter for webadmin_full_stderr_trace_path Config sample
+      # @return [String]
+      def webadmin_full_stderr_trace_path
+        return "#{self[:trace_path]}/#{self[:webadmin_stderr_trace]}"
+      end
+
+
+
+
+      # getter for logs Hash Config sample
+      # @return [Hash]
       def logs
         return self[:logs]
       end
 
+      # getter for commands Hash Config sample
+      # @return [Hash]
       def commands
         return self[:commands]
       end
 
+      # getter for processes Hash Config sample
+      # @return [Hash]
+      def processes
+        return self[:processes]
+      end
+
+      # getter for sequences Hash Config sample
+      # @return [Hash]
+      def sequences
+        return self[:sequences]
+      end
+
+      # getter for author Config sample
+      # @return [String]
       def author
         return self[:author]
       end
 
+      # getter for copyright Config sample
+      # @return [String]
       def copyright
         return self[:copyright]
       end
 
+      # getter for version Config sample
+      # @return [String]
       def version
         return self[:version]
       end
 
-      def daemon_process_name
-        return self[:daemon_process_name]
+
+
+
+
+      # getter for prometheus_pushgateway_url Config sample
+      # @return [String]
+      def prometheus_pushgateway_url
+        return self[:prometheus_pushgateway_url]
       end
 
-      def prometheus_pushgateway_host
-        return self[:prometheus_pushgateway_host]
+      # getter for prometheus_url Config sample
+      # @return [String]
+      def prometheus_url
+        return self[:prometheus_url]
       end
-      def prometheus_pushgateway_port
-        return self[:prometheus_pushgateway_port]
+
+
+      # getter for daemon_process_name Config sample
+      # @return [String]
+      def daemon_process_name
+        return self[:daemon_process_name]
       end
 
-      def full_pid_path
+
+      # getter for daemon_full_pid_path Config sample
+      # @return [String]
+      def daemon_full_pid_path
         return "#{self[:pid_path]}/#{self[:pid_file]}"
       end
 
-      def full_stdout_trace_path
+      # getter for daemon_full_stdout_trace_path Config sample
+      # @return [String]
+      def daemon_full_stdout_trace_path
         return "#{self[:trace_path]}/#{self[:stdout_trace]}"
       end
 
-      def full_stderr_trace_path
+      # getter for daemon_full_stderr_trace_path Config sample
+      # @return [String]
+      def daemon_full_stderr_trace_path
         return "#{self[:trace_path]}/#{self[:stderr_trace]}"
       end
 
       # @!endgroup
 
       private
+
+      # read config file
+      # @param [String] file default from CONFIG_FILE
+      # @return [Hash] The config global Hash from YAML
       def readconf(file = CONFIG_FILE)
         return YAML.load_file(file)[:splash]
       end
@@ -115,14 +261,23 @@ module Splash
 
     end
 
+
+
+    @@config=nil
+
     # factory of Configuration Class instance
     # @param [String] config_file the path of the YAML Config file
     # @return [SPlash::Config::Configuration]
     def get_config(config_file=CONFIG_FILE)
-      return Configuration::new config_file
+      return @@config ||= Configuration::new(config_file)
     end
 
-
+    # reset of Configuration Class instance
+    # @param [String] config_file the path of the YAML Config file
+    # @return [SPlash::Config::Configuration]
+    def rehash_config(config_file=CONFIG_FILE)
+      return @@config = Configuration::new(config_file)
+    end
 
 
   end