nat-monitor 1.0.11 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ef71c5eb1a6f5fb396b13cecc77c20a55dd0b32
-  data.tar.gz: a4f7ec5adea7a6b00a5f4a96fe32161a3998c004
+  metadata.gz: 39809faab717e9222a32e1520359264a4834b6b4
+  data.tar.gz: 6035485c770176b543d8d05cf61a71967e494ac2
 SHA512:
-  metadata.gz: 8ac9f3ec2081be7ff3d6ae382ac0694d605b6ed59ea56ff5b81522840d697d5f4245a2e041389571bc4a9ece8b312b10e57409a364f3bb8a392a2a5abeacd9ce
-  data.tar.gz: 012f78d85801e864f838e3a3139664910273d2bdc23db3c9e7516729a49b9da99ec43dcd22948c61630ed6d02a5ac28a2d7cdfc6889a41090af679a9ce8fa100
+  metadata.gz: 50c4559ab357e3709eb4c38a7d78948d98334fc49ccd1fa419de097c295bd7375db66becea3444d919ad4b7f994001f9b464864aa0a7c20c03c059a70e40edc4
+  data.tar.gz: 03d4a9b94634733abb3685dd59a1923509de74872e727a630a43af92ac2b3115a423f55e612a323af0b3ad07f716ecd4911d2eb963da7700ed5a08a237f98bd0

data/.editorconfig

@@ -0,0 +1,18 @@
+; EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+; UTF-8 charset
+; Unix-style newlines with a newline ending every file
+; 4 space indent
+; Trim trailing whitespace
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+indent_size = 4

data/README.md

@@ -44,20 +44,36 @@ nodes:
 ```
 
 Optional properties include (Values shown are the defaults):
+
 ```yaml
 pings: 3
 ping_timeout: 1
 heartbeat_interval: 10
+monitor_enabled: false
 ```
 
 Optional AWS configuration include:
+
 ```yaml
 aws_access_key_id: YOUR ACCESS KEY
 aws_secret_access_key: YOUR SECRET KEY
 region: us-east-1
 ```
+
 Note that:
-  - If you don't specify the aws credentials it will use the IAM role of the instance
+
+- If you don't specify the AWS credentials it will use the IAM role of the instance
+
+The NAT Monitor has the ability to report out, via a simple URL request, its start, success, and failures. This functionality is modeled after what [Cronitor.io](http://cronitor.io) expects.
+
+Requisite configuration needed:
+
+```yaml
+monitor:
+    begin: your.url/run
+    success: your.url/complete
+    fail: your.url/fail
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec unit tests'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '--color --format documentation'
+end

data/lib/nat-monitor.rb

@@ -21,31 +21,44 @@ module EtTools
     end
 
     def validate!
+      exit_code = false
+
       case
       when !@conf['route_table_id']
-        output 'route_table_id not specified'
-        exit 1
+        msg = 'route_table_id not specified'
+        exit_code = 1
       when !route_exists?(@conf['route_table_id'])
-        output "Route #{@conf['route_table_id']} not found"
-        exit 2
+        msg = "Route #{@conf['route_table_id']} not found"
+        exit_code = 2
       when @conf['nodes'].count < 3
-        output '3 or more nodes are required to create a quorum'
-        exit 3
+        msg = '3 or more nodes are required to create a quorum'
+        exit_code = 3
       end
+
+      return unless exit_code
+
+      notify_monitor 'fail', msg
+      output msg
+      exit exit_code
     end
 
     def defaults
       { 'pings' => 3,
         'ping_timeout' => 1,
-        'heartbeat_interval' => 10 }
+        'heartbeat_interval' => 10,
+        'monitor_enabled' => false }
     end
 
     def main_loop
       loop do
         begin
+          notify_monitor 'begin'
           heartbeat
+          notify_monitor 'success'
         rescue => e
-          output "Caught #{e.class} exception: #{e.message}"
+          msg = "Caught #{e.class} exception: #{e.message}"
+          notify_monitor 'fail', msg
+          output msg
           output e.backtrace
         end
         sleep @conf['heartbeat_interval']
@@ -146,6 +159,14 @@ module EtTools
       current_master == node_id
     end
 
+    def notify_monitor(status, msg = nil)
+      return unless @conf['monitor_enabled']
+      url = monitor_url status
+      url += "?msg=#{msg}" if status == 'fail' && !msg.nil?
+
+      Net::HTTP.get(URI url)
+    end
+
     private
 
     def output(message)
