prometheus-splash 0.5.3 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 762fd0659906d6b1360ce3d430faca573b1a2aded2675a298b35172811f18e13
-  data.tar.gz: 7d45440cd560b97ad893d07e95faaf3fbafc7343d52eaf36f652eee5ad5181e7
+  metadata.gz: 60d3aa2e635dbea8022a1804e9886e495648ce777db2293442ae3a16bae7e25a
+  data.tar.gz: 14912be5e4171daae1ee7706f98ac7974c43a96d56e7daa58a1e9a40d46b60ee
 SHA512:
-  metadata.gz: 5afd8f284807b1c0abfa0f68177bd5d75bf5f5941a38c02ad54047ed450a24b08a6d9d1a8b2c455655e30f4fd9d93f49fa81a5ec8d027906b85e45626cbde1a6
-  data.tar.gz: 2c3f67a0d5736ae24de861593df2b3b1ad397c2544b18c3d05d3b826ab3fc9bc7d0e06989064f0aa5964e269949db8315bd983f5c4ba9de1a0450f6aa8ba96ae
+  metadata.gz: d66a48e63fd8940c6343113511e1ad91531037013a042a79348a755de74e6447a791854fa2ec82461c38695370402e30790ac7660fd75c0cc82c0f5ef788701d
+  data.tar.gz: 9d59657c45219e31af8a6c85fc137925ee03ccecc7a98e62848ba28540ec2e39df674fcd391b51334c4bc1252de487a5a55110a286707fee9a38e54bf85a3cfc

data/CHANGELOG.md

@@ -124,4 +124,34 @@
 ### FEATURE
 
 * processes monitoring #23
- 
+
+## V 0.6.0 2020/10/10
+
+### FEATURE
+
+* read only WebAdmin (Major update)
+* API REST
+* refactoring
+
+## V 0.7.0
+
+### FEATURE
+
+* sequences
+* API sequences
+* UI sequences
+* Transfers
+* API Transfers
+* UI Transfers
+
+## V 0.8.0
+
+### FEATURE
+* orchestrator rebuild
+* reshash config and reset + grammar and Cli
+* refacto config
+
+## V0.8.1
+
+### FEATURE
+* #55 historisation for reports for all

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.8.1
 
 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

@@ -2,6 +2,9 @@
 :splash:
 
 ### Main Configuration
+  :paths:
+    :pid_path: /var/run/splash
+    :trace_path: /var/run/splash/traces
   :loggers:
     :level: :info
     :daemon:
@@ -23,6 +26,16 @@
 #        :port: 6379
 #        #:auth: "mykey"
 #        :base: 1
+      :transfers_trace:
+          :type: :file
+          :path: /var/run/splash/transfers
+      :logs_trace:
+          :type: :file
+          :path: /var/run/splash/logs
+      :process_trace:
+          :type: :file
+          :path: /var/run/splash/process
+
   :transports:
     :active: :rabbitmq
     :rabbitmq:
@@ -39,20 +52,26 @@
     :procmon_scheduling:
       :every: 20s
     :process_name: "Splash : daemon."
-    :paths:
-      :pid_path: /var/run/splash
-      :trace_path: /var/run/splash/traces
     :files:
       :stdout_trace: stdout.txt
       :stderr_trace: stderr.txt
       :pid_file: splash.pid
   :prometheus:
-    :pushgateway:
-      :host: "localhost"
-      :port: 9091
+    :pushgateway: 'http://localhost:9091'
+    :url: 'http://localhost:9090'
+    :alertmanager: 'http://localhost:9093'
+  :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
+### Sample configuration of commands and scheduling
   :commands:
     :id_root:
       :desc: run id command on root
@@ -104,16 +123,96 @@
       :on_success: :echo3
 
 
-### configuration of monitored logs
+### Sample configuration of monitored logs
   :logs:
-    - :log: /tmp/test
+    - :label: :log_app_1
+      :log: /tmp/test
       :pattern: ERROR
-    - :log: /tmp/test2
+      :retention:
+        :hours: 5
+    - :label: :log_app_2
+      :log: /tmp/test2
       :pattern: ERROR
-
+      :retention:
+        :hours: 5
 
 ### configuration of monitored processes
   :processes:
     - :process: cron
       :patterns:
         - cron
+      :retention:
+          :hours: 5
+
+
+###
+## Sample configuration of executions sequences
+  :sequences:
+    :sample_remote_sequence:
+      :definition:
+        - :step: execute echo2 on omicron
+          :command: :echo2
+          :on_host: omicron
+        - :step: run locally echo3
+          :command: :echo3
+          :trace: false
+    :sample_local_sequence:
+      :definition:
+        - :step: run locally pwd without callback
+          :command: :pwd
+          :callback: false
+        - :step: run locally echo3 without Prometheus notifications
+          :command: :echo3
+          :notify: false
+    :sample_local_failed_sequence:
+      :options:
+        :continue: false
+      :definition:
+        - :step: run false_test locally without callback
+          :command: :false_test
+          :callback: false
+        - :step: considere this as inefective
+          :command: :echo3
+    :sample_local_full_sequence:
+      :options:
+        :continue: true
+      :definition:
+        - :step: run false_test locally without callback
+          :command: :false_test
+          :callback: false
+          :trace: false
+        - :step: considere this as inefective
+          :command: :pwd
+    :sample_scheduled_sequence:
+      :schedule:
+        :every: 1m
+      :options:
+        :continue: true
+      :definition:
+        - :step: exec echo3
+          :command: :echo3
+
+### Transfers
+  :transfers:
+    - :name: :transfer_text
+      :desc: "List of text files"
+      :pattern: '*.txt'
+      :backup: true
+      :type: :push
+      :retention:
+        :hours: 1
+      :local:
+        :path: /tmp/transferts
+        :user: root
+      :remote:
+        :user: root
+        :host: localhost
+        :path: /tmp/
+      :post:
+        :remote_command: 'ls'
+
+
+
+
+
+###

data/lib/splash/backends.rb

@@ -1,12 +1,19 @@
 # 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)
+      splash_exit case: :configuration_error, more: "backend definition failure" if get_config[:backends][:stores][store].nil?
       backend = get_config[:backends][:stores][store][:type].to_s
       aclass = "Splash::Backends::#{backend.capitalize}"
       begin

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"