prometheus-splash 0.5.2 → 0.8.0

data/lib/splash/backends/redis.rb

@@ -1,8 +1,18 @@
 # coding: utf-8
+
+# base Splash Module
 module Splash
+
+  # generic backends module
   module Backends
+
+    # Redis backend definition
     class Redis
       include Splash::Config
+
+      # Constructor
+      # @param [Symbol] store name in [:execution_trace] actually (see config and constants )
+      # @return [Splash::Backends::Redis] a Redis backend
       def initialize(store)
         @hostname = Socket.gethostname
         @config = get_config[:backends][:stores][store]
@@ -13,45 +23,78 @@ module Splash
         @store.auth(@config[:auth]) if @config[:auth]
       end
 
+      # return the list of find records in backend for a specific pattern
+      # @param [String] hostname optionnal (default : local hostname)
+      # @param [String] pattern shell regexp
+      # @return [Array] list of record (for all hostname if hostname is specified)
       def list(pattern='*', hostname = @hostname)
          return @store.keys("#{hostname}##{pattern}").map{|item| item = remove_hostname(item)}
       end
 
+      # return the list of find records in backend for a specific pattern, without hostname Checking
+      # Redis Backend specific method
+      # @param [String] pattern shell regexp
+      # @return [Array] list of record (for all hostname if hostname is specified)
       def listall(pattern='*')
          return @store.keys(pattern)
       end
 
+      # return value of queried record
+      # @param [Hash] options
+      # @option options [Symbol] :key the name of the record
+      # @return [String] content value of record
       def get(options)
         hostname = (options[:hostname])? options[:hostname] : @hostname
         return @store.get(prefix_hostname(options[:key],hostname))
       end
 
+      # defined and store value for specified key
+      # @param [Hash] options
+      # @option options [Symbol] :key the name of the record
+      # @option options [Symbol] :value the content value of the record
+      # @return [String] content value of record
       def put(options)
         hostname = (options[:hostname])? options[:hostname] : @hostname
         @store.set prefix_hostname(options[:key],hostname), options[:value]
       end
 
+      # delete a specific record
+      # @param [Hash] options
+      # @option options [Symbol] :key the name of the record
+      # @return [Boolean] status of the operation
       def del(options)
         hostname = (options[:hostname])? options[:hostname] : @hostname
         @store.del prefix_hostname(options[:key],hostname)
       end
 
+      # flush all records in backend
       def flush
         #`#{@redis_cli_cmd} -n #{@config[:base]} flushdb`
         @store.flushdb
       end
 
+      # verifiy a specific record existance
+      # @param [Hash] options
+      # @option options [Symbol] :key the name of the record
+      # @return [Boolean] presence of the record
       def exist?(options)
         hostname = (options[:hostname])? options[:hostname] : @hostname
         return ( not @store.get(prefix_hostname(options[:key],hostname)).nil?)
       end
 
       private
+
+      # Redis backend specific method for prefix record name with hostname
+      # @param [String] key
+      # @param [String] hostname
+      # @return [String] prefixed string
       def prefix_hostname(key,hostname)
         return "#{hostname}##{key}"
       end
 
-
+      # Redis backend specific method for removing hostname of record
+      # @param [String] astring
+      # @return [String] cleaned string
       def remove_hostname(astring)
         result = astring.split("#")
         result.shift

data/lib/splash/cli.rb

@@ -1,12 +1,15 @@
 # coding: utf-8
 Dir[File.dirname(__FILE__) + '/cli/*.rb'].each {|file| require file  }
 
+# The CLI Command structure for Thor
 class CLI < Thor
+
+  # callback for managing ARGV errors
   def self.exit_on_failure?
     true
   end
 
-
+  # Constructor override to manage debug, colors and emoji options for logger
   def initialize(*args)
     super
     log = get_logger
@@ -24,14 +27,23 @@ 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 "sequences SUBCOMMAND ...ARGS", "Managing Sequences of commands"
+  subcommand "sequences", Sequences
   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 controller"
   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
