alerty 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99625b0f092fb2052e60c8129488d491979362b1
-  data.tar.gz: 880411be5f61727839f2cfb6e72c5d5113fd4ffa
+  metadata.gz: 689717247b8b716abcb2c075cb639dea127bceb4
+  data.tar.gz: 3e30b2ad81fef99ed76de3890f2fd604e352874c
 SHA512:
-  metadata.gz: 9233e87fdfc4cb57d2421749a2b5596d9d6e06c20518ecef6fac7d5a902ccd1d65ad3066c74d7e5787ca729ec5023c86c98d732536f35e5becfde49ffe37583e
-  data.tar.gz: d55ebdb2a4aa61cb5cad01599789acbdea3f3ec219efb2de4be783b853ada5bb61e9375f19ca099c59295cb8d0f520ea451b14624bb9b4e14a18d6f0d5792e41
+  metadata.gz: e8f92fe2bf8a763242ba11a153ce4c61e2fd94d2a05bc4187ce324c6f97fb62be620a9a115556a590a88997ef75b5ff7f5ec9145a91b77acc16b212816995e39
+  data.tar.gz: c579e1a0202ae502bf43ff8b52961fb1bbfb5b5fb400781b48e7e848865e48ac93a412881a45b93103523e6864860ddf006ab3a6d0fe6d761de88685f5f44b6a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.0.9 (2015/11/23)
+
+Enhancements:
+
+* Support retry
+
 # 0.0.8 (2015/08/15)
 
 Enhancements:

data/README.md

@@ -25,6 +25,8 @@ log_path: STDOUT
 log_level: 'debug'
 timeout: 10
 lock_path: /tmp/lock
+retry_limit: 2
+retry_wait: 10
 plugins:
   - type: stdout
 ```
@@ -46,6 +48,8 @@ $ bin/alerty -h
     -l, --log-level LOG_LEVEL        log level (default: warn)
     -t, --timeout SECONDS            timeout of the command, send alert if timeout reached (default: no timeout)
         --lock LOCK_FILE             exclusive lock file to prevent running a command duplicatedly, send alert if locked (default: no lock)
+        --retry-limit NUMBER         number of retries (default: 0)
+        --retry-wait SECONDS         retry interval = retry wait +/- 12.5% randomness (default: 1.0)
     -d, --debug                      debug mode (same with --log-level debug)
 ```
 
@@ -117,6 +121,7 @@ plugins:
 * output: the output of the exectued command
 * started_at: the time when command executed in epoch time.
 * duration: the duration which the command execution has taken in seconds. 
+* retries: the number of retries
 
 ## ChangeLog
 

data/alerty.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "alerty"
-  gem.version       = '0.0.8'
+  gem.version       = '0.0.9'
   gem.author        = ['Naotoshi Seo']
   gem.email         = ['sonots@gmail.com']
   gem.homepage      = 'https://github.com/sonots/alerty'

data/lib/alerty/cli.rb

@@ -26,11 +26,17 @@ class Alerty
         opts[:log_level] = v
       }
       op.on('-t', '--timeout SECONDS', "timeout the command (default: no timeout)") {|v|
-        opts[:timeout] = v.to_i
+        opts[:timeout] = v.to_f
       }
       op.on('--lock LOCK_FILE', "exclusive lock file to prevent running a command duplicatedly (default: no lock)") {|v|
         opts[:lock_path] = v
       }
+      op.on('--retry-limit NUMBER', "number of retries (default: 0)") {|v|
+        opts[:retry_limit] = v.to_i
+      }
+      op.on('--retry-wait SECONDS', "retry interval = retry wait +/- 12.5% randomness (default: 1.0)") {|v|
+        opts[:retry_wait] = v.to_f
+      }
       op.on('-d', '--debug', "debug mode (same with --log-level debug)") {|v|
         opts[:log_level] = 'debug'
       }

data/lib/alerty/command.rb

@@ -11,41 +11,46 @@ class Alerty
     end
 
     def run!
-      started_at = Time.now
-      begin
-        result = Frontkick.exec("#{@command} 2>&1", @opts)
-      rescue Frontkick::Timeout => e
-        record = {
-          hostname:   @hostname,
-          command:    @command,
-          exitstatus: 1,
-          output:     "`#{@command}` is timeout (#{@opts[:timeout]} sec)",
-          started_at: started_at.to_f,
-          duration:   @opts[:timeout],
-        }
-      rescue Frontkick::Locked => e
-        record = {
-          hostname:   @hostname,
-          command:    @command,
-          exitstatus: 1,
-          output:     "`#{@opts[:exclusive]}` is locked by another process",
-          started_at: started_at.to_f,
-          duration:   0,
-        }
-      else
-        record = {
-          hostname:   @hostname,
-          command:    @command,
-          exitstatus: result.exitstatus,
-          output:     result.stdout,
-          started_at: started_at.to_f,
-          duration:   result.duration,
-        }
+      record = {}
+      with_retry do |retries|
+        started_at = Time.now
+        begin
+          result = Frontkick.exec("#{@command} 2>&1", @opts)
+        rescue Frontkick::Timeout => e
+          record = {
+            hostname:   @hostname,
+            command:    @command,
+            exitstatus: 1,
+            output:     "`#{@command}` is timeout (#{@opts[:timeout]} sec)",
+            started_at: started_at.to_f,
+            duration:   @opts[:timeout],
+            retries:    retries,
+          }
+        rescue Frontkick::Locked => e
+          record = {
+            hostname:   @hostname,
+            command:    @command,
+            exitstatus: 1,
+            output:     "`#{@opts[:exclusive]}` is locked by another process",
+            started_at: started_at.to_f,
+            duration:   0,
+            retries:    retries,
+          }
+        else
+          record = {
+            hostname:   @hostname,
+            command:    @command,
+            exitstatus: result.exitstatus,
+            output:     result.stdout,
+            started_at: started_at.to_f,
+            duration:   result.duration,
+            retries:    retries,
+          }
+        end
+        Alerty.logger.info { "result: #{record.to_json}" }
+        record
       end
