prometheus-splash 0.7.0 → 0.8.4

data/lib/splash/commands.rb

@@ -6,6 +6,78 @@ module Splash
   # Splash Commands module/namespace
   module Commands
 
+
+    class CmdNotifier
+
+      @@registry = Prometheus::Client::Registry::new
+      @@metric_exitcode = Prometheus::Client::Gauge.new(:exitcode, docstring: 'SPLASH metric batch exitcode')
+      @@metric_time = Prometheus::Client::Gauge.new(:exectime, docstring: 'SPLASH metric batch execution time')
+      @@registry.register(@@metric_exitcode)
+      @@registry.register(@@metric_time)
+
+
+
+      def initialize(options={})
+        @config = get_config
+        @url = @config.prometheus_pushgateway_url
+        @name = "cmd_#{options[:name].to_s}"
+        @exitcode = options[:exitcode]
+        @time = options[:time]
+      end
+
+      # send metrics to Prometheus PushGateway
+      # @return [Bool]
+      def notify
+        unless verify_service url: @url then
+          return { :case => :service_dependence_missing, :more => "Prometheus Notification not send."}
+        end
+        @@metric_exitcode.set(@exitcode)
+        @@metric_time.set(@time)
+        hostname = Socket.gethostname
+        return Prometheus::Client::Push.new(@name, hostname, @url).add(@@registry)
+      end
+
+    end
+
+
+    class CmdRecords
+      include Splash::Backends
+      include Splash::Constants
+      def initialize(name)
+        @name = name
+        @backend = get_backend :execution_trace
+      end
+
+      def purge(retention)
+        retention = {} if retention.nil?
+        if retention.include? :hours then
+          adjusted_datetime = DateTime.now - retention[:hours].to_f / 24
+        elsif retention.include? :hours then
+          adjusted_datetime = DateTime.now - retention[:days].to_i
+        else
+          adjusted_datetime = DateTime.now - DEFAULT_RETENTION
+        end
+
+        data = get_all_records
+
+        data.delete_if { |item|
+          DateTime.parse(item.keys.first) <= (adjusted_datetime)}
+        @backend.put key: @name, value: data.to_yaml
+      end
+
+      def add_record(record)
+        data = get_all_records
+        data.push({ DateTime.now.to_s => record })
+        @backend.put key: @name, value: data.to_yaml
+      end
+
+      def get_all_records(options={})
+        return (@backend.exist?({key: @name}))? YAML::load(@backend.get({key: @name})) : []
+      end
+
+    end
+
+
     # command execution wrapper
     class CommandWrapper
       include Splash::Templates
@@ -16,11 +88,7 @@ module Splash
       include Splash::Transports
 
 
-      @@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)
+
 
       # Constructor
       # @param [String] name the name of the command
@@ -43,14 +111,17 @@ module Splash
       # @param [String] value numeric.to_s
       # @param [String] time execution time numeric.to_s
       # @return [Hash] Exiter case :quiet_exit
-      def notify(value,time)
+      def notify(value,time, session)
+        log = get_logger
         unless verify_service url: @config.prometheus_pushgateway_url then
           return { :case => :service_dependence_missing, :more => "Prometheus Notification not send."}
         end
-        @@metric_exitcode.set(value)
-        @@metric_time.set(time)
-        hostname = Socket.gethostname
-        Prometheus::Client::Push.new(@name, hostname, @url).add(@@registry)
+        cmdmonitor = CmdNotifier::new({name: @name, exitcode: value, time: time})
+        if cmdmonitor.notify then
+          log.ok "Sending metrics to Prometheus Pushgateway",session
+        else
+          log.ko "Failed to send metrics to Prometheus Pushgateway",session
+        end
         return { :case => :quiet_exit}
       end
 
@@ -110,9 +181,6 @@ module Splash
               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
@@ -123,17 +191,15 @@ module Splash
             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
+            cmdrec = CmdRecords::new @name
+            cmdrec.purge(@config.commands[@name.to_sym][:retention])
+            cmdrec.add_record data
             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
+            acase = notify(exit_code,time.to_i,session)
           else
             log.item "Without Prometheus notification", session
           end

