prometheus-splash 0.5.3 → 0.6.0

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

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

data/lib/splash/config/setup.rb

@@ -1,13 +1,18 @@
-
 # coding: utf-8
 
-
+# Base Splash module
 module Splash
+
+  # moudle for Configuration utilities
   module ConfigUtilities
     include Splash::Constants
     include Splash::Helpers
+
+
     # Setup action method for installing Splash
-    # @return [Integer] an errorcode value
+    # @param [Hash] options
+    # @option options [Symbol] :preserve flag to preserve config file during setup
+    # @return [Hash] An Exiter case hash (:splash_setup_success or :splash_setup_error)
     def setupsplash(options = {})
       conf_in_path = search_file_in_gem "prometheus-splash", "config/splash.yml"
       full_res = 0

data/lib/splash/constants.rb

@@ -1,7 +1,13 @@
 # coding: utf-8
+
+# base Splash module / namespace
 module Splash
+
+  # Constants namespace
   module Constants
-    VERSION = "0.5.3"
+
+    # Current splash version
+    VERSION = "0.6.0"
 
     # the path to th config file, not overridable by config
     CONFIG_FILE = "/etc/splash.yml"
@@ -40,6 +46,11 @@ module Splash
     PROMETHEUS_PUSHGATEWAY_HOST = "localhost"
     # the default prometheus pushgateway port
     PROMETHEUS_PUSHGATEWAY_PORT = "9091"
+    # the default prometheus pushgateway port
+    PROMETHEUS_PUSHGATEWAY_PATH = ''
+
+    # the default prometheus URL
+    PROMETHEUS_URL = "http://localhost:9090"
 
     # the default path fo execution report template
     EXECUTION_TEMPLATE="/etc/splash_execution_report.tpl"
@@ -55,11 +66,28 @@ module Splash
                           :active => :rabbitmq,
                           :rabbitmq => { :port => 5672, :host => "localhost", :vhost => '/'} }
 
-    LOGGERS_STRUCT = { :list => [:cli,:daemon, :dual],
+    # loggers default settings
+    LOGGERS_STRUCT = { :list => [:cli,:daemon, :dual, :web],
                        :default => :cli,
                        :level => :info,
                        :daemon => {:file => '/var/log/splash.log'},
+                       :web => {:file => '/var/log/splash_web.log'},
                        :cli => {:color => true, :emoji => true }  }
 
+    WEBADMIN_IP = "127.0.0.1"
+    WEBADMIN_PORT = "9234"
+    WEBADMIN_PROXY = false
+    # the display name of daemon in proc info (ps/top)
+    WEBADMIN_PROCESS_NAME="Splash : WebAdmin."
+    # the default pid file path
+    WEBADMIN_PID_PATH="/var/run"
+    # the default pid file name
+    WEBADMIN_PID_FILE="splash.pid"
+    # the default sdtout trace file
+    WEBADMIN_STDOUT_TRACE="stdout.txt"
+    # the default sdterr trace file
+    WEBADMIN_STDERR_TRACE="stderr.txt"
+
+
   end
 end

data/lib/splash/daemon.rb

@@ -1,2 +1,6 @@
 # coding: utf-8
-Dir[File.dirname(__FILE__) + '/daemon/*.rb'].each {|file| require file  }
+require File.dirname(__FILE__) + '/daemon/orchestrator.rb'
+require File.dirname(__FILE__) + '/daemon/metrics.rb'
+require File.dirname(__FILE__) + '/daemon/controller.rb'
+
+# Dir[File.dirname(__FILE__) + '/daemon/*.rb'].each {|file| require file  }

data/lib/splash/daemon/controller.rb

@@ -1,6 +1,13 @@
 # coding: utf-8
+require 'splash/daemon/orchestrator'
+
+# base Splash module
 module Splash
+
+  # global daemon module
   module Daemon
+
+    # Daemon Controller Module
     module Controller
       include Splash::Constants
       include Splash::Helpers
@@ -9,6 +16,12 @@ module Splash
       include Splash::Loggers
       include Splash::Daemon::Orchestrator
 
+      # Start the Splash Daemon
+      # @param [Hash] options
+      # @option options [Symbol] :quiet activate quiet mode for log (limit to :fatal)
+      # @option options [Symbol] :foreground run daemon in foreground
+      # @option options [Symbol] :purge clean input queue for daemon on configured transport
+      # @return [Hash] Exiter Case (:quiet_exit, :already_exist, :unknown_error or other)
       def startdaemon(options = {})
         config = get_config
         log = get_logger
@@ -43,7 +56,7 @@ module Splash
               :foreground => options[:foreground]
             }
 