@@ -158,5 +179,9 @@ module EtTools
         s.send(level, message)
       end
     end
+
+    def monitor_url(status)
+      @conf['monitor'][status]
+    end
   end
 end

data/lib/nat-monitor/version.rb

@@ -1,5 +1,5 @@
 module EtTools
   class NatMonitor
-    VERSION = '1.0.11'
+    VERSION = '1.1.0'
   end
 end

data/spec/lib/nat-monitor_spec.rb

@@ -13,6 +13,11 @@ describe EtTools::NatMonitor do
     @yaml_conf = { 'route_table_id' => @route_table_id,
                    'aws_access_key_id' => 'AWS_ACCESS_KEY_ID',
                    'aws_secret_access_key' => 'AWS_SECRET_ACCESS_KEY',
+                   'monitor' => {
+                     'begin'   => 'run',
+                     'success' => 'complete',
+                     'fail'    => 'fail'
+                   },
                    'nodes' => (
                      { @my_instance_id => '1.1.1.1' }
                    ).merge(@other_nodes) }
@@ -26,7 +31,8 @@ describe EtTools::NatMonitor do
 
     @defaults = { 'pings' => 3,
                   'ping_timeout' => 1,
-                  'heartbeat_interval' => 10 }
+                  'heartbeat_interval' => 10,
+                  'monitor_enabled' => false }
 
     allow(@nat_monitor).to receive(:my_instance_id).and_return(@my_instance_id)
   end
@@ -39,13 +45,17 @@ describe EtTools::NatMonitor do
         ({ 'route_table_id' => @route_table_id,
            'aws_access_key_id' => 'AWS_ACCESS_KEY_ID',
            'aws_secret_access_key' => 'AWS_SECRET_ACCESS_KEY',
+           'monitor_enabled' => false,
            'nodes' => @other_nodes })
       )
       allow(@nat_monitor).to receive(:route_exists?).with(any_args)
         .and_return true
     end
 
-    it 'exits with status 3' do
+    it 'sends a fail ping and exits with status 3' do
+      expect(@nat_monitor).to receive(:notify_monitor).with(
+        'fail',
+        '3 or more nodes are required to create a quorum')
       expect(@nat_monitor).to receive(:exit).with(3)
       @nat_monitor.validate!
     end
@@ -60,7 +70,10 @@ describe EtTools::NatMonitor do
         ]
     end
 
-    it 'exits with status 2' do
+    it 'sends a fail ping and exits with status 2' do
+      expect(@nat_monitor).to receive(:notify_monitor).with(
+        'fail',
+        'Route rtb-00000000 not found')
       expect(@nat_monitor).to receive(:exit).with(2)
       @nat_monitor.validate!
     end
@@ -70,11 +83,15 @@ describe EtTools::NatMonitor do
     before do
       @nat_monitor.instance_variable_set(
         :@conf,
+        'monitor_enabled' => false,
         'nodes' => ({ @my_instance_id => '1.1.1.1' }).merge(@other_nodes)
       )
     end
 
-    it 'exits with status 1' do
+    it 'sends a fail ping and exits with status 1' do
+      expect(@nat_monitor).to receive(:notify_monitor).with(
+        'fail',
+        'route_table_id not specified')
       expect(@nat_monitor).to receive(:exit).with(1)
       @nat_monitor.validate!
     end
@@ -89,7 +106,7 @@ describe EtTools::NatMonitor do
 
     it 'sets @conf correctly' do
       expect(@nat_monitor.instance_variable_get(:@conf)).to eq(
-        @yaml_conf.merge(@defaults)
+        @defaults.merge(@yaml_conf)
       )
     end
 
@@ -184,7 +201,7 @@ describe EtTools::NatMonitor do
       before do
         @nat_monitor.instance_variable_set(
           :@conf,
-          @yaml_conf.merge('mocking' => true).merge(@defaults)
+          @defaults.merge(@yaml_conf.merge('mocking' => true))
         )
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nat-monitor
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.1.0
 platform: ruby
 authors:
 - Eric Herot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -122,6 +122,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -153,11 +154,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A service for providing an HA NAT in EC2
 test_files:
 - spec/lib/nat-monitor_spec.rb
 - spec/spec_helper.rb
-has_rdoc: