epi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff6e7a2df3b27a605072bbedff81ea4ebb5b7c1b
-  data.tar.gz: 4609bab09c0142f2206cb733d28fb22387806fa0
+  metadata.gz: 4f4c9fe139dc5bf2d4588ee4ee5e2348a634af58
+  data.tar.gz: 6209ed9c345315d1a980d697db4b38dc4595bc98
 SHA512:
-  metadata.gz: bb50900af4312e6959956ec5a61af06f7dee51d8f509577e56eb55027c23a7a7c43e6dd2ea4ec03425e1bc0f880d9926e094667f55b0a7eb2d7b2c3ace8427bb
-  data.tar.gz: 491f3d33d0b2be9d558f159c0ac8f502a037cbea1536444c4a53ea9c77739f208ebe05507c0c895fc47e2e4b3be29401618abba1ff3ea17448b283e23c5e3608
+  metadata.gz: a988b557f92226f25c0b22d0c212e1d1a3bfa14d4872e367a52a94a480f2bcc420ea70fe170a8d7ab78de9dde7644954b25556b3cb122dc517c22f8420f55ad6
+  data.tar.gz: 2c122327a30c948c96cab15e4b00631d7eb78d66d7cb1e7003665217cf00e1b947d508e61696fff04ee5d696fb9bae57e27abeb151ab0c681c1374d6c3fcfb55

data/.yardopts

@@ -0,0 +1 @@
+-m markdown --exclude core_ext

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014 Neil E. Pearson
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,118 @@
+# Epinephrine
+
+Keeps your workers alive.
+
+## Installation
+
+```
+$ gem install epi
+```
+
+## Job Configuration
+
+Example `config.epi`:
+
+```ruby
+job resque: 'Resque Workers' do |j|
+  j.user = 'webapp'
+  j.directory = File.expand_path('..', __FILE__)
+  j.environment = {
+      QUEUE: '*',
+      TERM_CHILD: 1,
+      PIDFILE: -> p { p.pidfile }
+  }
+  j.command = 'bundle exec rake resque:work'
+  j.initial_processes = 2
+  j.allowed_processes = 1..5
+  j.stdout = nil
+  j.stderr = '/var/log/worker_errors.log'
+  j.kill_timeout = 3.seconds
+
+  j.on(:touch, __FILE__) { |job| job.restart! }
+  j.on(:memory, :gt, 350.megabytes) { |process| process.restart! }
+  j.on(:uptime, :gt, 1.day) { |process| process.restart! }
+end
+```
+
+Tell Epi to watch this config file:
+
+```
+$ epi config add config.epi
+Added configuration file: /home/my_app/config.epi
+```
+
+## Behaviour
+
+See what Epi is up to:
+
+```
+$ epi status
+---
+Running as: root
+Since: Mon 20 Oct 2014 15:27:04
+Jobs:
+  Resque Workers [resque]:
+    PID 40210:
+      Since: Mon 20 Oct 2014 15:31:20
+      CPU: 0.0%
+      Memory: 0.3%
+    PID 40213 [dying]:
+      Since: Mon 20 Oct 2014 15:31:21
+      CPU: 0.0%
+      Memory: 0.2%  
+```
+
+Start/stop workers:
+
+```
+$ epi job resque more
+Increasing 'Resque Workers' processes by 1 (from 2 to 3)
+$ epi job resque 2 less
+Decreasing 'Resque Workers' processes by 2 (from 3 to 1)
+$ epi job resque 4
+Increasing 'Resque Workers' processes by 3 (from 1 to 4)
+$ epi job resque pause
+Decreasing 'Resque Workers' processes by 4 (from 4 to 0)
+$ epi job resque resume
+Increasing 'Resque Workers' processes by 4 (from 0 to 4)
+$ epi job resque max
+Increasing 'Resque Workers' processes by 1 (from 4 to 5)
+$ epi job resque restart
+Replacing 5 'Resque Workers' processes
+```
+
+Control the Epi daemon, and all its managed processes:
+
+```
+$ epi stop
+Stopping 5 processes ...
+Shutting down ...
+$ epi start
+Starting 5 processes ...
+$ epi restart
+Stopping 5 processes ...
+Shutting down ...
+Starting 5 processes ...
+```
+
+Config files will be reloaded whenever they change.
+
+## Polling
+
+Epi checks the state of running processes every 5 seconds by running the `ps` command.
+
+Change the number of seconds between polls by setting the `EPI_INTERVAL` environment variable.
+
+## Logging
+
+Logs are written to `~/.epi/epi.log`, or `/var/log/epi.log` if run as root.
+
+Set the `EPI_LOG` environment variable to tell Epi to write logs elsewhere. Set `EPI_LOG_LEVEL` to limit logging to *debug*, *info*, *error*, *warn*, *fatal*, or *unknown*.
+
+## Running as other users
+
+You can only configure jobs to run as other users if the Epi daemon runs as root.
+
+The daemon is started the first time you run the `epi` command, as whatever user ran it. If `epi` is ever run by `root`, the original user's daemon will be replaced by a daemon owned by `root`. Once that's happened, Epi will complain if you try to start or stop the daemon as any other user.
+
+Epi recognises the history of its daemon running as root by the presence of data in `/etc/epi`. You can force it to use a particular user's data instead by setting the `EPI_HOME` environment variable to, for example, `~/.epi`.

