prometheus-splash 0.6.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54e538fd7e22b4dc38c1253db96c6e842bf81d1378db0434295c0a827e23bfb7
-  data.tar.gz: c951aaf9aacd398d0944594185fc8d4986de4268162a62cedd69ff0c96d26f9d
+  metadata.gz: a1089bb88ba3cb916cae48b6253559c5542028ab7752d9c08d5a90cb95a45c9f
+  data.tar.gz: 90280e53cbf7124b191707fd089afcd48f29bbf68d332fc2acc7865efc2f70b4
 SHA512:
-  metadata.gz: 110950f5ac22753830d8b6f1fd74eaf86d77c78eb18728613215fc671279aa8c6da577ba3d54250640c747c76f35c66cd35ffd2ccb38cfc47d65a7c47e408b2b
-  data.tar.gz: 18aecf0d1f4f080ec1863ec79e17cc6d0582b5cd7f9efac442162c0095d92658372fa2bad1b3c502dd0e44a731a4fd9fe9710bae3e6a4d00be5759610ad08c1c
+  metadata.gz: c50f695e45c368955df4c919faa179c32ae333ce9d0e5676e9da0b1497893d08c526a2ba0a07fdaa7172972831fa43e7a16522404e112d1fdae156a1dfc2fbac
+  data.tar.gz: c8923535e3af5102bb02c3571cc29a220d83a02e2aa71885ab6022800ad3144361e583302de6021d690922c8f49c503a0e5eb3198cb1e7fa745377727462dae8

data/CHANGELOG.md

@@ -124,4 +124,41 @@
 ### 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
+
+## V 0.8.1
+
+### FEATURE
+* full Web UI features for Logs (R/W)
+* API Logs Full
+
+## V 0.8.2
+
+### FIX
+* WebAdmin UI bugs and cosmetics
+* API (constants CLONE for exiter)

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.6.0
+* DOC yardoc : https://www.rubydoc.info/gems/prometheus-splash/0.8.2
 
 Prometheus Logs and Batchs supervision over PushGateway
 

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,19 +52,14 @@
     :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
-      :path: ''
-    :url: "http://localhost:9090/"
+    :pushgateway: 'http://localhost:9091'
+    :url: 'http://localhost:9090'
+    :alertmanager: 'http://localhost:9093'
   :webadmin:
     :port: 9234
     :ip: 127.0.0.1
@@ -63,7 +71,7 @@
       :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
@@ -115,18 +123,96 @@
       :on_success: :echo3
 
 
-### configuration of monitored logs
+### Sample configuration of monitored logs
   :logs:
     - :label: :log_app_1
       :log: /tmp/test
       :pattern: ERROR
+      :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

@@ -13,6 +13,7 @@ module Splash
     # @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/cli.rb

@@ -29,6 +29,8 @@ class CLI < Thor
   include CLISplash
   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 "processes SUBCOMMAND ...ARGS", "Managing processes supervision"
@@ -41,6 +43,7 @@ class CLI < Thor
   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

@@ -93,6 +93,9 @@ module CLISplash
     option :at, :type => :string
     option :in, :type => :string
     def schedule(name)
+      unless is_root? then
+        splash_exit case: :not_root, :more => "Command scheduling"
+      end
       log = get_logger
       log.level = :fatal if options[:quiet]
       hostname = (options[:hostname])? options[:hostname] : Socket.gethostname
@@ -129,11 +132,14 @@ module CLISplash
     LONGDESC
     option :hostname, :type => :string,  :aliases => "-H"
     def treeview(command)
+      unless is_root? then
+        splash_exit case: :not_root, :more => "Command treeview"
+      end
       depht = 0
       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
@@ -169,7 +175,7 @@ module CLISplash
     end
 
 
-    # Thor method : getting the list of avaible commands in splash config
+    # Thor method : getting the list of available commands in splash config
     desc "list", "Show configured commands"
     long_desc <<-LONGDESC
     Show configured commands\n
@@ -179,6 +185,9 @@ module CLISplash
     option :detail, :type => :boolean,  :aliases => "-D"
     option :hostname, :type => :string,  :aliases => "-H"
     def list
+      unless is_root? then
+        splash_exit case: :not_root, :more => "Command list"
+      end
       log = get_logger
       list = {}
       if options[:hostname] then
@@ -227,6 +236,9 @@ module CLISplash
     LONGDESC
     option :hostname, :type => :string,  :aliases => "-H"
     def show(command)
+      unless is_root? then
+        splash_exit case: :not_root, :more => "Command show specifications"
+      end
       log = get_logger
       list = {}
       if options[:hostname] then
@@ -265,6 +277,57 @@ module CLISplash
       end
     end
 