+  desc "webadmin SUBCOMMAND ...ARGS", "Splash Webadmin daemon controller"
+  subcommand "webadmin", WebAdmin
+  desc "transfers SUBCOMMAND ...ARGS", "Managing transfers"
+  subcommand "transfers", Transfers
+
 end

data/lib/splash/cli/commands.rb

@@ -1,7 +1,9 @@
 # coding: utf-8
-module CLISplash
 
+# module for all Thor subcommands
+module CLISplash
 
+  # Thor inherited class for commands management
   class Commands < Thor
     include Splash::Config
     include Splash::Backends
@@ -11,6 +13,8 @@ module CLISplash
     include Splash::Loggers
     include Splash::Commands
 
+
+    # Thor method : execution of command
     desc "execute NAME", "run for command/sequence or ack result"
     long_desc <<-LONGDESC
     execute command or sequence or ack result\n
@@ -74,6 +78,7 @@ module CLISplash
     end
 
 
+    # Thor method : scheduling commands
     desc "schedule NAME", "Schedule excution of command on Splash daemon"
     long_desc <<-LONGDESC
     Schedule excution of command on Splash daemon\n
@@ -116,7 +121,7 @@ module CLISplash
 
     end
 
-
+    # Thor method : getting a treeview of sequence of commands
     desc "treeview", "Show commands sequence tree"
     long_desc <<-LONGDESC
     Show commands sequence tree\n
@@ -128,7 +133,7 @@ module CLISplash
       log  = get_logger
       if options[:hostname] then
         options[:hostname] = Socket.gethostname if options[:hostname] == 'hostname'
-        log.info "Remote Splash scheduling command on #{options[:hostname]}:"
+        log.info "Remote Splash treeview command on #{options[:hostname]}:"
         log.info "ctrl+c for interrupt"
         begin
           transport = get_default_client
@@ -164,6 +169,7 @@ module CLISplash
     end
 
 
+    # Thor method : getting the list of available commands in splash config
     desc "list", "Show configured commands"
     long_desc <<-LONGDESC
     Show configured commands\n
@@ -213,7 +219,7 @@ module CLISplash
       splash_exit case: :quiet_exit
     end
 
-
+    # Thor method: getting informations about a specific splash configuration defined command
     desc "show COMMAND", "Show specific configured command COMMAND"
     long_desc <<-LONGDESC
     Show specific configured command COMMAND\n
@@ -259,7 +265,7 @@ module CLISplash
       end
     end
 
-
+    # Thor method : getting information on the last execution of a command
     desc "lastrun COMMAND", "Show last running result for specific configured command COMMAND"
     long_desc <<-LONGDESC
     Show last running result for specific configured command COMMAND\n
@@ -299,6 +305,7 @@ module CLISplash
       end
     end
 
+    # Thor method : getting the list of avaibles executions reports
     desc "getreportlist", "list all executions report results "
     long_desc <<-LONGDESC
     list all executions report results\n

data/lib/splash/cli/config.rb

@@ -1,13 +1,16 @@
 # coding: utf-8
+
+# module for all Thor subcommands
 module CLISplash
 
+  # Thor inherited class for configuration management
   class Config < Thor
     include Splash::ConfigUtilities
     include Splash::Helpers
     include Splash::Exiter
     include Splash::Loggers
 
-
+    # Thor method : running of Splash setup
     desc "setup", "Setup installation fo Splash"
     long_desc <<-LONGDESC
     Setup installation fo Splash\n
@@ -19,12 +22,14 @@ module CLISplash
       splash_exit acase
     end
 
+    # Thor method : running of Splash sanitycheck
     desc "sanitycheck", "Verify installation fo Splash"
     def sanitycheck
       acase = run_as_root :checkconfig
       splash_exit acase
     end
 
+    # Thor method : Getting the current Splash version
     desc "version", "Display current Splash version"
     def version
       log = get_logger
