prometheus-splash 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d510e4761e365c1ee36881fb1a3a4a99a7dbe7965958841497cdcaaadfb0c1b3
-  data.tar.gz: 4f01f486135696ef0142d42362379e59868b1265ce367b3e3aac9853fcc48336
+  metadata.gz: 5fd95d116c0f265b310c0ea710e909ab4022a5920c3c234524f2a1dcf9d21d0e
+  data.tar.gz: e21840114c3ea30be45b3766a14f00991b2a6629a44084ff6898ae39d88090c6
 SHA512:
-  metadata.gz: 8b5c84b54b2098f9b027408ab8419fb19964feb1056607d090802acc793c2ccd6a9b98c1c8c2ca91334ccc8a36de88c1bf6cd674b6f5ef9df33a40debbfe84f5
-  data.tar.gz: 1d93b819d8a9592495271a24bdc3e69e63a15489f5885faa729a8e42428a68dada73748ea8440c1338625a36c89d84a260e3bc9cdafa8fb869747864edc001f4
+  metadata.gz: ae5a2ed4a5100284605b7688e73f3fb59d008a7be9ce6e4050bfc5b9656663e4c2bb72f24f962b98544702a2bf0f2d889f6bd757a12ecb22c52a085cb70857b3
+  data.tar.gz: f9cf202cb9d0818e164fb35c705ab1593ae77e6ce28d06dc18d095d6e7c8c46cb45854f8bad0a661e0edba8f145acbc850ea5163e734b54094cfa50d4db5836b

data/CHANGELOG.md

@@ -81,3 +81,34 @@
 * quiet mode + no-colors and no-emoji #5
 * correlation id in log for daemon #15
 * systemd Splashd service installation #32
+
+
+## V 0.5.1 2020/04/17
+
+### CHANGES
+
+* short Alias for commands without --no-[xxxx] #38
+* REFACTO : namespaces
+ * Splash::Commands
+ * Splash::Log
+ * Splash::Daemon
+ * Splash::Daemon::Orchestrator
+
+
+### FEATURES
+
+* flush backend arg in config #41
+* adding global --debug flag
+* adding splash Daemon metrics #25
+
+### DOC
+
+* default value of mon scheduling 20s => 1m in ansible splash.yml
+
+
+### FIX
+
+* Ansible Splash role handler error
+* Ansible Splash role logrotate copytruncate for splash logs
+* Prometheus Registry mismatch=> cumulative metrics on each groups #42
+* logger Dual level conservation #43

data/config/splash.yml

@@ -34,6 +34,8 @@
   :daemon:
     :logmon_scheduling:
       :every: 20s
+    :metrics_scheduling:
+      :every: 20s
     :process_name: "Splash : daemon."
     :paths:
       :pid_path: /var/run/splash

data/lib/splash/backends/file.rb

@@ -36,6 +36,10 @@ module Splash
         return ::File.exist?("#{@path}/#{suffix_trace(options[:key])}")
       end
 
+      def flush
+        Dir.glob("#{@path}/*.trace").each { |file| ::File.delete(file)}
+      end
+
       private
       def suffix_trace(astring)
         return "#{astring}.trace"

data/lib/splash/backends/redis.rb

@@ -9,7 +9,7 @@ module Splash
         conf = { :host => @config[:host], :port => @config[:port], :db => @config[:base].to_i}
         conf[:password] = @config[:auth] if @config[:auth]
         @store = ::Redis.new conf
-        @redis_cli_cmd = `which redis-cli`
+        #@redis_cli_cmd = `which redis-cli`
         @store.auth(@config[:auth]) if @config[:auth]
       end
 
@@ -37,8 +37,8 @@ module Splash
       end
 
       def flush
-        `#{@redis_cli_cmd} -n 3 flushdb`
-        # @@store.flushdb
+        #`#{@redis_cli_cmd} -n #{@config[:base]} flushdb`
+        @store.flushdb
       end
 
       def exist?(options)

data/lib/splash/cli.rb

@@ -11,14 +11,16 @@ class CLI < Thor
     super
     log = get_logger
     options[:colors.to_s]
+    log.level = :debug if options[:debug]
     log.emoji  = options[:emoji.to_s]
     log.color  = options[:colors.to_s]