+
+
+    # Thor method : show commands executions  history
+    long_desc <<-LONGDESC
+    show commands executions history for LABEL\n
+    LONGDESC
+    option :table, :type => :boolean,  :aliases => "-t"
+    desc "history LABEL", "show commands executions history"
+    def history(command)
+      if is_root? then
+        log = get_logger
+        log.info "Log : #{command}#"
+        config = get_config
+        if options[:table] then
+          table = TTY::Table.new do |t|
+            t << ["Start Date","Status", "end_date", "Execution time","STDOUT empty ? ", "STDERR empty ? "]
+            t << ['','','','','','']
+            CmdRecords::new(command).get_all_records.each do |item|
+              record =item.keys.first
+              value=item[record]
+              t << [record, value[:status].to_s,
+                            value[:end_date],
+                            value[:exec_time],
+                            value[:stdout].empty?,
+                            value[:stdout].empty?]
+            end
+          end
+          if check_unicode_term  then
+            puts table.render(:unicode)
+          else
+            puts table.render(:ascii)
+          end
+
+        else
+          CmdRecords::new(command).get_all_records.each do |item|
+            record =item.keys.first
+            value=item[record]
+            log.item record
+            log.arrow "Status : #{value[:status].to_s}"
+            log.arrow "End date : #{value[:end_date]}"
+            log.arrow "Execution time : #{value[:exec_time]}"
+            log.arrow "STDOUT empty ?  : #{value[:stdout].empty?}"
+            log.arrow "STDERR empty ?  : #{value[:stderr].empty?}"
+          end
+        end
+        splash_exit case: :quiet_exit
+      else
+        splash_exit case: :not_root, :more => "Command execution history"
+      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
@@ -273,6 +336,9 @@ module CLISplash
     LONGDESC
     option :hostname, :type => :string,  :aliases => "-H"
     def lastrun(command)
+      unless is_root? then
+        splash_exit case: :not_root, :more => "Command last execution report"
+      end
       log = get_logger
       backend = get_backend :execution_trace
       redis = (backend.class == Splash::Backends::Redis)? true : false
@@ -294,7 +360,7 @@ module CLISplash
           tp = Template::new(
               list_token: get_config.execution_template_tokens,
               template_file: get_config.execution_template_path)
-          tp.map YAML::load(res)
+          tp.map YAML::load(res).last.values.first
           log.flat tp.output
         else
           log.ko "Command not already runned."
@@ -305,6 +371,58 @@ module CLISplash
       end
     end
 
+
+    # Thor method : getting information on one specific execution of a command
+    desc "onerun COMMAND", "Show running result for specific configured command COMMAND"
+    long_desc <<-LONGDESC
+    Show specific running result for specific configured command COMMAND\n
+    with --hostname <HOSTNAME>, an other Splash monitored server (only with Redis backend configured)
+    with --date <DATE>, a date format string (same as in history ouput)
+
+    LONGDESC
+    option :hostname, :type => :string,  :aliases => "-H"
+    option :date, :type => :string,  :aliases => "-D", :required => true
+    def onerun(command)
+      unless is_root? then
+        splash_exit case: :not_root, :more => "Command specific execution report"
+      end
+      log = get_logger
+      backend = get_backend :execution_trace
+      redis = (backend.class == Splash::Backends::Redis)? true : false
+      if not redis and options[:hostname] then
+        splash_exit case: :specific_config_required, :more => "Redis backend is requiered for Remote execution report request"
+      end
+      splash_exit case: :not_root if not is_root? and not redis
+      list = get_config.commands.keys
+      if options[:hostname] then
+        options[:hostname] = Socket.gethostname if options[:hostname] == 'hostname'
+        list = backend.list("*", options[:hostname]).map(&:to_sym)
+      end
+      if list.include? command.to_sym then
+        log.info "Splash command #{command} previous execution report:\n"
+        req  = { :key => command}
+        req[:hostname] = options[:hostname] if options[:hostname]
+        if backend.exist? req then
+          res = backend.get req
+          tp = Template::new(
+              list_token: get_config.execution_template_tokens,
+              template_file: get_config.execution_template_path)
+          prov =  YAML::load(res).select{|key,value| key.keys.first == options[:date]}
+          if prov.empty? then
+            log.ko "Command not runned one this date or date misformatted."
+          else
+            tp.map prov.first.values.first
+            log.flat tp.output
+          end
+        else
+          log.ko "Command not already runned."
+        end
+        splash_exit case: :quiet_exit
+      else
+        splash_exit case: :not_found, :more => "Command report never runned remotly" if options[:hostname]
+      end
+    end
+
     # Thor method : getting the list of avaibles executions reports
     desc "getreportlist", "list all executions report results "
     long_desc <<-LONGDESC
@@ -320,6 +438,9 @@ module CLISplash
     option :all, :type => :boolean, :negate => false,  :aliases => "-A"
     option :detail, :type => :boolean,  :aliases => "-D"
     def getreportlist
+      unless is_root? then
+        splash_exit case: :not_root, :more => "Command execution report list"
+      end
       log = get_logger
       options[:hostname] = Socket.gethostname if options[:hostname] == 'hostname'
       if options[:hostname] and options[:all] then
@@ -355,10 +476,9 @@ module CLISplash
           req = { :key => command }
           req[:hostname] = host if options[:all]
           res = YAML::load(backend.get(req))
-          log.arrow "Status : #{res[:status]}"
-          log.arrow "Start date : #{res[:start_date]}"
-          log.arrow "End date : #{res[:end_date]}"
-          log.arrow "Execution time : #{res[:exec_time]}"
+          res.each do |record|
+            log.arrow "#{record.keys.first} : #{record[record.keys.first][:status]}"
+          end
         end
       end
       splash_exit case: :quiet_exit