-          ["int","term","hup"].each do |type| daemon_config["sig#{type}_handler".to_sym] = Proc::new {  ObjectSpace.each_object(Splash::Daemon::Orchestrator::Scheduler).first.shutdown } end
+          ["int","term","hup"].each do |type| daemon_config["sig#{type}_handler".to_sym] = Proc::new {  ObjectSpace.each_object(Splash::Daemon::Orchestrator::Scheduler).first.terminate } end
           res = daemonize daemon_config do
               Scheduler::new options
           end
@@ -61,6 +74,10 @@ module Splash
         end
       end
 
+      # Stop the Splash Daemon
+      # @param [Hash] options
+      # @option options [Symbol] :quiet activate quiet mode for log (limit to :fatal)
+      # @return [Hash] Exiter Case (:quiet_exit, :not_found, other)
       def stopdaemon(options = {})
           config = get_config
           log = get_logger
@@ -80,6 +97,9 @@ module Splash
           return acase
       end
 
+      # Status of the Splash Daemon, display status
+      # @param [Hash] options ignored
+      # @return [Hash] Exiter Case (:status_ko, :status_ok)
       def statusdaemon(options = {})
         log = get_logger
         config = get_config

data/lib/splash/daemon/metrics.rb

@@ -1,5 +1,12 @@
+# coding: utf-8
+
+# base Splash module
 module Splash
+
+  # global daemon module
   module Daemon
+
+    # Metrics management modulefor Splash daemon
     module Metrics
       include Splash::Constants
       include Splash::Helpers
@@ -7,20 +14,24 @@ module Splash
       include Splash::Loggers
 
       @@manager=nil
-      # factory of Configuration Class instance
-      # @param [String] config_file the path of the YAML Config file
-      # @return [SPlash::Config::Configuration]
+
+      # metrics manager factory
+      # @return [Splash::Daemon::Metrics::Manager]
       def get_metrics_manager
         return @@manager ||= Manager::new
       end
 
-
+      # Metrics Manager (collect and sending to Prometheus)
       class Manager
 
+        # metric : commands executions count during Splash daemon uptime
         attr_reader :execution_count
+        # metric : logs monitoring count during Splash daemon uptime
         attr_reader :monitoring_logs_count
+        # metric : processes monitoring count during Splash daemon uptime
         attr_reader :monitoring_processes_count
 
+        # Constructor prepare prometheus-client, defined metrics and init attributes
         def initialize
           @config = get_config
           @starttime = Time.now
@@ -40,24 +51,28 @@ module Splash
           @registry.register(@metric_processes_monitoring)
         end
 
-
+        # virtual accessor uptime
         def uptime
           return Time.now - @starttime
         end
 
+        # increment metric : execution_count
         def inc_execution
           @execution_count += 1
         end
 
-
+        # increment metric : monitoring_logs_count
         def inc_logs_monitoring
           @monitoring_logs_count += 1
         end
 
+        # increment metric : monitoring_processes_count
         def inc_processes_monitoring
           @monitoring_processes_count += 1
         end
 
+        # Send metrics to Prometheus PushGateway
+        # @return [Hash] Exiter case ( :service_dependence_missing , :quiet_exit)
         def notify
           log = get_logger
           session  = get_session
@@ -72,7 +87,7 @@ module Splash
           @metric_processes_monitoring.set monitoring_processes_count
 
           hostname = Socket.gethostname
-          url = "http://#{@config.prometheus_pushgateway_host}:#{@config.prometheus_pushgateway_port}"
+          url = "http://#{@config.prometheus_pushgateway_host}:#{@config.prometheus_pushgateway_port}/#{@config.prometheus_pushgateway_path}"
           Prometheus::Client::Push.new('Splash',hostname, url).add(@registry)
           log.debug "Sending to Prometheus PushGateway done.", session
           return {:case => :quiet_exit }

data/lib/splash/daemon/orchestrator.rb

@@ -1,10 +1,16 @@
 # coding: utf-8
 Dir[File.dirname(__FILE__) + '/orchestrator/*.rb'].each {|file| require file  }
 
+# base Splash module
 module Splash
+
+  # global daemon module
   module Daemon
+
+    # orchestrator specific module
     module Orchestrator
 
+      # Splash Scheduler object
       class Scheduler
         include Splash::Constants
         include Splash::Helpers
@@ -16,7 +22,12 @@ module Splash
         include Splash::Processes
         include Splash::Commands
 
