prometheus-splash 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 762fd0659906d6b1360ce3d430faca573b1a2aded2675a298b35172811f18e13
-  data.tar.gz: 7d45440cd560b97ad893d07e95faaf3fbafc7343d52eaf36f652eee5ad5181e7
+  metadata.gz: 54e538fd7e22b4dc38c1253db96c6e842bf81d1378db0434295c0a827e23bfb7
+  data.tar.gz: c951aaf9aacd398d0944594185fc8d4986de4268162a62cedd69ff0c96d26f9d
 SHA512:
-  metadata.gz: 5afd8f284807b1c0abfa0f68177bd5d75bf5f5941a38c02ad54047ed450a24b08a6d9d1a8b2c455655e30f4fd9d93f49fa81a5ec8d027906b85e45626cbde1a6
-  data.tar.gz: 2c3f67a0d5736ae24de861593df2b3b1ad397c2544b18c3d05d3b826ab3fc9bc7d0e06989064f0aa5964e269949db8315bd983f5c4ba9de1a0450f6aa8ba96ae
+  metadata.gz: 110950f5ac22753830d8b6f1fd74eaf86d77c78eb18728613215fc671279aa8c6da577ba3d54250640c747c76f35c66cd35ffd2ccb38cfc47d65a7c47e408b2b
+  data.tar.gz: 18aecf0d1f4f080ec1863ec79e17cc6d0582b5cd7f9efac442162c0095d92658372fa2bad1b3c502dd0e44a731a4fd9fe9710bae3e6a4d00be5759610ad08c1c

data/README.md

@@ -9,7 +9,7 @@ SPLASH is **Supervision with Prometheus of Logs and Asynchronous tasks orchestra
 * Web : http://www.ultragreen.net
 * Github : https://github.com/Ultragreen/prometheus-splash
 * Rubygems : https://rubygems.org/gems/prometheus-splash
-* DOC yardoc : https://www.rubydoc.info/gems/prometheus-splash/0.3.0
+* DOC yardoc : https://www.rubydoc.info/gems/prometheus-splash/0.6.0
 
 Prometheus Logs and Batchs supervision over PushGateway
 
@@ -65,10 +65,12 @@ As root or with rvmsudo, if you use RVM.
     # splash config setup              
     Splash -> setup :
     * Installing Configuration file : /etc/splash.yml : [OK]
-    * Installing template file : /etc/splash_execution_report.tpl : [OK]
-    * Creating/Checking pid file path : /var/lib/splash : [OK]
-    * Creating/Checking trace file path : /var/lib/splash : [OK]
-    Splash config successfully done.
+    👍 Splash Initialisation
+    👍 Installing template file : /etc/splash_execution_report.tpl
+    👍 Creating/Checking pid file path : /var/run/splash
+    👍 Creating/Checking trace file path : /var/run/spla
+
+*NOTE : you can just type 'splash' withou any arguments, for the first setup because, Splash come with an automatic recovery mode, when configuration file is missing, run at the very beginnning of his the execution*     
 
 *WARNING : if you have already configured Splash, running this command without --preserve flag, RESET the Splash Configuration.*
 
@@ -121,7 +123,7 @@ For file/folders if problems is detected, it could be such as :
 run :
 
     $ splash config version
-    Splash version : 0.0.3, Author : Romain GEORGES <gems@ultragreen.net>
+    Splash version : 0.6.0, Author : Romain GEORGES <gems@ultragreen.net>
     Ultragreen (c) 2020 BSD-2-Clause
 
 
@@ -652,74 +654,70 @@ TODO
 
  defined in the lib/splash/constants.rb
 
