heartbeat_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d34ba3323b944cc84d98bac468998098441293d
+  data.tar.gz: 81ecafb6e37febc1eba5cac95db8c3872ca19bf5
+SHA512:
+  metadata.gz: e94bec3bd78da48a92be99a24813aa289b00acb09284128f256090f891a2a2392864a933fab2dd70f1eaa9ee5fc739246e3f3ddf73069c87abb7cfd4f724673f
+  data.tar.gz: 7ca76e51131d34d0e06b861fad398d9b16da4cf38da66b7ad09f77bd6d0552f1410b9b6b501ab8d49ab709cdc2eeb900c3f501f8310f210b74e0efd167e66ba2

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+/coverage/
+Gemfile.lock
+/*.gem
+
+# RSpec failed examples
+spec/examples.txt

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require rails_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+# Use containers for fast builds
+sudo: false
+rvm:
+  - 2.2.3

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+# CHANGELOG for heartbeat_rails
+
+This file is used to list changes made in each version of heartbeat_rails.
+
+## 1.0.0: (2015-12-02)
+
+* Removed unused files/modules/views etc.
+* Automatically mount the engine at `heartbeat` endpoint (`status` is too common as word).
+* Configurable endpoint, one can change the endpoint, append it, prepend it or disable automounting using configuration methods.
+* Simplified routes, only `/heartbeat` and `/heartbeat/health` available (removed the `ping` suffix).
+* Added a `newrelic_ignore` call in the `HealthController`, heartbeat checks should not be reported as newrelic transactions
+  otherwise they improve your apdex with no reason to do that.
+* Changed the default database check to use [default active record implementation](https://github.com/rails/rails/blob/3e36db4406beea32772b1db1e9a16cc1e8aea14c/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L72)
+ which perform better and save some resources on busiest MySQL servers.That method is defined for each supported AR adapter.
+
+## 0.1.2: (2014-02-03)
+
+Features:
+
+* Updated rails dependency to allow 4.0 (now >= 3.2)
+* Now also tested on ruby 2.1
+
+## 0.1.1: (2013-08-26)
+
+Bugfixes:
+
+* Fix initialization with nested hashes in configuration (unused so far)
+
+Features:
+
+* Removed dependency on `newrelic_rpm` gem
+* Now with 100% code coverage!
+
+## 0.1.0: (2013-01-24)
+
+* Initial release of new\_relic\_ping
+
+Supported features:
+* ping action
+* health action with configurable monitoring code blocks
+* ActiveRecord database monitoring default check
+
+- - -
+Check the [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax) for help with Markdown.
+
+The [Github Flavored Markdown page](http://github.github.com/github-flavored-markdown/) describes the differences between markdown on github and standard markdown.

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in new_relic_ping.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  # for CRuby, Rubinius, including Windows and RubyInstaller
+  gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
+end
+
+# jquery-rails is used by the dummy application
+gem 'jquery-rails'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Jeremy Olliver
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+HeartbeatRails
+============
+
+[![Gem Version](https://badge.fury.io/rb/heartbeat_rails.png)](http://badge.fury.io/rb/heartbeat_rails)
+[![Build Status](https://travis-ci.org/fabn/heartbeat_rails.png?branch=master)](https://travis-ci.org/fabn/heartbeat_rails)
+
+Add a URL to your rails application to respond to ping requests from NewRelic (and other services).
+This is something that we've found we often implement. While you can often simply call the root URL
+when monitoring, that isn't always possible if the homepage is protected by a login screen which
+returns a 403 status. Adding this gem keeps the ping URL's out of your main application space, and
+as a bonus, makes additional support for data stores or other services in your heartbeat a breeze.
+
+Usage
+-----
+
+Add this to your Gemfile
+
+```ruby
+gem 'heartbeat_rails'
+```
+
+This enables two URL's (they are automatically appended in the existing routeset)
+
+```
+/heartbeat
+/heartbeat/health
+```
+
+heartbeat will respond with the text OK, and status 200 when your rails server is available.
+The health action is to allow more deep monitoring of the health of your service. You can configure
+additional checks to run when this controller action is hit, this allows you to keep tabs on things
+like response times for services or data stores your app is dependent on.
+
+Routes handling
+-----------------------------
+
+By default this gem appends the above routes in your current routeset, if you need to customize them you can use
+the following methods available via configuration methods (for instance in an initializer) 
+
+```ruby
+# config/initializers/heartbeat.rb
+HeartbeatRails.configure do |c|
+  # Customize where the engine is mounted, default is `/heartbeat`
+  c.mount_on '/whatever'
+  # Customize where the route is mounted
+  c.append_route!   # default if not specified
+  c.prepend_route!  # to prepend the engine route
+  c.dont_mount!     # if you want to manually mount the route in whatever position
+end
+```
+    
+In the latter case you have to mount the route by yourself by using a line like this in your app `routes.rb`
+
+```ruby
+mount HeartbeatRails::Engine => '/whatever-path-you-want'
+```
+    
+This can be useful if you need to apply some route constraint or if you want to protect the route in some way.
+
+Configuring monitoring checks
+-----------------------------
+
+Configure a block to run checks monitoring services you are dependent on, e.g.:
+
+```ruby
+# in config/initializers/heartbeat.rb
+HeartbeatRails.configure do |c|
+  # This database check is defined for you by default if you're using ActiveRecord
+  # though you can override it by redefining it in your configuration
+  c.monitor('database') do
+    ActiveRecord::Base.connection.execute("select count(*) from schema_migrations")
+  end
+  c.monitor('redis') do
+    # Block return value is ignored, you must raise to fail a check
+    raise 'Redis ping failed' unless 'PONG' == Redis.client.ping
+  end
+end
+```
+
+These blocks will be executed when the /health action is called, and the additional information set in the HTTP headers of the request.
+`X-{service}-Response` will be set to the return value of the block, `X-{Service}-Time` will show the execution time of the given block: "X.XXXXXX seconds".
+
+The return value of the monitoring blocks does not determine success or failure conditions, an HTTP error status will only be returned
+if the block raises an exception.
+
+You can now configure any monitoring/alerting tools that you use, such as pingdom, or new relic to 'ping' this url,
+checking if your application is alive.
+
+```
+curl -v http://localhost:3000/heartbeat
+curl -v http://localhost:3000/heartbeat/health
+```
+
+Contributing to HeartbeatRails
+------------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Credits
+-------
+
+This is a fork of the original work made by [Jeremy Olliver](https://github.com/jeremyolliver/new_relic_ping).
+
+- - -
+Copyright (c) 2013 Jeremy Olliver, (c) 2015 Fabio Napoleoni. Released under the MIT license

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/heartbeat_rails/health_controller.rb

@@ -0,0 +1,42 @@
+module HeartbeatRails
+  class HealthController < ApplicationController
+
+    # Don't include these actions as transactions in newrelic reports
+    newrelic_ignore if respond_to?(:newrelic_ignore)
+
+    # Return an okay if the Application Server is alive
+    def ping
+      send_response(:ok)
+    end
+
+    # Run the configured monitoring blocks
+    # Set the response times (return values) as HTTP headers
+    # return either ok or error status (error sent only if the configured block raises an exception)
+    def health
+      send_response(*configuration.status_check)
+    end
+
+    protected
+
+    def send_response(status_msg, meta_info = {})
+      write_headers(meta_info)
+      render :text => status_msg.to_s, :status => status_msg, :content_type => Mime::TEXT
+    end
+
+    def write_headers(values = {})
+      values.each do |name, value|
+        response.headers[header_name_for(name)] = value
+      end
+    end
+
+    # Transform :database_response => 'X-Database-Response'
+    def header_name_for(name)
+      'X' + name.to_s.camelize.gsub(/([A-Z])/) { "-#{$1}"}
+    end
+
+    def configuration
+      HeartbeatRails.config
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+HeartbeatRails::Engine.routes.draw do
+  get '/'       => 'health#ping'
+  get '/health' => 'health#health'
+end

data/heartbeat_rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heartbeat_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'heartbeat_rails'
+  spec.version = HeartbeatRails::VERSION
+  spec.authors = ['Jeremy Olliver', 'Fabio Napoleoni']
+  spec.email = %w(jeremy.olliver@gmail.com f.napoleoni@gmail.com)
+
+  spec.summary = %q{Rails endpoint for NewRelic HTTP ping monitoring}
+  spec.description = %q{Provides endpoints for NewRelic (or any other uptime service monitor) HTTP ping monitoring for Rails applications}
+  spec.homepage = 'https://github.com/fabn/heartbeat_rails'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Relaxed version constraint, we don't want to be a barrier to upgrading
+  spec.add_dependency 'rails', '>= 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+end

data/lib/heartbeat_rails/configuration.rb

@@ -0,0 +1,113 @@
+require 'benchmark'
+
+module HeartbeatRails
+  class Configuration
+
+    # Default mountpoint for engine
+    DEFAULT_MOUNTPOINT = '/heartbeat'
+    # used in railtie to read where to mount the engine
+    attr_reader :mountpoint
+
+    attr_accessor :monitors
+
+    def initialize(data={})
+      @data = {}
+      @monitors = {}
+      @mountpoint = DEFAULT_MOUNTPOINT
+      @mount_mode = :append
+      update!(data)
+      load_default_monitors
+    end
+
+    def update!(data)
+      data.each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def [](key)
+      @data[key.to_sym]
+    end
+
+    def []=(key, value)
+      @data[key.to_sym] = value
+    end
+
+    def method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
+    end
+
+    def monitor(label, &block)
+      @monitors[label.to_s] = block
+    end
+
+    # Configure where the engine should be mounted
+    def mount_at(mountpoint)
+      @mountpoint = mountpoint
+    end
+
+    def automount?
+      !!@mount_mode
+    end
+
+    def route_method
+      @mount_mode
+    end
+
+    def append_route!
+      @mount_mode = :append
+    end
+
+    def prepend_route!
+      @mount_mode = :prepend
+    end
+
+    def dont_mount!
+      @mount_mode = nil
+    end
+
+    def load_default_monitors
+      if defined?(ActiveRecord::Base)
+        monitor('database') do
+          # Delegate activeness check to actual AR implementation
+          # in MySQL it would call mysql.ping in postgres it fallback to SELECT 1
+          ActiveRecord::Base.connection.active?
+        end
+      end
+    end
+
+    def status_check
+      responses = {}
+      begin
+        @monitors.each do |label, mon|
+          time = ::Benchmark.realtime do
+            responses["#{label}_response"] = (mon.call).to_s
+          end
+          responses["#{label}_time"] = "#{time.inspect} seconds"
+        end
+        return :ok, responses
+      rescue => e
+        responses['error_message'] = e.message
+        return :error, responses
+      end
+    end
+
+  end
+
+  class << self
+    attr_accessor :config_instance
+
+    def config
+      self.config_instance ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+
+end

data/lib/heartbeat_rails/engine.rb

@@ -0,0 +1,18 @@
+require 'rails'
+
+module HeartbeatRails
+  class Engine < ::Rails::Engine
+    isolate_namespace HeartbeatRails
+
+    initializer 'heartbeat_rails.add_routes' do
+      if HeartbeatRails.config.automount?
+        Rails.logger.debug do
+          "Mounting HeartbeatRails::Engine at #{HeartbeatRails.config.mountpoint} with mode #{HeartbeatRails.config.route_method}"
+        end
+        Rails.application.routes.public_send(HeartbeatRails.config.route_method) do
+          mount HeartbeatRails::Engine => HeartbeatRails.config.mountpoint
+        end
+      end
+    end
+  end
+end

data/lib/heartbeat_rails/version.rb

@@ -0,0 +1,3 @@
+module HeartbeatRails
+  VERSION = '1.0.0'
+end

data/lib/heartbeat_rails.rb

@@ -0,0 +1,6 @@
+require 'heartbeat_rails/engine'
+require 'heartbeat_rails/configuration'
+require 'heartbeat_rails/version'
+
+module HeartbeatRails
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/heartbeat_rails/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: heartbeat_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Olliver
+- Fabio Napoleoni
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides endpoints for NewRelic (or any other uptime service monitor)
+  HTTP ping monitoring for Rails applications
+email:
+- jeremy.olliver@gmail.com
+- f.napoleoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/heartbeat_rails/health_controller.rb
+- config/routes.rb
+- heartbeat_rails.gemspec
+- lib/heartbeat_rails.rb
+- lib/heartbeat_rails/configuration.rb
+- lib/heartbeat_rails/engine.rb
+- lib/heartbeat_rails/version.rb
+- script/rails
+homepage: https://github.com/fabn/heartbeat_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Rails endpoint for NewRelic HTTP ping monitoring
+test_files: []