-
+        # Constructor prepare the Scheduler
+        # commands Schedules
+        # logs monitorings
+        # process monitorings
+        # @param [Hash] options
+        # @option options [Symbol] :scheduling activate commands scheduling
         def initialize(options = {})
           @log = get_logger
           self.extend Splash::Daemon::Metrics
@@ -103,6 +114,8 @@ module Splash
           end
         end
 
+        # Stop the Splash daemon gracefully
+        # @return [hash] Exiter Case :quiet_exit
         def terminate
           @log.info "Splash daemon shutdown"
           @server.shutdown
@@ -111,6 +124,7 @@ module Splash
         end
 
         private
+        # prepare commands Scheduling
         def init_commands_scheduling
           config = get_config.commands
           commands = config.select{|key,value| value.include? :schedule}.keys
@@ -126,10 +140,14 @@ module Splash
 
         end
 
+        # execute_command verb : execute command specified in payload
+        # @param [Hash] options
+        # @option options [Symbol] :command the name of the command
+        # @option options [Symbol] :ack ack flag to inhibit execution and send ack to Prometheus (0)
+        # @return [Hash] Exiter case
         def execute(options)
           command =  CommandWrapper::new(options[:command])
-          if options[:ack] then
-            command.ack
+          if options[:ack] then 
           else
             @metric_manager.inc_execution
             return command.call_and_notify trace: true, notify: true, callback: true, session: options[:session]

data/lib/splash/daemon/orchestrator/grammar.rb

@@ -1,34 +1,54 @@
 # coding: utf-8
+
+# base Splash module
 module Splash
+
+  # global daemon module
   module Daemon
+
+    # orchestrator specific module
     module Orchestrator
+
+      # Orchestrator grammar method defiition  module
       module Grammar
 
         include Splash::Config
         include Splash::Loggers
 
-
+        # list of known verbs for Splash orchestrator
         VERBS=[:ping,:list_commands,:execute_command,:ack_command, :shutdown]
 
-
-        def shutdown
+        # shutdown verb : stop the Splash daemon gracefully
+        # @param [Hash] content message content Hash Structure, ignored
+        # @return [Hash] Exiter Case :quiet_exit
+        def shutdown(content)
           terminate
         end
 
+        # ping verb : return pong to hostname precise in payload
+        # @param [Hash] content message content Hash Structure, include  mandatory payload[:hostname]
+        # @return [String] the pong
         def ping(content)
           return "Pong : #{content[:payload][:hostname]} !"
         end
 
-
+        # list_commands verb : return the list of specified commands in local Splash
+        # @param [Hash] content message content Hash Structure, ignored
+        # @return [Hash] structure of commands
         def list_commands(content)
           return get_config.commands
         end
 
+        # ack_command verb : send ack to Prometheus, for command specified in payload
+        # @param [Hash] content message content Hash Structure, include  mandatory payload[:name]
+        # @return [Hash] Exiter case
         def ack_command(content)
           return execute command: content[:payload][:name], ack: true
         end
 
-
+        # execute_command verb : execute command specified in payload
+        # @param [Hash] content message content Hash Structure, include  mandatory payload[:name]
+        # @return [Hash] Exiter case
         def execute_command(content)
           payload = content[:payload]
           unless get_config.commands.include? payload[:name].to_sym

data/lib/splash/daemon/orchestrator/hooks.rb

@@ -1,13 +1,23 @@
 # coding: utf-8
+
+# base Splash module
 module Splash
+
+  # global daemon module
   module Daemon
+
+    # orchestrator specific module
     module Orchestrator
 
+      # Rufus Scheduler Hooks
       module SchedulerHooks
+
+        # not yet implemented
         def on_pre_trigger(job, trigger_time)
 
         end
 
+        # not yet implemented
         def on_post_trigger(job, trigger_time)
 
         end

data/lib/splash/dependencies.rb

@@ -12,6 +12,7 @@ module Splash
     require 'fileutils'
     require 'etc'
     require 'forwardable'
+    require 'json'
 
 
 
@@ -27,6 +28,13 @@ module Splash
       require 'colorize'
       require "redis"
       require 'ps-ruby'
+      require 'sinatra/base'
+      require 'thin'
+      require 'slim'
+      require 'rest-client'
+      require 'kramdown'
+      require 'rack/reverse_proxy'
+
 
     rescue Gem::GemNotFoundException
       $stderr.puts "Loadind error, it's like you try to run Splash, with a lake of dependencies."
@@ -49,8 +57,9 @@ module Splash
     require 'splash/commands'
     require 'splash/logs'
     require 'splash/processes'
-    
+
     require 'splash/daemon'
+    require 'splash/webadmin'
 
 
   end