+    log.debug  "DEBUG activated" if options[:debug]
   end
 
   class_option :quiet, :desc => "Quiet mode, limit output to :fatal", :aliases => "-q", :type => :boolean
   class_option :emoji, :desc => "Display Emoji", :type => :boolean, :default => true
   class_option :colors, :desc => "Display colors", :type => :boolean, :default => true
-
+  class_option :debug, :desc => "Set log level to :debug", :aliases => "-d", :type => :boolean
 
 
   include CLISplash

data/lib/splash/cli/commands.rb

@@ -9,6 +9,7 @@ module CLISplash
     include Splash::Transports
     include Splash::Templates
     include Splash::Loggers
+    include Splash::Commands
 
     desc "execute NAME", "run for command/sequence or ack result"
     long_desc <<-LONGDESC
@@ -21,10 +22,10 @@ module CLISplash
     with --hostname, execute on an other Splash daemon node
     LONGDESC
     option :trace, :type => :boolean, :default => true
-    option :ack, :type => :boolean, negate: false
+    option :ack, :type => :boolean, negate: false,  :aliases => "-a"
     option :notify, :type => :boolean, :default => true
     option :callback, :type => :boolean, :default => true
-    option :hostname, :type => :string
+    option :hostname, :type => :string,  :aliases => "-H"
     def execute(name)
       log = get_logger
       log.level = :fatal if options[:quiet]
@@ -60,7 +61,7 @@ module CLISplash
           res[:more] = "Remote command : :execute_command Scheduled"
           splash_exit res
         else
-          command =  Splash::CommandWrapper::new(name)
+          command =  CommandWrapper::new(name)
           if options[:ack] then
             splash_exit command.ack
           end
@@ -83,7 +84,7 @@ module CLISplash
     WARNING : scheduling by CLI are not percisted, so use it only for specifics cases.\n
     NOTES : Scheduling, force trace, notifying and callback.
     LONGDESC
-    option :hostname, :type => :string, :default => Socket.gethostname
+    option :hostname, :type => :string, :default => Socket.gethostname,  :aliases => "-H"
     option :at, :type => :string
     option :in, :type => :string
     def schedule(name)
@@ -121,7 +122,7 @@ module CLISplash
     Show commands sequence tree\n
     with --hostname, ask other Splash daemon via transport\n
     LONGDESC
-    option :hostname, :type => :string
+    option :hostname, :type => :string,  :aliases => "-H"
     def treeview(command)
       depht = 0
       log  = get_logger
@@ -169,8 +170,8 @@ module CLISplash
     with --detail, show command details\n
     with --hostname, ask other Splash daemon via transport\n
     LONGDESC
-    option :detail, :type => :boolean
-    option :hostname, :type => :string
+    option :detail, :type => :boolean,  :aliases => "-D"
+    option :hostname, :type => :string,  :aliases => "-H"
     def list
       log = get_logger
       list = {}
@@ -218,7 +219,7 @@ module CLISplash
     Show specific configured command COMMAND\n
     with --hostname <HOSTNAME>, an other Splash monitored server (only with Redis backend configured)
     LONGDESC
-    option :hostname, :type => :string
+    option :hostname, :type => :string,  :aliases => "-H"
     def show(command)
       log = get_logger
       list = {}
@@ -264,7 +265,7 @@ module CLISplash
     Show last running result for specific configured command COMMAND\n
     with --hostname <HOSTNAME>, an other Splash monitored server (only with Redis backend configured)
     LONGDESC
-    option :hostname, :type => :string
+    option :hostname, :type => :string,  :aliases => "-H"
     def lastrun(command)
       log = get_logger
       backend = get_backend :execution_trace
@@ -307,10 +308,10 @@ module CLISplash
     with --detail, get major informations of each reports\n
     --all and --hostname are exclusives
     LONGDESC
-    option :pattern, :type => :string
-    option :hostname, :type => :string
-    option :all, :type => :boolean, :negate => false
-    option :detail, :type => :boolean
+    option :pattern, :type => :string, :aliases => "-p"
+    option :hostname, :type => :string,  :aliases => "-H"
+    option :all, :type => :boolean, :negate => false,  :aliases => "-A"
+    option :detail, :type => :boolean,  :aliases => "-D"
     def getreportlist
       log = get_logger
       options[:hostname] = Socket.gethostname if options[:hostname] == 'hostname'