-      Alerty.logger.info { "result: #{record.to_json}" }
-      if record[:exitstatus] == 0
-        exit 0
-      else
+      unless record[:exitstatus] == 0
         Config.plugins.each do |plugin|
           begin
             plugin.alert(record)
@@ -56,5 +61,19 @@ class Alerty
         exit record[:exitstatus]
       end
     end
+
+    private
+
+    def with_retry
+      retries = 0
+      while true
+        record = yield(retries)
+        break if record[:exitstatus] == 0
+        break if retries >= Config.retry_limit
+        retries += 1
+        sleep Config.retry_interval
+      end
+    end
+
   end
 end

data/lib/alerty/config.rb

@@ -34,6 +34,20 @@ class Alerty
         opts[:lock_path] || config.lock_path
       end
 
+      def retry_limit
+        opts[:retry_limit] || config.retry_limit || 0
+      end
+
+      def retry_wait
+        opts[:retry_wait] || config.retry_wait || 1.0
+      end
+
+      def retry_interval
+        @random ||= Random.new
+        randomness = retry_wait * 0.125
+        retry_wait + @random.rand(-randomness .. randomness)
+      end
+
       def plugins
         @plugins ||= config.fetch('plugins').map do |plugin|
           require "alerty/plugin/#{plugin.type}"

data/spec/command_spec.rb

@@ -19,7 +19,7 @@ describe Alerty::Command do
           timeout: 20,
           exclusive: '/tmp/lock',
         }).and_return(Frontkick::Result.new(exit_code: 0))
-        expect { command.run! }.to raise_error(SystemExit)
+        expect { command.run! }.not_to raise_error
       end
     end
 
@@ -104,5 +104,31 @@ describe Alerty::Command do
       end
     end
 
+    context 'retry' do
+      before do
+        Alerty::Config.instance_variable_set(:@config, Hashie::Mash.new(
+          plugins: [{
+            type: 'stdout',
+          }]
+        ))
+        Alerty::Config.configure(
+          log_path: '/tmp/foo',
+          log_level: 'fatal',
+          retry_limit: 1,
+        )
+      end
+
+      let(:command) { Alerty::Command.new(command: 'echo foo') }
+
+      it do
+        expect(Frontkick).to receive(:exec).twice.with("echo foo 2>&1", {
+          timeout: nil,
+          exclusive: nil,
+        }).and_return(Frontkick::Result.new(stdout: 'foo', exit_code: 1))
+        stdout = capture_stdout { expect { command.run! }.to raise_error(SystemExit) }
+        expect(JSON.parse(stdout)["retries"]).to eql(1)
+      end
+    end
+
   end
 end

data/spec/config_spec.rb

@@ -8,6 +8,8 @@ describe Alerty::Config do
         log_level: 'fatal',
         timeout: 20,
         lock_path: '/tmp/lock',
+        retry_limit: 5,
+        retry_wait: 10,
       )
     end
 
@@ -15,6 +17,8 @@ describe Alerty::Config do
     it { expect(Alerty::Config.log_level).to eql('fatal') }
     it { expect(Alerty::Config.timeout).to eql(20) }
     it { expect(Alerty::Config.lock_path).to eql('/tmp/lock') }
+    it { expect(Alerty::Config.retry_limit).to eql(5) }
+    it { expect(Alerty::Config.retry_wait).to eql(10) }
   end
 
   describe 'config' do
@@ -24,6 +28,8 @@ describe Alerty::Config do
         log_level: 'fatal',
         timeout: 20,
         lock_path: '/tmp/lock',
+        retry_limit: 5,
+        retry_wait: 10,
       ))
     end
 
@@ -31,6 +37,22 @@ describe Alerty::Config do
     it { expect(Alerty::Config.log_level).to eql('fatal') }
     it { expect(Alerty::Config.timeout).to eql(20) }
     it { expect(Alerty::Config.lock_path).to eql('/tmp/lock') }
+    it { expect(Alerty::Config.retry_limit).to eql(5) }
+    it { expect(Alerty::Config.retry_wait).to eql(10) }
+  end
+
+  describe '#retry_interval' do
+    before do
+      Alerty::Config.configure(
+        retry_wait: 10,
+      )
+    end
+
+    it do
+      # retry_wait +/- 12.5% randomness
+      expect(Alerty::Config.retry_interval).to be >= 10 - 1.25
+      expect(Alerty::Config.retry_interval).to be <= 10 + 1.25
+    end
   end
 
   describe 'plugins' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alerty
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Send an alert if a given command failed