prometheus-splash 0.5.3 → 0.6.0

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
@@ -164,6 +169,7 @@ module CLISplash
     end
 
 
+    # Thor method : getting the list of avaible 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

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,12 +1,15 @@
 # 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
 
-
+    # Thor method : running Splash configured logs monitors analyse
     desc "analyse", "analyze logs defined in Splash config"
     def analyse
       log  = get_logger
@@ -16,14 +19,14 @@ module CLISplash
       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
@@ -39,6 +42,8 @@ module CLISplash
       splash_exit case: :quiet_exit
     end
 
+
+    # 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
@@ -49,20 +54,23 @@ module CLISplash
 
     end
 
+    # 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
 
+    # 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
@@ -75,7 +83,7 @@ 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.arrow "pattern : /#{record[:pattern]}/"
         end

data/lib/splash/cli/process.rb

@@ -1,10 +1,15 @@
+# coding: utf-8
+
+# module for all Thor subcommands
 module CLISplash
 
+  # Thor inherited class for Processes management
   class Processes < Thor
     include Splash::Config
     include Splash::Exiter
     include Splash::Processes
 
+    # Thor method : unning Splash configured processes monitors analyse
     desc "analyse", "analyze processes defined in Splash config"
     def analyse
       log  = get_logger
@@ -40,6 +45,8 @@ module CLISplash
       splash_exit case: :quiet_exit
     end
 
+
+    # Thor method : running Splash configured processes monitors analyse and sending to Prometheus Pushgateway
     desc "monitor", "monitor processes defined in Splash config"
     def monitor
       log = get_logger
@@ -49,6 +56,7 @@ module CLISplash
       splash_exit result.notify
     end
 
+    # Thor method : display a specific Splash configured process monitor
     desc "show PROCESS", "show Splash configured process record for PROCESS"
     def show(record)
       log = get_logger
@@ -66,6 +74,7 @@ module CLISplash
       end
     end
 
+    # Thor method : display the full list of Splash configured processes monitors
     desc "list", "List all Splash configured process records"
     long_desc <<-LONGDESC
     List all Splash configured processes record\n

data/lib/splash/cli/webadmin.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+# module for all Thor subcommands
+module CLISplash
+
+  # Thor inherited class for Processes management
+  class WebAdmin < Thor
+    include Splash::WebAdmin::Controller
+    include Splash::Config
+    include Splash::Exiter
+    include Splash::Helpers
+
+
+    # Thor method : stopping Splash Webadmin
+    desc "stop", "Stopping Splash Webadmin Daemon"
+    def stop
+      acase = run_as_root :stopdaemon, options
+      splash_exit acase
+    end
+
+    # Thor method : getting execution status of Splashd
+    desc "status", "Splash WebAdmin Daemon status"
+    def status
+      acase = run_as_root :statusdaemon, options
+      splash_exit acase
+    end
+
+
+
+
+
+
+
+    # Thor method : getting execution status of Splash WebAdmin
+    long_desc <<-LONGDESC
+    Starting Splash Daemon\n
+    LONGDESC
+    desc "start", "Splash WebAdmin Daemon status"
+    def start
+      acase = run_as_root :startdaemon
+      splash_exit acase
+    end
+
+  end
+
+end

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,20 +22,27 @@ 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 = "http://#{@config.prometheus_pushgateway_host}:#{@config.prometheus_pushgateway_port}/#{@config.prometheus_pushgateway_path}"
         @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
           return { :case => :service_dependence_missing, :more => "Prometheus Notification not send."}
@@ -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

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,17 +15,33 @@ 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_url] = (config_from_file[:prometheus][:url])? config_from_file[:prometheus][:url] : PROMETHEUS_URL
+
+        self[:prometheus_pushgateway_path] = (config_from_file[:prometheus][:pushgateway][:path])? config_from_file[:prometheus][:pushgateway][:path] : PROMETHEUS_PUSHGATEWAY_PATH
         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[: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[: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
@@ -43,79 +62,190 @@ module Splash
 
       # @!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 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
 
+
+
+
+      # getter for daemon_process_name Config sample
+      # @return [String]
       def daemon_process_name
         return self[:daemon_process_name]
       end
 
+      # getter for prometheus_pushgateway_host Config sample
+      # @return [String]
       def prometheus_pushgateway_host
         return self[:prometheus_pushgateway_host]
       end
+
+      # getter for prometheus_pushgateway_port Config sample
+      # @return [String]
       def prometheus_pushgateway_port
         return self[:prometheus_pushgateway_port]
       end
 
+      # getter for prometheus_pushgateway_path Config sample
+      # @return [String]
+      def prometheus_pushgateway_path
+        return self[:prometheus_pushgateway_path]
+      end
+
+      # getter for prometheus_url Config sample
+      # @return [String]
+      def prometheus_url
+        return self[:prometheus_url]
+      end
+
+      # getter for full_pid_path Config sample
+      # @return [String]
       def full_pid_path
         return "#{self[:pid_path]}/#{self[:pid_file]}"
       end
 
+      # getter for full_stdout_trace_path Config sample
+      # @return [String]
       def full_stdout_trace_path
         return "#{self[:trace_path]}/#{self[:stdout_trace]}"
       end
 
+      # getter for full_stderr_trace_path Config sample
+      # @return [String]
       def full_stderr_trace_path
         return "#{self[:trace_path]}/#{self[:stderr_trace]}"
       end
@@ -123,6 +253,10 @@ module Splash
       # @!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
@@ -133,6 +267,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]
@@ -140,7 +275,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