watchmonkey_cli 1.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 553a66c3a760e64c80ac8af012b7119721aaf521
-  data.tar.gz: fec50a69b3321cfd2c5d38b9e78d65218471e5bd
+  metadata.gz: 856c3354f0039a351a73dfd0175af79e387078fb
+  data.tar.gz: 07e20ff5db1bc068d50784b826a05d412b5a7836
 SHA512:
-  metadata.gz: ca30f9f9e6702f400c3d05bdf81fca702adc04b52126ad15d71c21472a30d5076d761f7a9877120a54768fd0091934856882901b13891758f9d2156e44e80e88
-  data.tar.gz: 95df3dba388da9fddc6fd44bf7c9ff6a38480c42db424de3a75307a0949537da4d60d7f3400aac3970eeb43e9fd8f4049ae94be267394d926f0c8c3d51c20449
+  metadata.gz: e19791d169aa0d08700b7f85a2b38932271f640b676737f50ecd0beab86c87486068967f5a3ed896925d4fc43548a09932bed2cec201d8fc9ba58d62ed4d3538
+  data.tar.gz: 1fa78746dafc66551783806f3ea963badf8aae01a61fdc23fdf349655449721c6203837607013506279d513c8f6cc0f7b44c00de008b22f91b58a7614d658077

data/README.md

@@ -1,6 +1,13 @@
 # Watchmonkey CLI
 
