Ops

This gem provides standardized support for obtaining environment, version, and heartbeat information from Sinatra or Rails-based web applications.

Table of Contents generated with DocToc

• Ops
  • Installation
    • For Rails apps:
    • For Sinatra apps:
  • Adding Custom Heartbeats
  • The Configuration Service Adapter (Optional)
    • Running tests

You will likely want to block or restrict access to the following routes:

Typical usage:

/ops/version      - displays version info as HTML
/ops/version.json - displays version info as JSON
/ops/heartbeat    - returns 'OK' if the app is alive
/ops/env          - display the currently set environment variables
/ops/config       - display all configuration values as JSON (optional)

This gem replaces the now-deprecated ops_routes.

1. Add the gem to your project's Gemfile:

   gem 'ops'

2. Add the following to application.rb:

   Ops.setup do |config|
     config.file_root = Rails.root
     config.environment = Rails.env
     config.repo_name = 'my_repository_name'
     config.config_service_adapter = something_that_responds_to_call # optional
   end

3. mount the gem in routes.rb:

   mount Ops.new, :at => "/ops"

1. Add the gem to your project's Gemfile:

   gem 'ops'

2. Add the following to config.ru:

   require 'ops'
   
   #...
   
   Ops.setup do |config|
     config.file_root = File.dirname __FILE__
     config.environment = ENV['RACK_ENV']
     config.config_service_adapter = something_that_responds_to_call # optional
   end
   
   run Rack::URLMap.new \
     "/"    => YourAppClass,
     "/ops" => Ops.new

   # Implementation within rack cascade:
   run Rack::Cascade.new([
     MyApp,
     MySearch::App,
     Ops.rack_app('/ops')
   ])

Additionally, you can specify custom heartbeat monitoring pages as follows:

Ops.add_heartbeat :mysql do
  conn = ActiveRecord::Base.connection
  migrations = conn.select_all("SELECT COUNT(1) FROM schema_migrations;")
  conn.disconnect!
end

The mysql example shown above would be accessed at ops/heartbeat/mysql. The heartbeat page will return a 200 ‘OK’ as long as the provided block returns true. If an error is raised, the heartbeat does not exist, or the block returns a falsey value, a 500 will be returned instead.

If you wish to use the optional configuration service, you must provide something that responds to #call with an optional Hash argument.

For example:

class MyConfigurationService
  def call(options = {})
    { key: 'value' }
  end
end

or

Proc.new { |_| { key: 'value' } }

Then just provide your "callable" per the installation instructions above.

script/test