@@ -34,12 +39,15 @@ module CLISplash
       splash_exit case: :quiet_exit
     end
 
+    # Thor method : Installing Splashd Systemd service file
     desc "service", "Install Splashd Systemd service"
     def service
       acase = run_as_root :addservice
       splash_exit acase
     end
 
+
+    # Thor method : flushing configured backend
     desc "flushbackend", "Flush configured backend"
     def flushbackend
       acase = run_as_root :flush_backend

data/lib/splash/cli/daemon.rb

@@ -1,6 +1,9 @@
 # coding: utf-8
+
+# module for all Thor subcommands
 module CLISplash
 
+  # Thor inherited class for splashd daemon management
   class CLIController < Thor
     include Splash::Daemon::Controller
     include Splash::Transports
@@ -8,6 +11,7 @@ module CLISplash
     include Splash::Loggers
 
 
+    # Thor method : starting Splashd
     option :foreground, :type => :boolean,  :aliases => "-F"
     option :purge, :type => :boolean, default: true
     option :scheduling, :type => :boolean, default: true
@@ -23,7 +27,7 @@ module CLISplash
       splash_exit acase
     end
 
-
+    # Thor method : purge transport input queue of Splashd daemon
     desc "purge", "Purge Transport Input queue of Daemon"
     def purge
       log = get_logger
@@ -39,18 +43,21 @@ module CLISplash
       end
     end
 
+    # Thor method : stopping Splashd
     desc "stop", "Stopping Splash Daemon"
     def stop
       acase = run_as_root :stopdaemon
       splash_exit acase
     end
 
+    # Thor method : getting execution status of Splashd
     desc "status", "Splash Daemon status"
     def status
       acase = run_as_root :statusdaemon
       splash_exit acase
     end
 
+    # Thor method : sending ping verb over transport in the input queue of Splashd
     desc "ping HOSTNAME", "send a ping to HOSTNAME daemon over transport (need an active tranport), Typicallly RabbitMQ"
     def ping(hostname=Socket.gethostname)
       log = get_logger
@@ -67,7 +74,47 @@ module CLISplash
           splash_exit case: :quiet_exit
         end
       rescue Interrupt
-        splash_exit status: :error, case: :interrupt, more: "Ping Command"
+        splash_exit status: :error, case: :interrupt, more: "ping Command"
+      end
+    end
+
+    # Thor method : sending get_jobs verb over transport in the input queue of Splashd
+    desc "getjobs", "send a get_jobs verb to HOSTNAME daemon over transport (need an active tranport), Typicallly RabbitMQ"
+    def getjobs(hostname=Socket.gethostname)
+      log = get_logger
+      log.info "ctrl+c for interrupt"
+      begin
+        transport = get_default_client
+        if transport.class == Hash  and transport.include? :case then
+          splash_exit transport
+        else
+          log.receive transport.execute({ :verb => :get_jobs,
+                                  :return_to => "splash.#{Socket.gethostname}.returncli",
+                                  :queue => "splash.#{hostname}.input" })
+          splash_exit case: :quiet_exit
+        end
+      rescue Interrupt
+        splash_exit status: :error, case: :interrupt, more: "getjobs Command"
+      end
+    end
+
+    # Thor method : sending reset verb over transport in the input queue of Splashd
+    desc "getjobs", "send a reset verb to HOSTNAME daemon over transport (need an active tranport), Typicallly RabbitMQ"
+    def reset(hostname=Socket.gethostname)
+      log = get_logger
+      log.info "ctrl+c for interrupt"
+      begin
+        transport = get_default_client
+        if transport.class == Hash  and transport.include? :case then
+          splash_exit transport
+        else
+          log.receive transport.execute({ :verb => :reset,
+                                  :return_to => "splash.#{Socket.gethostname}.returncli",
+                                  :queue => "splash.#{hostname}.input" })
+          splash_exit case: :quiet_exit
+        end
+      rescue Interrupt
+        splash_exit status: :error, case: :interrupt, more: "reset Command"
       end
     end
 