-Coming soon.
+Watchmonkey is a very simple tool to monitor resources with Ruby without the need of installing agents on the systems you want to monitor. To accomplish this the application polls information via SSH or other endpoints (e.g. websites, FTP access). It's suitable for small to medium amounts of services.
+
+Before looking any further you might want to know:
+
+  * There is no escalation or notification system but you may add it yourself
+  * I created this for being used with [Platypus](http://sveinbjorn.org/platypus) hence the [Platypus Hook](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb)
+  * This is how the text output looks like: [Screenshot](http://imgur.com/8yLYnKb)
+  * This is how the Platypus support looks like: [ProgressBar](http://imgur.com/Vd8ZD7A) [HTML/WebView](http://imgur.com/5FwmWFZ)
 
 ---
 
@@ -9,24 +16,73 @@ If you need help or have problems [open an issue](https://github.com/2called-cha
 
 
 ## Features
-  * Colors!
-
+  * Monitor external resources (Web, FTP, Server health via SSH)
+  * Run once or loop forever with ReQueue (define intervals globally, per checker or per single test)
+  * Includes a selection of buildin checkers (basic *nix health, WWW availability & SSL expiration, FTP)
 
 
 ## Requirements
   * Ruby >= 2.0
-  * Unixoid OS (such as Ubuntu/Debian, OS X, maybe others) or Windows 7/8 (not recommended)
+  * Unixoid OS (such as Ubuntu/Debian, OS X, maybe others) or Windows (not recommended)
   * something you want to monitor
 
 
-
 ## Installation
   * `gem install watchmonkey_cli`
   * `watchmonkey --generate-config [name=default]`
+  * Edit the created file to fit your needs
+  * Run `watchmonkey`
+  * Check out the additional features below (e.g. ReQueue)
+
+
+## Usage
+To get a list of available options invoke Watchmonkey with the `--help` or `-h` option:
+
+    Usage: watchmonkey [options]
+    # Application options
+            --generate-config [myconfig] Generates a example config in ~/.watchmonkey
+        -l, --log [file]                 Log to file, defaults to ~/.watchmonkey/logs/watchmonkey.log
+        -t, --threads [NUM]              Amount of threads to be used for checking (default: 10)
+        -s, --silent                     Only print errors and infos
+        -q, --quiet                      Only print errors
+
+    # General options
+        -d, --debug [lvl=1]              Enable debug output
+        -m, --monochrome                 Don't colorize output
+        -h, --help                       Shows this help
+        -v, --version                    Shows version and other info
+        -z                               Do not check for updates on GitHub (with -v/--version)
+            --dump-core                  for developers
+
+
+## Documentation
+Writing a documentation takes time and I'm not sure if anyone is even interested in this tool. If there is interest I will write a documentation but for now this Readme must suffice. If you need help just [open an issue](https://github.com/2called-chaos/watchmonkey_cli/issues/new) :)
+
+
+## Create configs
+Use the `--generate-config` option or refer to the [configuration template](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/application/configuration.tpl) for examples and documentation.
 
 
 ## Deactivate configs
-If you want to deactivate configs entirely just rename the file to start with two underscores (e.g.: `__example.rb`).
+If you want to deactivate single configs just rename the file to start with two underscores (e.g.: `__example.rb`).
+
+
+## Application configuration
+If you want to add custom checkers, hooks or change default settings you can create `~/.watchmonkey/config.rb`. The file will be eval'd in the application object's context. Take a look at the [example configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/application.rb) and [application.rb](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/doc/config_example.rb).
+
+
+## Custom checkers
+If you want to monitor something that is not covered by the buildin handlers you can create your own, it's not that hard and should be a breeze if you are used to Ruby. All descendants of the `WatchmonkeyCli::Checker` class will be initialized and are usable in the application. Documentation is thin but you can take a look at the [example checker](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/doc/checker_example.rb), the [buildin checkers](https://github.com/2called-chaos/watchmonkey_cli/tree/master/lib/watchmonkey_cli/checkers) or just [open an issue](https://github.com/2called-chaos/watchmonkey_cli/issues/new) and I might just implement it real quick.
+
+
+## Additional Features
+
+### ReQueue
+By default Watchmonkey will run all tests once and then exit. This addon will enable Watchmonkey to run in a loop and run tests on a periodic interval.
+Since this seems like a core feature it might get included directly into Watchmonkey but for now take a look at the documentation in the [ReQueue source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/requeue.rb) for integration instructions.
+
+### Platypus support
+[Platypus](http://sveinbjorn.org/platypus) is a MacOS software to create dead simple GUI wrappers for scripts. There is buildin support for the interface types ProgressBar and WebView. For information look at the documentation in the [Platypus hook source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb).
 
 
 ## Contributing
@@ -39,7 +95,6 @@ If you want to deactivate configs entirely just rename the file to start with tw
   5. Create new Pull Request
 
 
-
 ## Legal
 * © 2016, Sven Pachnit (www.bmonkeys.net)
 * watchmonkey_cli is licensed under the MIT license.

data/VERSION

@@ -1 +1 @@
-1.4
+1.5

data/bin/watchmonkey

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require "watchmonkey_cli"
 begin
+  Process.setproctitle("watchmonkey_cli")
   WatchmonkeyCli::Application.dispatch(ENV, ARGV)
 rescue Interrupt
   puts("\n\nInterrupted")

data/lib/watchmonkey_cli/application/configuration.rb

@@ -2,22 +2,53 @@ module WatchmonkeyCli
   class Application
     class Configuration
       module AppHelper
+        def wm_cfg_path
+          ENV["WM_CFGDIR"].presence || File.expand_path("~/.watchmonkey")
+        end
+
         def config_directory
           "#{wm_cfg_path}/configs"
         end
 
+        def checker_directory
+          "#{wm_cfg_path}/checkers"
+        end
+
+        def wm_cfg_configfile
+          "#{wm_cfg_path}/config.rb"
+        end
+
+        def config_filename name = "default"
+          "#{config_directory}/#{name}.rb"
+        end
+
         def config_files
           Dir["#{config_directory}/**/*.rb"].reject do |file|
             file.gsub(config_directory, "").split("/").any?{|fp| fp.start_with?("__") }
           end
         end
 
-        def config_filename name = "default"
-          "#{config_directory}/#{name}.rb"
+        def checker_files
+          Dir["#{checker_directory}/**/*.rb"].reject do |file|
+            file.gsub(config_directory, "").split("/").any?{|fp| fp.start_with?("__") }
+          end
         end
 
         def load_configs!
-          config_files.each {|f| Configuration.new(self, f) }
+          configs = config_files
+          debug "Loading #{configs.length} config files from `#{config_directory}'"
+          configs.each {|f| Configuration.new(self, f) }
+        end
+
+        def load_checkers!
+          checkers = checker_files
+          debug "Loading #{checkers.length} checker files from `#{checker_directory}'"
+          checkers.each {|f| require f }
+        end
+
+        def load_appconfig
+          return unless File.exist?(wm_cfg_configfile)
+          eval File.read(wm_cfg_configfile, encoding: "utf-8"), binding, wm_cfg_configfile
         end
 
         def generate_config name = "default"

data/lib/watchmonkey_cli/application/core.rb

@@ -0,0 +1,155 @@
+module WatchmonkeyCli
+  class Application
+    module Core
+      # ===================
+      # = Signal trapping =
+      # ===================
+      def trap_signals
+        debug "Trapping INT signal..."
+        Signal.trap("INT") do
+          $wm_runtime_exiting = true
+          Kernel.puts "Interrupting..."
+        end
+      end
+
+      def release_signals
+        debug "Releasing INT signal..."
+        Signal.trap("INT", "DEFAULT")
+      end
+
+      def haltpoint
+        raise Interrupt if $wm_runtime_exiting
+      end
+
+
+      # ==========
+      # = Events =
+      # ==========
+      def hook *which, &hook_block
+        which.each do |w|
+          @hooks[w.to_sym] ||= []
+          @hooks[w.to_sym] << hook_block
+        end
+      end
+
+      def fire which, *args
+        return if @disable_event_firing
+        sync { debug "[Event] Firing #{which} (#{@hooks[which].try(:length) || 0} handlers) #{args.map(&:class)}", 99 }
+        @hooks[which] && @hooks[which].each{|h| h.call(*args) }
+      end
+
+
+      # ==========
+      # = Logger =
+      # ==========
+      def logger_filename
+        "#{wm_cfg_path}/logs/watchmonkey.log"
+      end
+
+      def logger
+        sync do
+          @logger ||= begin
+            FileUtils.mkdir_p(File.dirname(@opts[:logfile]))
+            Logger.new(@opts[:logfile], 10, 1024000)
+          end
+        end
+      end
+
+
+      # =======================
+      # = Connection handling =
+      # =======================
+      def fetch_connection type, id, opts = {}, &initializer
+        if !@connections[type] || !@connections[type][id]
+          @connections[type] ||= {}
+          case type
+          when :loopback
+            @connections[type][id] = LoopbackConnection.new(id, opts, &initializer)
+          when :ssh
+            @connections[type][id] = SshConnection.new(id, opts, &initializer)
+          else
+            raise NotImplementedError, "unknown connection type `#{type}'!"
+          end
+        end
+        @connections[type][id]
+      end
+
+      def close_connections!
+        @connections.each do |type, clist|
+          clist.each{|id, con| con.close! }
+        end
+      end
+
+
+      # =========================
+      # = Queue tasks & methods =
+      # =========================
+      def enqueue checker, *a, &block
+        sync do
+          cb = block || checker.method(:check!)
+          evreg = @disable_event_registration
+          fire(:enqueue, checker, a, cb) unless evreg
+          @queue << [checker, a, ->(*a) {
+            begin
+              result = Checker::Result.new(checker, *a)
+              checker.debug(result.str_running)
+              checker.safe(result.str_safe) { cb.call(result, *a) }
+              fire(:result_dump, result, a, checker)
+              result.dump!
+            ensure
+              fire(:dequeue, checker, a) unless evreg
+            end
+          }]
+        end
+      end
+
+      def enqueue_sub checker, which, *args
+        sync do
+          if sec = @checkers[which.to_s]
+            begin
+              # ef_was = @disable_event_firing
+              er_was = @disable_event_registration
+              # @disable_event_firing = true
+              @disable_event_registration = true
+              sec.enqueue(*args)
+            ensure
+              # @disable_event_firing = ef_was
+              @disable_event_registration = er_was
+            end
+          end
+        end
+      end
+
+      def spawn_threads_and_run!
+        if @opts[:threads] > 1
+          debug "Spawning #{@opts[:threads]} consumer threads..."
+          @opts[:threads].times do
+            @threads << Thread.new do
+              Thread.current.abort_on_exception = true
+              _queueoff
+            end
+          end
+        else
+          debug "Running threadless..."
+          _queueoff
+        end
+      end
+
+      def _queueoff
+        while !@queue.empty? || @opts[:loop_forever]
+          break if $wm_runtime_exiting
+          item = queue.pop(true) rescue false
+          if item
+            Thread.current[:working] = true
+            fire(:wm_work_start, Thread.current)
+            sync { @processed += 1 }
+            item[2].call(*item[1])
+            Thread.current[:working] = false
+            fire(:wm_work_end, Thread.current)
+          end
+          sleep @opts[:loop_wait_empty] if @opts[:loop_forever] && @opts[:loop_wait_empty] && @queue.empty?
+        end
+      end
+    end
+  end
+end

data/lib/watchmonkey_cli/application/dispatch.rb

@@ -28,6 +28,7 @@ module WatchmonkeyCli
       def dispatch_index
         Thread.abort_on_exception = true
         trap_signals
+        load_checkers!
         init_checkers!
         load_configs!
         dump_and_exit! if @opts[:dump]

data/lib/watchmonkey_cli/application/output_helper.rb

@@ -0,0 +1,30 @@
+module WatchmonkeyCli
+  class Application
+    module OutputHelper
+      def puts *a
+        sync { @opts[:stdout].send(:puts, *a) }
+      end
+
+      def print *a
+        sync { @opts[:stdout].send(:print, *a) }
+      end
+
+      def warn *a
+        sync { @opts[:stdout].send(:warn, *a) }
+      end
+
+      def debug msg, lvl = 1
+        puts c("[DEBUG] #{msg}", :black) if @opts[:debug] && @opts[:debug] >= lvl
+      end
+
+      def abort msg, exit_code = 1
+        puts c("[ABORT] #{msg}", :red)
+        exit(exit_code)
+      end
+
+      def error msg
+        warn c(msg, :red)
+      end
+    end
+  end
+end

data/lib/watchmonkey_cli/application.rb

@@ -1,8 +1,10 @@
 module WatchmonkeyCli
   class Application
     attr_reader :opts, :checkers, :connections, :threads, :queue, :hooks, :processed
-    include Helpers
+    include Helper
+    include OutputHelper
     include Colorize
+    include Core
     include Dispatch
     include Configuration::AppHelper
     include Checker::AppHelper
@@ -12,7 +14,7 @@ module WatchmonkeyCli
     # =========
     def self.dispatch *a
       new(*a) do |app|
-        app.load_config
+        app.load_appconfig
         app.parse_params
         begin
           app.dispatch
@@ -27,6 +29,7 @@ module WatchmonkeyCli
     end
 
     def initialize env, argv
+      @boot = Time.current
       @env, @argv = env, argv
       @connections = {}
       @hooks = {}
@@ -46,6 +49,7 @@ module WatchmonkeyCli
         loop_wait_empty: 1,      # (internal) time to wait in thread if queue is empty
         silent: false,           # -s flag
         quiet: false,            # -q flag
+        stdout: STDOUT,          # (internal) STDOUT redirect
       }
       init_params
       yield(self)
@@ -63,7 +67,7 @@ module WatchmonkeyCli
         opts.on("-q", "--quiet", "Only print errors") { @opts[:quiet] = true }
 
         opts.separator("\n" << c("# General options", :blue))
-        opts.on("-d", "--debug", "Enable debug output") { @opts[:debug] = true }
+        opts.on("-d", "--debug [lvl=1]", Integer, "Enable debug output") {|l| @opts[:debug] = l || 1 }
         opts.on("-m", "--monochrome", "Don't colorize output") { @opts[:colorize] = false }
         opts.on("-h", "--help", "Shows this help") { @opts[:dispatch] = :help }
         opts.on("-v", "--version", "Shows version and other info") { @opts[:dispatch] = :info }
@@ -84,167 +88,10 @@ module WatchmonkeyCli
       @running
     end
 
-    def load_config
-      return unless File.exist?(wm_cfg_configfile)
-      eval File.read(wm_cfg_configfile, encoding: "utf-8"), binding, wm_cfg_configfile
-    end
-
-    def debug msg
-      puts c("[DEBUG] #{msg}", :black) if @opts[:debug]
-    end
-
-    def abort msg, exit_code = 1
-      puts c("[ABORT] #{msg}", :red)
-      exit(exit_code)
-    end
-
-    def error msg
-      warn c(msg, :red)
-    end
-
-    def hook *which, &hook_block
-      which.each do |w|
-        @hooks[w.to_sym] ||= []
-        @hooks[w.to_sym] << hook_block
-      end
-    end
-
-    def fire which, *args
-      return if @disable_event_firing
-      sync { debug "[Event] Firing #{which} (#{@hooks[which].try(:length) || 0} handlers) #{args.map(&:class)}" }
-      @hooks[which] && @hooks[which].each{|h| h.call(*args) }
-    end
-
-    def fetch_connection type, id, opts = {}, &initializer
-      if !@connections[type] || !@connections[type][id]
-        @connections[type] ||= {}
-        case type
-        when :loopback
-          @connections[type][id] = LoopbackConnection.new(id, opts, &initializer)
-        when :ssh
-          @connections[type][id] = SshConnection.new(id, opts, &initializer)
-        else
-          raise NotImplementedError, "unknown connection type `#{type}'!"
-        end
-      end
-      @connections[type][id]
-    end
-
-    def close_connections!
-      @connections.each do |type, clist|
-        clist.each{|id, con| con.close! }
-      end
-    end
-
     def sync &block
       @monitor.synchronize(&block)
     end
 
-    def spawn_threads_and_run!
-      if @opts[:threads] > 1
-        debug "Spawning #{@opts[:threads]} consumer threads..."
-        @opts[:threads].times do
-          @threads << Thread.new do
-            Thread.current.abort_on_exception = true
-            _queueoff
-          end
-        end
-      else
-        debug "Running threadless..."
-        _queueoff
-      end
-    end
-
-    def enqueue checker, *a, &block
-      sync do
-        cb = block || checker.method(:check!)
-        evreg = @disable_event_registration
-        fire(:enqueue, checker, a, cb) unless evreg
-        @queue << [checker, a, ->(*a) {
-          begin
-            result = Checker::Result.new(checker, *a)
-            checker.debug(result.str_running)
-            checker.safe(result.str_safe) { cb.call(result, *a) }
-            fire(:result_dump, result, a, checker)
-            result.dump!
-          ensure
-            fire(:dequeue, checker, a) unless evreg
-          end
-        }]
-      end
-    end
-
-    def enqueue_sub checker, which, *args
-      sync do
-        if sec = @checkers[which.to_s]
-          begin
-            # ef_was = @disable_event_firing
-            er_was = @disable_event_registration
-            # @disable_event_firing = true
-            @disable_event_registration = true
-            sec.enqueue(*args)
-          ensure
-            # @disable_event_firing = ef_was
-            @disable_event_registration = er_was
-          end
-        end
-      end
-    end
-
-    def _queueoff
-      while !@queue.empty? || @opts[:loop_forever]
-        break if $wm_runtime_exiting
-        item = queue.pop(true) rescue false
-        if item
-          Thread.current[:working] = true
-          fire(:wm_work_start, Thread.current)
-          sync { @processed += 1 }
-          item[2].call(*item[1])
-          Thread.current[:working] = false
-          fire(:wm_work_end, Thread.current)
-        end
-        sleep @opts[:loop_wait_empty] if @opts[:loop_forever] && @opts[:loop_wait_empty] && @queue.empty?
-      end
-    end
-
-    def wm_cfg_path
-      ENV["WM_CFGDIR"].presence || File.expand_path("~/.watchmonkey")
-    end
-
-    def wm_cfg_configfile
-      "#{wm_cfg_path}/config.rb"
-    end
-
-    def logger_filename
-      "#{wm_cfg_path}/logs/watchmonkey.log"
-    end
-
-    def logger
-      sync do
-        @logger ||= begin
-          FileUtils.mkdir_p(File.dirname(@opts[:logfile]))
-          Logger.new(@opts[:logfile], 10, 1024000)
-        end
-      end
-    end
-
-    def trap_signals
-      debug "Trapping INT signal..."
-      Signal.trap("INT") do
-        $wm_runtime_exiting = true
-        puts "Interrupting..."
-      end
-    end
-
-    def release_signals
-      debug "Releasing INT signal..."
-      Signal.trap("INT", "DEFAULT")
-    end
-
-    def haltpoint
-      raise Interrupt if $wm_runtime_exiting
-    end
-
     def dump_and_exit!
       puts "   Queue: #{@queue.length}"
       puts " AppOpts: #{@opts}"

data/lib/watchmonkey_cli/checker.rb

@@ -34,6 +34,7 @@ module WatchmonkeyCli
       end
 
       def stop_checkers!
+        return unless @checkers
         @checkers.each do |key, instance|
           debug "[SETUP] Stopping checker `#{key}' (#{instance.class.name})"
           instance.stop
@@ -116,9 +117,7 @@ module WatchmonkeyCli
       app.fire(:on_info, msg, robj)
       return if app.opts[:quiet]
       _tolog(msg, :info)
-      app.sync do
-        puts app.c(msg, :blue)
-      end
+      app.puts app.c(msg, :blue)
     end
 
     def debug msg, robj = nil
@@ -126,9 +125,7 @@ module WatchmonkeyCli
       app.fire(:on_message, msg, robj)
       return if app.opts[:quiet] || app.opts[:silent]
       _tolog(msg, :debug)
-      app.sync do
-        puts app.c(msg, :black)
-      end
+      app.puts app.c(msg, :black)
     end
 
     def error msg, robj = nil
@@ -144,8 +141,7 @@ module WatchmonkeyCli
     end
 
     def spawn_sub which, *args
-      return false if app.running?
-      if sec = app.checkers["ssl_expiration"]
+      if sec = app.checkers[which.to_s]
         sec.enqueue(*args)
       end
     end
@@ -221,7 +217,15 @@ module WatchmonkeyCli
       # and therefore shared resources might still be in use
     end
 
+    def enqueue *args
+      # Called by configuration defining a check with all the arguments.
+      #   e.g. www_availability :my_host, foo: "bar" => args = [:my_host, {foo: "bar"}]
+      # Should invoke `app.enqueue` which will by default call `#check!` method with given arguments.
+      raise NotImplementedError, "a checker (#{self.class.name}) must implement `#enqueue' method!"
+    end
+
     def check! *a
+      # required, see #enqueue
       raise NotImplementedError, "a checker (#{self.class.name}) must implement `#check!' method!"
     end
   end

data/lib/watchmonkey_cli/checkers/ftp_availability.rb

@@ -13,9 +13,9 @@ module WatchmonkeyCli
           ftp.login(opts[:user], opts[:password])
         end
       rescue Net::FTPPermError
-        result.error "Invalid credentials!"
+        result.error! "Invalid credentials!"
       rescue SocketError => e
-        result.error "#{e.class}: #{e.message}"
+        result.error! "#{e.class}: #{e.message}"
       end
     end
   end

data/lib/watchmonkey_cli/checkers/www_availability.rb

@@ -7,7 +7,7 @@ module WatchmonkeyCli
         app.enqueue(self, page, opts.except(:ssl_expiration))
 
         # if available enable ssl_expiration support
-        if page.start_with?("https://") && opts[:ssl_expiration] != false
+        if page.start_with?("https://") && opts[:ssl_expiration] != false && !app.running?
           spawn_sub("ssl_expiration", page, opts[:ssl_expiration].is_a?(Hash) ? opts[:ssl_expiration] : {})
         end
       end
@@ -33,9 +33,9 @@ module WatchmonkeyCli
         # body
         if rx = opts[:body]
           if rx.is_a?(String)
-            result.error! "body does not include #{rx}!" if !result.result.body.include?(rx)
+            result.error! "body does not include `#{rx}'!" if !result.result.body.include?(rx)
           elsif rx.is_a?(Regexp)
-            result.error! "body does not match #{rx}!" if !result.result.body.match(rx)
+            result.error! "body does not match `#{rx}'!" if !result.result.body.match(rx)
           end
         end
 

data/lib/watchmonkey_cli/{helpers.rb → helper.rb}

@@ -1,5 +1,5 @@
 module WatchmonkeyCli
-  module Helpers
+  module Helper
     BYTE_UNITS = %W(TiB GiB MiB KiB B).freeze
 
     def human_filesize(s)

data/lib/watchmonkey_cli/hooks/platypus.rb

@@ -1,13 +1,31 @@
 module WatchmonkeyCli
+  JS_ESCAPE_MAP = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n', "\r" => '\n', '"' => '\\"', "'" => "\\'" }
   class Platypus
+    class SilentOutput
+      def print *a
+      end
+      def puts *a
+      end
+      def warn *a
+      end
+    end
+
     def self.hook!(app, opts = {})
-      opts = opts.reverse_merge(notifications: true)
+      opts = opts.reverse_merge(notifications: 1, progress: true, html: false, draw_delay: 1)
+      opts[:progress] = false if opts[:html]
       app.instance_eval do
+        @opts[:stdout] = SilentOutput.new
+        @platypus_status_cache = {
+          errors: [],
+        }
+
         # send errors via notification center
         hook :result_dump do |robj, args, checker|
           if robj.error?
             robj.messages.each do |m|
               msg  = "#{robj.args[0].try(:name) || robj.args[0].presence || "?"}: #{m}"
+              @platypus_status_cache[:errors].unshift([Time.current, msg])
+              @platypus_status_cache[:errors].pop if @platypus_status_cache[:errors].length > 20
 
               case opts[:notifications]
               when 1
@@ -16,7 +34,7 @@ module WatchmonkeyCli
                 `osascript -e 'display notification "#{fmsg}" with title "WatchMonkey"'`
               when 2
                 # makes a sound
-                sync { puts "NOTIFICATION:#{msg}" }
+                puts "NOTIFICATION:#{msg}"
               end
             end
           end
@@ -24,13 +42,76 @@ module WatchmonkeyCli
 
         hook :wm_work_start, :wm_work_end do
           # mastermind calculation I swear :D (<-- no idea what I did here)
-          # sync { puts "PROGRESS:#{((@threads.length-@threads.select{|t| t[:working] }.length.to_d) / @threads.length * 100).to_i}" }
+          # puts "PROGRESS:#{((@threads.length-@threads.select{|t| t[:working] }.length.to_d) / @threads.length * 100).to_i}"
           sync do
             active = @threads.select{|t| t[:working] }.length
             total  = @threads.select{|t| t[:working] }.length + @queue.length
             perc   = total.zero? ? 100 : (active.to_d / total * 100).to_i
             puts "PROGRESS:#{perc}"
           end
+        end if opts[:progress]
+
+        # HTML output (fancy as fuck!)
+        if opts[:html]
+          def escape_javascript str
+            str.gsub(/(\|<\/|\r\n|\342\200\250|\342\200\251|[\n\r"'])/u) {|match| JS_ESCAPE_MAP[match] }
+          end
+
+          def platypus_init_html
+            output = %{
+              <html>
+                <head>
+                  <script src="https://code.jquery.com/jquery-3.1.1.min.js"></script>
+                  <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+                  <title>Moep</title>
+                </head>
+                <body style="padding: 8px">
+                  <dl class="dl-horizontal">
+                    <dt>Items in Queue</dt><dd class="qlength">#{@queue.length}</dd>
+                    <dt>Items in ReQ</dt><dd class="rqlength">#{@requeue.length}</dd>
+                    <dt>Workers</dt><dd class="workers">#{@threads.select{|t| t[:working] }.length}/#{@threads.length} working (#{@threads.select(&:alive?).length} alive)</dd>
+                    <dt>Threads</dt><dd class="tlength">#{Thread.list.length}</dd>
+                    <dt>Processed entries</dt><dd class="processed">#{@processed}</dd>
+                    <dt>Watching since</dt><dd>#{@boot}</dd>
+                    <dt>Last draw</dt><dd class="lastdraw">#{Time.current}</dd>
+                  </dl>
+                  <h3>Latest errors</h3>
+                  <pre class="lasterrors" style="display: block; white-space: pre; word-break: normal; word-wrap: normal;"></pre>
+                </body>
+              </html>
+            }
+            sync { Kernel.puts output }
+          end
+
+          def platypus_update_html
+            dead = @threads.reject(&:alive?).length
+            ti = " (#{dead} DEAD)" if dead > 0
+            output = %{
+              <script>
+                $("script").remove();
+                $("dd.qlength").html("#{@queue.length}");
+                $("dd.rqlength").html("#{@requeue.length}");
+                $("dd.workers").html("#{@threads.select{|t| t[:working] }.length}/#{@threads.length} working#{ti}");
+                $("dd.tlength").html("#{Thread.list.length}");
+                $("dd.processed").html("#{@processed}");
+                $("dd.lastdraw").html("#{Time.current}");
+                $("pre.lasterrors").html("#{escape_javascript @platypus_status_cache[:errors].map{|t,e| "#{t}: #{e}" }.join("\n")}");
+              </script>
+            }
+            sync { Kernel.puts output }
+          end
+
+          platypus_init_html
+          @platypus_status_thread = Thread.new do
+            Thread.current.abort_on_exception = true
+            loop do
+              platypus_update_html
+              sleep opts[:draw_delay]
+            end
+          end
+          hook :wm_shutdown do
+            @platypus_status_thread.try(:kill).try(:join)
+          end
         end
       end
     end

data/lib/watchmonkey_cli/hooks/requeue.rb

@@ -26,7 +26,7 @@ module WatchmonkeyCli
         # =================
         # = Status thread =
         # =================
-        @platypus_status_thread = Thread.new do
+        @requeue_status_thread = Thread.new do
           Thread.current.abort_on_exception = true
           while STDIN.gets
             sync do

data/lib/watchmonkey_cli/version.rb

@@ -1,4 +1,4 @@
 module WatchmonkeyCli
-  VERSION = "1.4"
+  VERSION = "1.5"
   UPDATE_URL = "https://raw.githubusercontent.com/2called-chaos/watchmonkey_cli/master/VERSION"
 end

data/lib/watchmonkey_cli.rb

@@ -21,8 +21,10 @@ require 'net/ssh'
 require "watchmonkey_cli/version"
 require "watchmonkey_cli/loopback_connection"
 require "watchmonkey_cli/ssh_connection"
-require "watchmonkey_cli/helpers"
+require "watchmonkey_cli/helper"
 require "watchmonkey_cli/checker"
+require "watchmonkey_cli/application/core"
+require "watchmonkey_cli/application/output_helper"
 require "watchmonkey_cli/application/colorize"
 require "watchmonkey_cli/application/configuration"
 require "watchmonkey_cli/application/dispatch"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watchmonkey_cli
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.5'
 platform: ruby
 authors:
 - Sven Pachnit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -117,7 +117,9 @@ files:
 - lib/watchmonkey_cli/application/colorize.rb
 - lib/watchmonkey_cli/application/configuration.rb
 - lib/watchmonkey_cli/application/configuration.tpl
+- lib/watchmonkey_cli/application/core.rb
 - lib/watchmonkey_cli/application/dispatch.rb
+- lib/watchmonkey_cli/application/output_helper.rb
 - lib/watchmonkey_cli/checker.rb
 - lib/watchmonkey_cli/checkers/ftp_availability.rb
 - lib/watchmonkey_cli/checkers/mysql_replication.rb
@@ -129,7 +131,7 @@ files:
 - lib/watchmonkey_cli/checkers/unix_mdadm.rb
 - lib/watchmonkey_cli/checkers/unix_memory.rb
 - lib/watchmonkey_cli/checkers/www_availability.rb
-- lib/watchmonkey_cli/helpers.rb
+- lib/watchmonkey_cli/helper.rb
 - lib/watchmonkey_cli/hooks/platypus.rb
 - lib/watchmonkey_cli/hooks/requeue.rb
 - lib/watchmonkey_cli/loopback_connection.rb