stgerman / capistrano-eye

Capistrano tasks to manage and monitor processes by eye

Capistrano::Eye

Wrap all application processes by eye monitoring tool.

Installation

Add this line to your Gemfile:

gem 'capistrano-eye'

And then run:

$ bundle

Usage

Add this line to your Capfile and deploy:restart will be setup to automatically run after :publishing is complete:

require 'capistrano/eye'

The following tasks are available: eye:load, eye:start, eye:stop, eye:quit, eye:restart, eye:info

If you want the task to run at a different point in your deployment, require capistrano/eye/no_hook instead of capistrano/eye and then add your own hook in config/deploy.rb.

# Capfile
require 'capistrano/eye/no_hook'

# config/deploy.rb
after :some_other_task, :'eye:restart'

Configuration

set :eye_roles, :app # the role of the server where the eye should be started
set :eye_env, -> { { rails_env: fetch(:stage) } } # capistrano environment
set :eye_application, -> { fetch(:application) } # capistrano application name by default
set :eye_config, -> { "./config/#{fetch(:application)}.eye" } # ./config/eye_application.eye
set :eye_work_dir, -> { release_path } # working directory path for eye

Contributing

1. Fork it ( https://github.com/[my-github-username]/capistrano-eye/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request