eye-patch 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b5844cb0bcc8406207a5838cf37b7c508096423
-  data.tar.gz: cdeffbc2afbfce475d4680ff91db40a9ec09ff6b
+  metadata.gz: 2ae126b1cd5336f830562e4756fb68111736ed76
+  data.tar.gz: 955a4abc5019da4ae7c6b23dcb026b015cecf2ca
 SHA512:
-  metadata.gz: 8c6eaabb46e382d2e04eb2f41286cab9f218d0b7a32c837ad057da6b55c838f0a9241abc726514fe63c5d32837abc3e39dd766499e3be80a5f20d0c003f84275
-  data.tar.gz: abc4cb6a750ceacb722d4be06d537858b2339d7d5c07c57b2abb2e306d83cccc65658e9f3443c61eb0e578974333b30676842bb37a002792b54e6fe8693f4cb2
+  metadata.gz: 51f2bf68434eda7600d629de9d5a8a03e3f125aeb94d3dd88a1797bb1d1d69db2adc10760caacd5b362e5a5c338a32d319a05e11248a3b0d7b3608e5b22268d0
+  data.tar.gz: c92bcd94ef883581a97107430d54ece4aa39e584250ba3c47d4a9526665a0518bd59b7f27518e1f87d02620cb32956337aecfe553ef3103ac72edea2fdd73de3

data/README.md

@@ -1,12 +1,14 @@
 # Eye::Patch
 
-TODO: Write a gem description
+`Eye::Patch` is a wrapper for the fantastic [`eye`](https://github.com/kostya/eye) process monitoring gem, with support for parsing yaml configuration files and capistrano deploys.
+
+The goal of this gem is to make eye process monitoring easier to set up, manage, and deploy for large applications.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'eye-patch'
+    gem "eye-patch"
 
 And then execute:
 
@@ -18,7 +20,105 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+`Eye::Patch` overrides `eye`'s built-in DSL to allow your eye application to be configured in a structured YAML file.
+
+#### Notifications
+
+`Eye::Patch` forgoes granular process-level notification in favor of setting up application-wide notifications for different reporting levels. The following configuration will send all error notifications to the described contact via Amazon's SES service.
+
+    notifications:
+      - name: admin
+        type: ses
+        level: error
+        contact: test+admin@example.com
+        config:
+          from: eye+notifications@example.com
+          access_key_id: Your+AWS+Access+Key+ID
+          secret_access_key: Your+AWS+Secret+Access+Key
+
+Note that SES support will only be provided if the [`aws-ses`](https://github.com/drewblas/aws-ses) gem is available on the system.
+
+#### Triggers/Checks
+
+Triggers and checks are set up much like `eye`'s basic DSL. All trigger and check types available in `eye` are supported. 
+
+    triggers:
+      - name: flapping
+        config:
+          times: 10
+          within: 1 minute
+    
+    checks:
+      - name: memory
+        config:
+          times: 3
+          every: 20 seconds
+          below: 1.5 gigabytes
+
+Note that memory and duration values are written in plain english. See `lib/eye/patch/value_parser.rb` for the regular expressions used to parse these values into usable numbers.
+
+#### Processes
+
+`Eye::Patch` uses the same conventions as `eye` for basic process configuration.
+
+    processes:
+      - name: my-process
+        config:
+          start_command: bundle exec my-process
+          pid_file: tmp/pids/my-process.pid
+
+Processes will inherit all configurations from the main application. All process options supported by `eye` are available by using the appropriate key in the `config` block.
+
+##### Grouping
+
+Rather than using the `eye` DSL's nesting approaching to setting up processes within groups, `Eye::Patch` simply needs a `group` attribute to be added to the process definition.
+
+    processes:
+      - name: my-grouped-process
+        group: my-group
+        config:
+    ...
+
+All processes sharing a group name will be grouped together when the configuration is loaded.
+
+##### Copying
+
+On occasion, it's desirable to spin up multiple copies of a process with the same configuration. `Eye::Patch` offers a shorthand for this setup with the `count` attribute.
+
+    processes:
+      - name: my-copied-process
+        count: 3
+        config:
+          start_command: bundle exec my-copied-process
+          pid_file: "copied-process-{ID}.pid"
+
+The above configuration will spin up a number of processes equal to `count`, resulting in the following monitored processes:
+
+    my-copied-process-0 <copied-process-0.pid>
+    my-copied-process-1 <copied-process-1.pid>
+    my-copied-process-2 <copied-process-2.pid>
+
+This approach pairs well with the `daemonize: true` option, as `eye` will have control over the creation and management of the enumerated PID files.
+
+### Running Locally
+
+You can test your configurations locally by running the `eye-patch` binary like so:
+
+    bundle exec eye-patch l config/eye.yml
+
+The `eye-patch` binary wraps the `eye` CLI, with some tweaks to insert `Eye::Patch` as the config file parser.
+
+### Deploying
+
+`Eye::Patch` has built-in support for capistrano deploys. Include the following in your `deploy.rb` file:
+
+    require "eye/patch/capistrano"
+
+For standard capistrano deployments with bundler, this should be enough. If you aren't using bundler, or your deploy process is more complicated, you may need to tweak the default binary locations or callback ordering.
+
+See `lib/eye/patch/capistrano.rb` for a list of available configuration options.
 
 ## Contributing
 
@@ -27,3 +127,8 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Coming Soon
+
+- Proper support for per-process triggers and checks.
+- Process templates for commonly-used libraries (unicorn, sidekiq, delayed_jobs).

data/bin/eye-patch-loader

@@ -4,7 +4,7 @@ require "eye/loader"
 require "optparse"
 require "eye/patch"
 
-options = {:debug => true}
+options = {:debug => false}
 
 OptionParser.new do |opts|
   opts.on( '-h', '--help', 'Display this screen' ) do

data/lib/eye/patch/capistrano.rb

@@ -7,14 +7,14 @@ Capistrano::Configuration.instance.load do
 
   if fetch(:eye_default_hooks)
     after  "deploy:stop",    "eye:stop"
-    after  "deploy:start",   "eye:start"
+    after  "deploy:start",   "eye:load"
     before "deploy:restart", "eye:restart"
   end
 
   namespace :eye do
 
     desc "Start eye with the desired configuration file"
-    task :start, roles: -> { fetch(:eye_roles) } do
+    task :load, roles: -> { fetch(:eye_roles) } do
       run "cd #{current_path} && #{fetch(:eye_bin)} l #{fetch(:eye_config)}"
     end
 
@@ -28,4 +28,6 @@ Capistrano::Configuration.instance.load do
       run "cd #{current_path} && #{fetch(:eye_bin)} r all"
     end
   end
+
+  before "eye:restart", "eye:load"
 end

data/lib/eye/patch/version.rb

@@ -1,5 +1,5 @@
 module Eye
   module Patch
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eye-patch
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Andrew Horner