data/lib/splash/config.rb

@@ -11,56 +11,127 @@ module Splash
     include Splash::ConfigUtilities
 
 
+    class ConfigLinter
+      def initialize
+        @lints_present = {:logs => [:label, :log, :pattern ],
+                          :processes => [:process, :patterns ]}
+        @lints_types = {:logs => {:label => Symbol, :log => String, :pattern => String, :retention => Hash},
+                        :processes  => {:process => Symbol, :patterns => Array, :retention => Hash}}
+      end
+
+      def verify(options ={})
+        status = :success
+        missings = []
+        type_errors = []
+        useless = []
+        options[:record].each do |key,value|
+          useless.push key unless @lints_present[options[:type]].include? key or @lints_types[options[:type]].keys.include? key
+          type_errors.push key if @lints_types[options[:type]][key] != value.class and (@lints_present[options[:type]].include? key or @lints_types[options[:type]].keys.include? key)
+        end
+        @lints_present[options[:type]].each do |item|
+          missings.push item unless options[:record].keys.include? item
+        end
+
+        status = :failure if (missings.count > 0) or (type_errors.count > 0)
+        return {:missings => missings, :type_errors => type_errors, :useless => useless, :status => status}
+      end
+
+    end
+
     # Class to manage configuration in Splash from Splash::Constants override by Yaml CONFIG
     class Configuration < Hash
       include Splash::Constants
 
+      attr_accessor :config_from_file
+
       # constructor : read config file and map against Constants
       def initialize(config_file=CONFIG_FILE)
-        config_from_file = readconf config_file
+        @config_file = config_file
+        hash_config_to_default
+
+      end
+
+
+      def hash_config_to_default
+        @config_from_file = readconf @config_file
         self[:version] = VERSION
         self[:author] = "#{AUTHOR} <#{EMAIL}>"
         self[:copyright] = "#{COPYRIGHT} #{LICENSE}"
 