-```ruby
 
-# the only one non-overridable by the configuration
-CONFIG_FILE = "/etc/splash.yml"
+
+    # the only one non-overridable by the configuration
+    CONFIG_FILE = "/etc/splash.yml"
 
 
-TRACE_PATH="/var/run/splash"
+    TRACE_PATH="/var/run/splash"
 
-DAEMON_LOGMON_SCHEDULING={ :every => '20s'}
-DAEMON_PROCESS_NAME="Splash : daemon."
-DAEMON_PID_PATH="/var/run"
-DAEMON_PID_FILE="splash.pid"
-DAEMON_STDOUT_TRACE="stdout.txt"
-DAEMON_STDERR_TRACE="stderr.txt"
+    DAEMON_LOGMON_SCHEDULING={ :every => '20s'}
+    DAEMON_PROCESS_NAME="Splash : daemon."
+    DAEMON_PID_PATH="/var/run"
+    DAEMON_PID_FILE="splash.pid"
+    DAEMON_STDOUT_TRACE="stdout.txt"
+    DAEMON_STDERR_TRACE="stderr.txt"
 
-AUTHOR="Romain GEORGES"
-EMAIL = "gems@ultragreen.net"
-COPYRIGHT="Ultragreen (c) 2020"
-LICENSE="BSD-2-Clause"
+    AUTHOR="Romain GEORGES"
+    EMAIL = "gems@ultragreen.net"
+    COPYRIGHT="Ultragreen (c) 2020"
+    LICENSE="BSD-2-Clause"
 
-PROMETHEUS_PUSHGATEWAY_HOST = "localhost"
-PROMETHEUS_PUSHGATEWAY_PORT = "9091"
+    PROMETHEUS_PUSHGATEWAY_HOST = "localhost"
+    PROMETHEUS_PUSHGATEWAY_PORT = "9091"
 
-EXECUTION_TEMPLATE="/etc/splash_execution_report.tpl"
-EXECUTION_TEMPLATE_TOKENS_LIST = [:end_date,:start_date,:cmd_name,:cmd_line,:stdout,:stderr,:desc,:status,:exec_time]
+    EXECUTION_TEMPLATE="/etc/splash_execution_report.tpl"
+    EXECUTION_TEMPLATE_TOKENS_LIST = [:end_date,:start_date,:cmd_name,:cmd_line,:stdout,:stderr,:desc,:status,:exec_time]
 
-BACKENDS_STRUCT = { :list => [:file,:redis],
+    BACKENDS_STRUCT = { :list => [:file,:redis],
                     :stores => { :execution_trace => { :type => :file, :path => "/var/run/splash" }}}
-TRANSPORTS_STRUCT = { :list => [:rabbitmq],
+    TRANSPORTS_STRUCT = { :list => [:rabbitmq],
                     :active => :rabbitmq,
                     :rabbitmq => { :url => 'amqp://localhost/'} }
 
-```
-
 
 #### Splash CLI return code significations
-```ruby
-EXIT_MAP= {
-
-   # context execution
-   :not_root => {:message => "This operation need to be run as root (use sudo or rvmsudo)", :code => 10},
-   :options_incompatibility => {:message => "Options incompatibility", :code => 40},
-   :service_dependence_missing => {:message => "Splash Service dependence missing", :code => 60},
-
-   # config
-   :specific_config_required => {:message => "Specific configuration required", :code => 30},
-   :splash_setup_error => {:message => "Splash Setup terminated unsuccessfully", :code => 25},
-   :splash_setup_success => {:message => "Splash Setup terminated successfully", :code => 0},
-   :splash_sanitycheck_error => {:message => "Splash Sanitycheck terminated unsuccessfully", :code => 20},
-   :splash_sanitycheck_success => {:message => "Splash Sanitycheck terminated successfully", :code => 0},
-   :configuration_error => {:message => "Splash Configuration Error", :code => 50},
-
-
-   # global
-   :quiet_exit => {:code => 0},
-
-   # events
-   :interrupt => {:message => "Splash user operation interrupted", :code => 33},
-
-   # request
-   :not_found => {:message => "Object not found", :code => 44},
-   :already_exist => {:message => "Object already exist", :code => 48},
-
-   # daemon
-   :status_ok => {:message => "Status OK", :code => 0},
-   :status_ko => {:message => "Status KO", :code => 31}
-```
-}
+
+
+    # context execution
+    :not_root => {:message => "This operation need to be run as root (use sudo or rvmsudo)", :code => 10},
+    :options_incompatibility => {:message => "Options incompatibility", :code => 40},
+    :service_dependence_missing => {:message => "Splash Service dependence missing", :code => 60},
+
+    # config
+    :specific_config_required => {:message => "Specific configuration required", :code => 30},
+    :splash_setup_error => {:message => "Splash Setup terminated unsuccessfully", :code => 25},
+    :splash_setup_success => {:message => "Splash Setup terminated successfully", :code => 0},
+    :splash_sanitycheck_error => {:message => "Splash Sanitycheck terminated unsuccessfully", :code => 20},
+    :splash_sanitycheck_success => {:message => "Splash Sanitycheck terminated successfully", :code => 0},
+    :configuration_error => {:message => "Splash Configuration Error", :code => 50},
+
+
+    # global
+    :quiet_exit => {:code => 0},
+
+    # events
+    :interrupt => {:message => "Splash user operation interrupted", :code => 33},
+
+    # request
+    :not_found => {:message => "Object not found", :code => 44},
+    :already_exist => {:message => "Object already exist", :code => 48},
+
+    # daemon
+    :status_ok => {:message => "Status OK", :code => 0},
+    :status_ko => {:message => "Status KO", :code => 31}
+
 
 ### In the Futur ?
 

data/bin/splash

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # coding: utf-8
 
+# major include
 require 'splash/dependencies'
 require 'splash/cli'
 