data/lib/epi/cli.rb

@@ -6,9 +6,9 @@ module Epi
     class << self
 
       def run(args)
-        command = args.shift || 'status' # The default command
+        command = args.shift || 'help' # The default command
         begin
-          Command.run command, args
+          Command.run command.delete('-'), args
         rescue Exceptions::Fatal => error
           STDERR << error.message
           STDERR << "\n"

data/lib/epi/cli/commands/help.rb

@@ -0,0 +1,67 @@
+module Epi
+  module Cli
+    module Commands
+      # noinspection RubyStringKeysInHashInspection
+      class Help < Command
+
+        def run
+          puts doc
+          EM.stop
+        end
+
+        private
+
+        def doc
+<<-EOF
+Epinephrine v#{Epi::VERSION} (c) 2014 Neil E. Pearson
+Licensed under the Apache License, Version 2.0
+http://www.apache.org/licenses/LICENSE-2.0
+See https://github.com/hx/epi for complete documentation
+
+Usage:
+  #{$0} command [etc...]
+
+Commands:
+#{commands}
+Env vars:
+  EPI_LOG        Path to which logs should be written
+  EPI_LOG_LEVEL  Logging severity (debug, info, warn, error, fatal)
+  EPI_INTERVAL   Delay in seconds between process status checks
+  EPI_HOME       Directory in which Epi should store state data
+EOF
+        end
+
+        def commands
+          all =
+          {
+              'help' => 'Show this screen',
+
+              'config add PATH' => 'Start watching the config file at PATH',
+              'config remove PATH' => 'Stop watching the config file at PATH',
+
+              'job ID NUM' => 'Run NUM instances of ID job',
+              'job ID [more|less]' => 'Run one more/less instances of ID job',
+              'job ID NUM [more|less]' => 'Run NUM more/less instances of ID job',
+              'job ID pause' => 'Stop all instances of ID job',
+              'job ID reset' => 'Run the initial number of ID job instances',
+              'job ID max' => 'Run the maximum allowed number of ID job instances',
+              'job ID min' => 'Run the minimum allowed number of ID job instances',
+              'job ID restart' => 'Replace all instances of ID job with new ones',
+
+              'status' => 'Show details of running/dying instances',
+
+              'start' => 'Start the Epi daemon, and all expected jobs',
+              'stop' => 'Stop the Epi daemon, and all running jobs',
+              'restart' => 'Restart the Epi daemon, and all running jobs'
+
+          }
+          max_key_width = all.keys.map(&:length).max
+          all.map do |cmd, desc|
+            "  #{cmd} %s #{desc}\n" % (' ' * (max_key_width - cmd.length))
+          end.join ''
+        end
+
+      end
+    end
+  end
+end

data/lib/epi/jobs.rb

@@ -18,6 +18,14 @@ module Epi
         @by_pid = {}
       end
 
+      def interval
+        if @interval.nil?
+          @interval = (ENV['EPI_INTERVAL'] || 5).to_f
+          Epi.logger.info "Polling process status every #{@interval} second#{@interval == 1 ? '' : 's'}"
+        end
+        @interval
+      end
+
       def beat!
 
         # Cancel any scheduled beats
@@ -50,7 +58,7 @@ module Epi
         Data.save
 
         # Schedule the next beat
-        @next_beat = EventMachine.add_timer(5) { beat! } # TODO: make interval configurable
+        @next_beat = EventMachine.add_timer(interval) { beat! }
       end
 
       def shutdown!(&callback)

data/lib/epi/version.rb

@@ -1,3 +1,3 @@
 module Epi
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Neil E. Pearson
@@ -32,6 +32,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- LICENSE.txt
+- README.md
 - bin/epi
 - lib/epi.rb
 - lib/epi/cli.rb