data/lib/splash/cli/config.rb

@@ -13,7 +13,7 @@ module CLISplash
     Setup installation fo Splash\n
     with --preserve, preserve from reinstallation of the config
     LONGDESC
-    option :preserve, :type => :boolean
+    option :preserve, :type => :boolean,  :aliases => "-P"
     def setup
       acase = run_as_root :setupsplash, options
       splash_exit acase
@@ -40,6 +40,12 @@ module CLISplash
       splash_exit acase
     end
 
+    desc "flushbackend", "Flush configured backend"
+    def flushbackend
+      acase = run_as_root :flush_backend
+      splash_exit acase
+    end
+
 
   end
 

data/lib/splash/cli/daemon.rb

@@ -2,13 +2,13 @@
 module CLISplash
 
   class CLIController < Thor
-    include Splash::LogsMonitor::DaemonController
+    include Splash::Daemon::Controller
     include Splash::Transports
     include Splash::Exiter
     include Splash::Loggers
 
 
-    option :foreground, :type => :boolean
+    option :foreground, :type => :boolean,  :aliases => "-F"
     option :purge, :type => :boolean, default: true
     option :scheduling, :type => :boolean, default: true
     long_desc <<-LONGDESC

data/lib/splash/cli/logs.rb

@@ -4,12 +4,13 @@ module CLISplash
   class Logs < Thor
     include Splash::Config
     include Splash::Exiter
+    include Splash::Logs
 
 
     desc "analyse", "analyze logs in config"
     def analyse
       log  = get_logger
-      results = Splash::LogScanner::new
+      results = LogScanner::new
       res = results.analyse
       log.info "SPlash Configured logs status :"
       full_status = true
@@ -42,7 +43,7 @@ module CLISplash
     def monitor
       log = get_logger
       log.level = :fatal if options[:quiet]
-      result = Splash::LogScanner::new
+      result = LogScanner::new
       result.analyse
       splash_exit result.notify
 
@@ -67,7 +68,7 @@ module CLISplash
     Show configured logs monitoring\n
     with --detail, show logs monitor details
     LONGDESC
-    option :detail, :type => :boolean
+    option :detail, :type => :boolean,  :aliases => "-D"
     def list
       log = get_logger
       log.info "Splash configured log monitoring :"

data/lib/splash/commands.rb

@@ -1,146 +1,148 @@
 # coding: utf-8
 module Splash
-  class CommandWrapper
-    include Splash::Templates
-    include Splash::Config
-    include Splash::Helpers
-    include Splash::Backends
-    include Splash::Exiter
-    include Splash::Transports
+  module Commands
+    class CommandWrapper
+      include Splash::Templates
+      include Splash::Config
+      include Splash::Helpers
+      include Splash::Backends
+      include Splash::Exiter
+      include Splash::Transports
 
 
-    @@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)
+      @@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 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"
+      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
-    end
 
-    def ack
-      get_logger.info "Sending ack for command : '#{@name}'"
-      notify(0,0)
-    end
+      def ack
+        get_logger.info "Sending ack for command : '#{@name}'"
+        notify(0,0)
+      end
 
-    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."}
+      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."}
+        end
+        @@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
-      @@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
 
 
-    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
+      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
           end
-        end
-      else
-        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
+          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
-            system("#{@config.commands[@name.to_sym][:command]} > /dev/null 2>&1")
+            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
+
+            backend.put key: key, value: data.to_yaml
+            exit_code = status.exitstatus
           end
-          time = Time.now - start
-          exit_code = $?.exitstatus
-        else
-          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]}")
+          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
-            stdout, stderr, status = Open3.capture3(@config.commands[@name.to_sym][:command])
+            log.item "Without Prometheus notification", session
           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", 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
-          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
-        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."}
+        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
-        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."}
+          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", session
+        acase[:exit_code] = exit_code
+        return acase
       end
-      acase[:exit_code] = exit_code
-      return acase
     end
   end
 end