prometheus-splash 0.5.2 → 0.8.0

data/lib/splash/commands.rb

@@ -1,6 +1,12 @@
 # coding: utf-8
+
+# base Splash module
 module Splash
+
+  # Splash Commands module/namespace
   module Commands
+
+    # command execution wrapper
     class CommandWrapper
       include Splash::Templates
       include Splash::Config
@@ -16,22 +22,29 @@ module Splash
       @@registry.register(@@metric_exitcode)
       @@registry.register(@@metric_time)
 
+      # Constructor
+      # @param [String] name the name of the command
       def initialize(name)
         @config  = get_config
-        @url = "http://#{@config.prometheus_pushgateway_host}:#{@config.prometheus_pushgateway_port}"
+        @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
 
+      # wrapper for ack command ( return 0 to prometheus via notify)
       def ack
         get_logger.info "Sending ack for command : '#{@name}'"
         notify(0,0)
       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 host: @config.prometheus_pushgateway_host ,port: @config.prometheus_pushgateway_port then
+        unless verify_service url: @config.prometheus_pushgateway_url then
           return { :case => :service_dependence_missing, :more => "Prometheus Notification not send."}
         end
         @@metric_exitcode.set(value)
@@ -41,7 +54,15 @@ module Splash
         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
@@ -63,6 +84,8 @@ module Splash
               log.receive "return with exitcode #{exit_code}", session
 
             end
+          rescue Interrupt
+            splash_exit case: :interrupt, more: "Remote command exection"
           end
         else
           log.info "Executing command : '#{@name}' ", session
@@ -115,7 +138,6 @@ module Splash
             log.item "Without Prometheus notification", session
           end
         end
-
         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

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,107 +15,259 @@ 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[:prometheus_alertmanager_url] = (config_from_file[:prometheus][:alertmanager])? config_from_file[:prometheus][:alertmanager] : PROMETHEUS_ALERTMANAGER_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[:daemon_pid_file] = (config_from_file[:daemon][:files][:pid_file])? config_from_file[:daemon][:files][:pid_file] : DAEMON_PID_FILE
+        self[:daemon_stdout_trace] = (config_from_file[:daemon][:files][:stdout_trace])? config_from_file[:daemon][:files][:stdout_trace] : DAEMON_STDOUT_TRACE
+        self[:daemon_stderr_trace] = (config_from_file[:daemon][:files][:stderr_trace])? config_from_file[:daemon][:files][:stderr_trace] : DAEMON_STDERR_TRACE
+
+
+        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[:paths][:pid_path])? config_from_file[:paths][:pid_path] : PID_PATH
+        self[:trace_path] = (config_from_file[:paths][:trace_path])? config_from_file[: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
 
         self[:transports] = {} ; self[:transports].merge! TRANSPORTS_STRUCT ; self[:transports].merge! config_from_file[:transports] if config_from_file[:transports]
         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] : {}
+        self[:transfers] = (config_from_file[:transfers])? config_from_file[:transfers] : {}
 
       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 transfers Hash Config sample
+      # @return [Hash]
+      def transfers
+        return self[:transfers]
+      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 daemon_process_name Config sample
+      # @return [String]
+      def daemon_process_name
+        return self[:daemon_process_name]
+      end
+
+
+      # getter for daemon_full_pid_path Config sample
+      # @return [String]
+      def daemon_full_pid_path
+        return "#{self[:pid_path]}/#{self[:daemon_pid_file]}"
+      end
+
+      # getter for daemon_full_stdout_trace_path Config sample
+      # @return [String]
+      def daemon_full_stdout_trace_path
+        return "#{self[:trace_path]}/#{self[:daemon_stdout_trace]}"
+      end
+
+      # getter for daemon_full_stderr_trace_path Config sample
+      # @return [String]
+      def daemon_full_stderr_trace_path
+        return "#{self[:trace_path]}/#{self[:daemon_stderr_trace]}"
+      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]
-      end
 
-      def prometheus_pushgateway_host
-        return self[:prometheus_pushgateway_host]
-      end
-      def prometheus_pushgateway_port
-        return self[:prometheus_pushgateway_port]
-      end
 
-      def full_pid_path
-        return "#{self[:pid_path]}/#{self[:pid_file]}"
+
+
+      # getter for prometheus_pushgateway_url Config sample
+      # @return [String]
+      def prometheus_pushgateway_url
+        return self[:prometheus_pushgateway_url]
       end
 
-      def full_stdout_trace_path
-        return "#{self[:trace_path]}/#{self[:stdout_trace]}"
+      # getter for prometheus_alertmanager_url Config sample
+      # @return [String]
+      def prometheus_alertmanager_url
+        return self[:prometheus_alertmanager_url]
       end
 
-      def full_stderr_trace_path
-        return "#{self[:trace_path]}/#{self[:stderr_trace]}"
+
+      # getter for prometheus_url Config sample
+      # @return [String]
+      def prometheus_url
+        return self[:prometheus_url]
       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
@@ -123,6 +278,7 @@ module Splash
 
 
     @@config=nil
+
     # factory of Configuration Class instance
     # @param [String] config_file the path of the YAML Config file
     # @return [SPlash::Config::Configuration]
@@ -130,7 +286,12 @@ module Splash
       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

data/lib/splash/config/flush.rb

@@ -1,8 +1,16 @@
+# coding: utf-8
+
+# Base Splash module
 module Splash
+
+  # module for Configuration utilities
   module ConfigUtilities
     include Splash::Constants
 
-
+    # clean backend action method
+    # @param [Hash] options
+    # @option options [Symbol] :name the name of the backend (:redis, :file)
+    # @return [Hash] An Exiter case hash (:quiet_exit or :configuration_error)
     def flush_backend(options ={})
       config = get_config
       self.extend Splash::Backends

data/lib/splash/config/sanitycheck.rb

@@ -1,12 +1,17 @@
 # coding: utf-8
+
+# Base Splash module
 module Splash
+
+  # moudle for Configuration utilities
   module ConfigUtilities
     include Splash::Constants
 
 
 
     # Sanitycheck action method for testing installation of Splash
-    # @return [Integer] an errorcode value
+    # @param [Hash] options
+    # @return [Hash] An Exiter case hash (:splash_sanitycheck_success or :splash_sanitycheck_error)
     def checkconfig(options ={})
       self.extend Splash::Loggers
       log = get_logger
@@ -45,7 +50,7 @@ module Splash
       end
 
       target = "Prometheus PushGateway Service running"
-      if verify_service host: config.prometheus_pushgateway_host ,port: config.prometheus_pushgateway_port then
+      if verify_service url: config.prometheus_pushgateway_url then
         log.ok target
       else
         log.ko target

data/lib/splash/config/service.rb

@@ -1,11 +1,18 @@
 # coding: utf-8
 
-
+# Base Splash module
 module Splash
+
+  # moudle for Configuration utilities
   module ConfigUtilities
     include Splash::Constants
     include Splash::Helpers
 
+
+    # clean backend configured
+    # @param [Hash] options
+    # @option options [Symbol] :name the name of the backend (:redis, :file)
+    # @return [Hash] An Exiter case hash (:quiet_exit or :configuration_error)
     def addservice(options = {})
       local_service_file = search_file_in_gem "prometheus-splash", "templates/splashd.service"
       config = get_config