@@ -13,6 +14,7 @@ include Splash::Exiter
 include Splash::Loggers
 include Splash::Config
 
+# auto setup
 unless verify_file(name: CONFIG_FILE, mode: "644", owner: user_root, group: group_root).empty? then
   puts 'Splash need reconfiguration : Auto setup launch'
 
@@ -26,4 +28,5 @@ unless verify_file(name: CONFIG_FILE, mode: "644", owner: user_root, group: grou
   end
 end
 
+# running Thor
 CLI.start(ARGV)

data/config/splash.yml

@@ -50,6 +50,17 @@
     :pushgateway:
       :host: "localhost"
       :port: 9091
+      :path: ''
+    :url: "http://localhost:9090/"
+  :webadmin:
+    :port: 9234
+    :ip: 127.0.0.1
+    :proxy: false
+    :process_name: "Splash : WebAdmin."
+    :files:
+      :stdout_trace: stdout_webadmin.txt
+      :stderr_trace: stderr_webadmin.txt
+      :pid_file: splash_webadmin.pid
 
 
 ### configuration of commands and scheduling
@@ -106,9 +117,11 @@
 
 ### configuration of monitored logs
   :logs:
-    - :log: /tmp/test
+    - :label: :log_app_1
+      :log: /tmp/test
       :pattern: ERROR
-    - :log: /tmp/test2
+    - :label: :log_app_2
+      :log: /tmp/test2
       :pattern: ERROR
 
 

data/lib/splash/backends.rb

@@ -1,11 +1,17 @@
 # coding: utf-8
 Dir[File.dirname(__FILE__) + '/backends/*.rb'].each {|file| require file  }
 
+# base Splash Module
 module Splash
+
+  # generic backends module
   module Backends
     include Splash::Config
     include Splash::Constants
 
+    # factory for backend
+    # @param [Symbol] store the name of the store actually in [:execution_trace]
+    # @return [Splash::Backends::<Type>|Hash] with type in [:redis,:file] or Exiter case :configuration_error 
     def get_backend(store)
       backend = get_config[:backends][:stores][store][:type].to_s
       aclass = "Splash::Backends::#{backend.capitalize}"

data/lib/splash/backends/file.rb

@@ -1,50 +1,86 @@
 # coding: utf-8
+
+# base Splash Module
 module Splash
+  # generic backends module
   module Backends
+
+    # File backend definition
     class File
       include Splash::Config
       include Splash::Exiter
       include Splash::Helpers
       include Splash::Loggers
 
+      # Constructor
+      # @param [Symbol] store name in [:execution_trace] actually (see config and constants )
+      # @return [Splash::Backends::File] a File backend
       def initialize(store)
         @config = get_config[:backends][:stores][store]
         @path = @config[:path]
         ensure_backend
       end
 
+      # return the list of find records in backend for a specific pattern
+      # @param [String] pattern shell regexp
+      # @return [Array] list of record
       def list(pattern='*')
         pattern = suffix_trace(pattern)
         return Dir.glob("#{@path}/#{pattern}").map{|item| ::File.basename(item,".trace") }
       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)
         return ::File.readlines("#{@path}/#{suffix_trace(options[:key])}").join
       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)
         ::File.open("#{@path}/#{suffix_trace(options[:key])}", 'w') { |file|
           file.write 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)
         ::File.unlink("#{@path}/#{suffix_trace(options[:key])}") if File.exist?("#{@path}/#{suffix_trace(options[:key])}")
       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)
         return ::File.exist?("#{@path}/#{suffix_trace(options[:key])}")
       end
 
+      # flush all records in backend
       def flush
         Dir.glob("#{@path}/*.trace").each { |file| ::File.delete(file)}
       end
 
       private
+
+      # File backend specific method for suffixing record name with .trace for filename
+      # @param [String] astring
+      # @return [String] suffixed string
       def suffix_trace(astring)
         return "#{astring}.trace"
       end
 
+      # File backend specific method to test backend, correcting if requiered, spool path checking
+      # @return [True|Hash] Exiter case :configuration_error if failing to correct backend
       def ensure_backend
         unless verify_folder(name: @config[:path], mode: "644", owner: get_config.user_root, group: get_config.group_root).empty? then
           get_logger.warn "File Backend folder : #{@config[:path]} is missing"

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
@@ -30,13 +33,14 @@ class CLI < Thor
   subcommand "logs", Logs
   desc "processes SUBCOMMAND ...ARGS", "Managing processes supervision"
   subcommand "processes", Processes
-  desc "daemon SUBCOMMAND ...ARGS", "Splash daemon contoller"
+  desc "daemon SUBCOMMAND ...ARGS", "Splash daemon controller"
   subcommand "daemon", CLIController
   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
 
 
 end