-        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_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_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[: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[: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_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[:execution_template_path] = (@config_from_file[:templates][:execution][:path])? @config_from_file[:templates][:execution][:path] : EXECUTION_TEMPLATE
 
-        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[: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[: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
 
+
+      def add_record(options = {})
+        @config_from_file = readconf @config_file
+        key = options[:key]
+        res = ConfigLinter::new.verify(options)
+        if res[:status] == :success then
+          if @config_from_file[options[:type]].select{|item| item[options[:key]] == options[:record][options[:key]]}.count > 0 then
+            return {:status => :already_exist}
+          else
+            res[:useless].each {|item| options[:record].delete item} if options[:clean]
+            @config_from_file[options[:type]].push options[:record]
+            writeconf
+            hash_config_to_default
+            return {:status => :success}
+          end
+        else
+          return res
+        end
       end
 
+
+      def delete_record(options = {})
+        @config_from_file = readconf @config_file
+        unless @config_from_file[options[:type]].select{|item| item[options[:key]] == options[options[:key]]}.count > 0 then
+          return {:status => :not_found}
+        else
+          @config_from_file[options[:type]].delete_if {|value| options[options[:key]] == value[options[:key]] }
+          writeconf
+          hash_config_to_default
+          return {:status => :success}
+        end
+      end
+
+
       # @!group accessors on configurations Items
 
       # getter for full Config Hash
@@ -87,6 +158,12 @@ module Splash
         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
@@ -105,6 +182,31 @@ module Splash
         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
@@ -215,36 +317,17 @@ module Splash
         return self[:prometheus_pushgateway_url]
       end
 
-      # getter for prometheus_url Config sample
-      # @return [String]
-      def prometheus_url
-        return self[:prometheus_url]
-      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
+      # getter for prometheus_alertmanager_url Config sample
       # @return [String]
-      def daemon_full_pid_path
-        return "#{self[:pid_path]}/#{self[:pid_file]}"
+      def prometheus_alertmanager_url
+        return self[:prometheus_alertmanager_url]
       end
 
-      # 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
 
-      # getter for daemon_full_stderr_trace_path Config sample
+      # getter for prometheus_url Config sample
       # @return [String]
-      def daemon_full_stderr_trace_path
-        return "#{self[:trace_path]}/#{self[:stderr_trace]}"
+      def prometheus_url
+        return self[:prometheus_url]
       end
 
       # @!endgroup
@@ -258,6 +341,16 @@ module Splash
         return YAML.load_file(file)[:splash]
       end
 
+      # write config to file from @config_from_file
+      # @param [String] file default from CONFIG_FILE
+      # @return [Bool] if ok
+      def writeconf(file = CONFIG_FILE)
+        File.open(file,"w") do |f|
+          data = {}
+          data[:splash] = @config_from_file
+          f.write(data.to_yaml)
+        end
+      end
 
     end
 

data/lib/splash/config/flush.rb

@@ -16,8 +16,8 @@ module Splash
       self.extend Splash::Backends
       self.extend Splash::Loggers
       log = get_logger
-      log.info "Splash backend flushing"
-      name  = (options[:name])? options[:name] : :execution_trace
+      name  = (options[:name])? options[:name].to_sym : :execution_trace
+      log.info "Splash backend #{name.to_s} flushing"
       backend = get_backend name
       if backend.flush then
         return { :case => :quiet_exit, :more => "Splash backend #{name.to_s} flushed" }

data/lib/splash/constants.rb

@@ -7,8 +7,7 @@ module Splash
   module Constants
 
     # Current splash version
-    VERSION = "0.7.0"
-
+    VERSION = "0.8.4"
     # the path to th config file, not overridable by config
     CONFIG_FILE = "/etc/splash.yml"
     # the default execution trace_path if backend file
@@ -43,7 +42,10 @@ module Splash
     LICENSE="BSD-2-Clause"
 
     # the default prometheus pushgateway URL
-    PROMETHEUS_PUSHGATEWAY_URL = 'http://localhost:9090/'
+    PROMETHEUS_PUSHGATEWAY_URL = 'http://localhost:9091/'
+
+    # the default prometheus Alertmanager URL
+    PROMETHEUS_ALERTMANAGER_URL = 'http://localhost:9092/'
 
     # the default prometheus URL
     PROMETHEUS_URL = "http://localhost:9090/"
@@ -84,6 +86,8 @@ module Splash
     # the default sdterr trace file
     WEBADMIN_STDERR_TRACE="stderr.txt"
 
+    # default retention for trace
+    DEFAULT_RETENTION=1
 
   end
 end

data/lib/splash/daemon/metrics.rb

@@ -17,8 +17,8 @@ module Splash
 
       # metrics manager factory
       # @return [Splash::Daemon::Metrics::Manager]
-      def get_metrics_manager
-        return @@manager ||= Manager::new
+      def get_metrics_manager(session)
+        return @@manager ||= Manager::new(:session => session)
       end
 
       # Metrics Manager (collect and sending to Prometheus)
@@ -32,7 +32,8 @@ module Splash
         attr_reader :monitoring_processes_count
 
         # Constructor prepare prometheus-client, defined metrics and init attributes
-        def initialize
+        def initialize(options ={})
+          @session = options[:session]
           @config = get_config
           @starttime = Time.now
           @execution_count = 0
@@ -75,12 +76,11 @@ module Splash
         # @return [Hash] Exiter case ( :service_dependence_missing , :quiet_exit)
         def notify
           log = get_logger
-          session  = get_session
           unless verify_service url: @config.prometheus_pushgateway_url then
             return  { :case => :service_dependence_missing, :more => "Prometheus Notification not send." }
           end
 
-          log.debug "Sending Splash self metrics to PushGateway." , session
+          log.ok "Sending Splash self metrics to PushGateway." , @session
           @metric_uptime.set uptime
           @metric_execution.set execution_count
           @metric_logs_monitoring.set monitoring_logs_count
@@ -89,7 +89,7 @@ module Splash
           hostname = Socket.gethostname
           url = @config.prometheus_pushgateway_url
           Prometheus::Client::Push.new('Splash',hostname, url).add(@registry)
-          log.debug "Sending to Prometheus PushGateway done.", session
+          log.debug "Sending to Prometheus PushGateway done.", @session
           return {:case => :quiet_exit }
         end