data/lib/splash/cli/documentation.rb

@@ -1,11 +1,14 @@
 # coding: utf-8
+
+# module for all Thor subcommands
 module CLISplash
 
+  # Thor inherited class for documentation management
   class Documentation < Thor
     include Splash::Config
     include Splash::Exiter
 
-
+    # Thor method : display the readme file Typicallly formatted in Markdown
     desc "readme", "Display README file"
     option :formatted, :type => :boolean, :default => true
     def readme
@@ -14,7 +17,7 @@ module CLISplash
       if options[:formatted] then
         content = TTY::Markdown.parse_file(filename)
       else
-        conten = File::readlines(filename).join
+        content = File::readlines(filename).join
       end
       pager = TTY::Pager.new
       pager.page(content)

data/lib/splash/cli/logs.rb

@@ -1,36 +1,39 @@
 # coding: utf-8
+
+# module for all Thor subcommands
 module CLISplash
 
+  # Thor inherited class for documentation management
   class Logs < Thor
     include Splash::Config
     include Splash::Exiter
     include Splash::Logs
 
-
-    desc "analyse", "analyze logs in config"
+    # Thor method : running Splash configured logs monitors analyse
+    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
-          log.ok "Log : #{result[:log]} : no errors"
+          log.ok "Log : #{result[:log]} with label : #{result[:label]} : no errors"
           log.item "Detected pattern : #{result[:pattern]}"
           log.item "Nb lines = #{result[:lines]}"
         elsif result[:status] == :missing then
-          log.ko "Log : #{result[:log]} : missing !"
+          log.ko "Log : #{result[:log]} with label : #{result[:label]} : missing !"
           log.item "Detected pattern : #{result[:pattern]}"
         else
-          log.ko "Log : #{result[:log]} : #{result[:count]} errors"
+          log.ko "Log : #{result[:log]} with label : #{result[:label]} : #{result[:count]} errors"
           log.item "Detected pattern : #{result[:pattern]}"
           log.item "Nb lines = #{result[:lines]}"
         end
 
         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 +42,9 @@ module CLISplash
       splash_exit case: :quiet_exit
     end
 
-    desc "monitor", "monitor logs in config"
+
+    # Thor method : running Splash configured logs monitors analyse and sending to Prometheus Pushgateway
+    desc "monitor", "monitor logs defined in Splash config"
     def monitor
       log = get_logger
       log.level = :fatal if options[:quiet]
@@ -49,21 +54,24 @@ module CLISplash
 
     end
 
-    desc "show LOG", "show configured log monitoring for LOG"
+    # Thor method : display a specific Splash configured log monitor
+    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 }
+      log_record_set = get_config.logs.select{|item| item[:log] == logrecord or item[:label] == logrecord.to_sym}
       unless log_record_set.empty? then
         record = log_record_set.first
         log.info "Splash log monitor : #{record[:log]}"
         log.item "pattern : /#{record[:pattern]}/"
+        log.item "label : #{record[:label]}"
         splash_exit case: :quiet_exit
       else
         splash_exit case: :not_found, :more => "log not configured"
       end
     end
 
-    desc "list", "Show configured logs monitoring"
+    # Thor method : display the full list of Splash configured log monitors
+    desc "list", "List all Splash configured logs monitoring"
     long_desc <<-LONGDESC
     Show configured logs monitoring\n
     with --detail, show logs monitor details
@@ -75,9 +83,9 @@ module CLISplash
       log_record_set = get_config.logs
       log.ko 'No configured commands found' if log_record_set.empty?
       log_record_set.each do |record|
-        log.item "log monitor : #{record[:log]}"
+        log.item "log monitor : #{record[:log]} label : #{record[:label]}"
         if options[:detail] then
-          log.flat "  ->   pattern : /#{record[:pattern]}/"
+          log.arrow "pattern : /#{record[:pattern]}/"
         end
       end
       splash_exit case: :quiet_exit