global_error_handler 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b756cc40aa38a46832768117f7e6ca959c505e14
-  data.tar.gz: 1af49d0977f55587fff47a9582f35a36dbcaf3f2
+  metadata.gz: 0c3839e0cb72ce4348b001259ca8fe678f57a8d5
+  data.tar.gz: 0cd927a13f6b8fceb7fc2b2d674ae214d22f5dd9
 SHA512:
-  metadata.gz: 6cf989422e07a98f1ada0809a222c8f884c3dbcd8024e2ebdca16e6485dbac0f7d10f6d801e61da5d29de7c6f025f61ca00d09a541c8e9ab7a5d760e3182fabc
-  data.tar.gz: c6c3a8b04f883483a54376a551901ca23a7cb2f04b8a372f424e8fb0ed582ff99d41c40656e36d976c4bf1e35f59c268cb3f83898cdb0b43dc03fdf589bd8937
+  metadata.gz: 72f729fa6902dbbd5f8622e1f85236bf9db32e175e44f36261c0bf7a75a9a8577201aa578baf99e18c99fa4fb02ee2011a03f0247942ce5d1ed015e0a64308ad
+  data.tar.gz: 486a16fb83959678c0df95b2e562b0ccde715cf865ec16d31f25cada0c6afb45f0e6f919109c13cd0783128cbebc9542f77fb21aa19f54af6199dd7ac855466f

data/README.md

@@ -11,8 +11,10 @@ It adds Exceptions tab to Redis Web server in case to view, filter, delete or tr
   - [RescueFrom](#rescue_from)
   - [Subscribe to Redis notifications](#subscribe-to-redis-notifications)
 - [Data structure](#data-structure)
+  - [Database consistency](#database-consistency)
 - [Contributing](#contributing)
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,10 +29,12 @@ Or install it yourself as:
 
     $ gem install global_error_handler
 
+
 ## Configuration
 
 Add redis database configuration into `global_exceptions_handler` section of _redis.yml_. See [redis_example.yml](https://github.com/kolobock/global_error_handler/blob/master/config/redis_example.yml) for more details.
 
+
 ## Usage
 
 ### Exceptions tab
@@ -57,6 +61,7 @@ GlobalErrorHandler::Handler.new(request.env, exception).process_exception!
 ```
 
 ### Subscribe to Redis notifications
+#### rake tasks
 Following command should run on your server in case to automatically clear filters on deleting keys from redis due to expiration.
 Default expiration time is set to 4 weeks (`GlobalErrorHandler::Redis::REDIS_TTL`)
 
@@ -70,21 +75,42 @@ In case to stop subscription, run following below command
 rake global_error_handler:unsubscribe_from_expired
 ```
 
+#### capistrano tasks
 There are Capistrano recipes that run desired rake tasks on the remote server
 * global_error_handler:subscribe
 * global_error_handler:unsubscribe
 * global_error_handler:update_subscription
 
+In case to subscribe automatically after being deployed, add following require into `deploy.rb`
+
 ```ruby
+require 'global_error_handler/capistrano_recipes'
 after 'deploy:restart', 'global_error_handler:update_subscription'
 ```
 
-In case to subscribe automatically after being deployed, add following require into `deploy.rb`
+#### init.d script
+Subscribe to expiration keys should run on system start-up as well after you system has been restarted
+so there is an init.d script to do it. Note that script is for RedHat/CentOS systems only (chkconfig-dependent)!
 
-```ruby
-require 'global_error_handler/capistrano_recipes'
+To generate init.d script run following:
+
+```bash
+cap <RAILS_ENV> global_error_handler:initd:setup
 ```
 
+To install init.d script run following:
+
+```bash
+cap <RAILS_ENV> global_error_handler:initd:install
+```
+
+To uninstall init.d script run following:
+
+```bash
+cap <RAILS_ENV> global_error_handler:initd:uninstall
+```
+
+
 ## Data structure
 Redis database data structure contains following below keys:
 - 'global_error_handler:current_id' : *STRING* - stores current id of an exception. It is being incremented on adding new exception into database
@@ -103,6 +129,14 @@ Redis database data structure contains following below keys:
   - timestamp - time when exception was raised
 - 'global_error_handler:filter:\<field\>:\<filter\>' : *LIST* - stores exception' keys that are filtered by field and filter. where \<field\>: either `error_class` or `error_message`, \<filter\>: string stored in the appropriated attribute.
 
+### Database consistency
+To check the database consistency, there is a rake task that will check for filters without the keys assigned with.
+
+```bash
+rake global_error_handler:cleanup_database_dependencies
+```
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/kolobock/global_error_handler/fork )

data/config/templates/geh_subscription_init.sh.erb

@@ -0,0 +1,34 @@
+#!/bin/sh
+# chkconfig: 345 99 15
+# description: script to start <%= application %> geh_subscription
+# /etc/init.d/<%= application %>_geh_subscription
+
+start() {
+  su - <%= user %> -c "cd <%= current_path %>; PATH=$PATH:/home/<%= user %>/.rvm/bin; RAILS_ENV=<%= rails_env %> nohup rvm <%= rvm_ruby_string %> do rake global_error_handler:cleanup_database_dependencies >/dev/null 2>&1 & sleep 2"
+  su - <%= user %> -c "cd <%= current_path %>; PATH=$PATH:/home/<%= user %>/.rvm/bin; RAILS_ENV=<%= rails_env %> nohup rvm <%= rvm_ruby_string %> do rake global_error_handler:subscribe_to_expired >/dev/null 2>&1 & sleep 3"
+}
+
+stop() {
+  su - <%= user %> -c "cd <%= current_path %>; PATH=$PATH:<%= rvm_bin_path %>; RAILS_ENV=<%= rails_env %> rvm <%= rvm_ruby_string %> do rake global_error_handler:unsubscribe_from_expired"
+}
+
+case "$1" in
+  start)
+    echo "calling ${1} on <%= application %> Global Error Handler Subscription ... "
+    start
+    ;;
+  stop)
+    echo "calling ${1} on <%= application %> Global Error Handler Subscription ... "
+    stop
+    ;;
+  restart)
+    echo "calling ${1} on <%= application %> Global Error Handler Subscription ... "
+    stop
+    start
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart}"
+    exit 1
+esac
+
+exit $?

data/global_error_handler.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", '~> 1.6'
   spec.add_development_dependency "rake", '~> 10.3', '>= 10.3.2'
+  spec.add_development_dependency "capistrano", "< 3.0"
 
   spec.add_dependency 'resque', '~> 1.25', '>= 1.25.1'
-  spec.add_dependency 'haml', '~> 4.0', '>= 4.0.5'
-  spec.add_runtime_dependency     "capistrano", "< 3.0"
+  spec.add_dependency 'haml', '~> 4.0', '>= 4.0.5', '< 4.1'
 end

data/lib/global_error_handler/version.rb

@@ -1,3 +1,3 @@
 module GlobalErrorHandler
-  VERSION = "0.2.0"
+  VERSION = "0.3.2"
 end

data/lib/recipes/global_error_handler.rb

@@ -5,12 +5,13 @@ module GlobalErrorHandler
         namespace :global_error_handler do
           desc 'Subscribe to expiration'
           task :subscribe do
-            run %Q{cd #{latest_release} && RAILS_ENV=#{rails_env} nohup rake global_error_handler:subscribe_to_expired >/dev/null 2>&1 & sleep 2}
+            run %Q{cd #{current_path} && RAILS_ENV=#{rails_env} nohup rake global_error_handler:cleanup_database_dependencies >/dev/null 2>&1 & sleep 2}
+            run %Q{cd #{current_path} && RAILS_ENV=#{rails_env} nohup rake global_error_handler:subscribe_to_expired >/dev/null 2>&1 & sleep 3}
           end
 
           desc 'Unsubscribe from expiration'
           task :unsubscribe do
-            run %Q{cd #{latest_release} && #{rake} RAILS_ENV=#{rails_env} global_error_handler:unsubscribe_from_expired}
+            run %Q{cd #{current_path} && RAILS_ENV=#{rails_env} #{rake} global_error_handler:unsubscribe_from_expired}
           end
 
           desc 'Update Subscription to expiration'
@@ -18,7 +19,29 @@ module GlobalErrorHandler
             unsubscribe
             subscribe
           end
-          after 'deploy:restart', 'global_error_handler:update_subscription'
+
+          namespace :initd do
+            desc 'Generate geh_subscription init.d script'
+            task :setup, roles: :app do
+              run "mkdir -p #{shared_path}/config"
+              location = File.expand_path('../../../config/templates/geh_subscription_init.sh.erb', __FILE__)
+              config = ERB.new(File.read(location))
+              put config.result(binding), "#{shared_path}/config/#{application}_geh_subscription_init.sh"
+            end
+
+            desc 'Copy geh_subscription into an init.d and adds to chkconfig'
+            task :install, roles: :app do
+              sudo "cp #{shared_path}/config/#{application}_geh_subscription_init.sh /etc/init.d/#{application}_geh_subscription;\
+                sudo chmod +x /etc/init.d/#{application}_geh_subscription;\
+                sudo chkconfig --add #{application}_geh_subscription", pty: true
+            end
+
+            desc 'Removes geh_subscription from an init.d and deletes from chkconfig'
+            task :uninstall, roles: :app do
+              sudo "chkconfig --del #{application}_geh_subscription;\
+                sudo rm -f /etc/init.d/#{application}_geh_subscription", pty: true
+            end
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: global_error_handler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrii Rudenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +88,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -84,20 +101,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.5
-- !ruby/object:Gem::Dependency
-  name: capistrano
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
 description: On the middleware level catch an exception from Rails app and store in
   the separated Redis database.
 email:
@@ -112,6 +118,7 @@ files:
 - README.md
 - Rakefile
 - config/redis_example.yml
+- config/templates/geh_subscription_init.sh.erb
 - global_error_handler.gemspec
 - lib/global_error_handler.rb
 - lib/global_error_handler/app_exception.rb