new_relic_ping 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# CHANGELOG for new\_relic\_ping
+
+This file is used to list changes made in each version of new\_relic\_ping.
+
+## 0.1.0:
+
+* 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/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,86 @@
+NewRelicPing [![Build Status](https://secure.travis-ci.org/jeremyolliver/new_relic_ping.png)](http://travis-ci.org/jeremyolliver/new_relic_ping) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jeremyolliver/new_relic_ping)
+============
+
+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
+
+    gem 'new_relic_ping'
+
+mount in your routes.rb
+
+    mount NewRelicPing::Engine => '/status'
+    # Or optionally mount this at an obfuscated url instead
+    # mount NewRelicPing::Engine => '/status/5260b194fdea00da7e29b92f54d03028'
+
+This enables two URL's
+
+    /status/ping
+    /status/health
+
+ping 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.
+
+Configuring monitoring checks
+-----------------------------
+
+Configure a block to run checks monitoring services you are dependent on, e.g. :
+
+application.rb
+
+    ...
+    class Application < Rails::Application
+
+      NewRelicPing.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
+          Redis.client.get('test-key')
+        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/status/ping
+    curl -v http://localhost:3000/status/health
+
+Planned Features
+================
+
+* Capistrano integration for enabling/disabling new relic pinging during deploys
+* suggestions welcome
+
+Contributing to NewRelicPing
+----------------------------
+
+* 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.
+
+- - -
+Copyright (c) 2013 Jeremy Olliver, released under the MIT license

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NewRelicPing'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/new_relic_ping/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/new_relic_ping/health.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/new_relic_ping/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/new_relic_ping/health.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/new_relic_ping/application_controller.rb

@@ -0,0 +1,4 @@
+module NewRelicPing
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/new_relic_ping/health_controller.rb

@@ -0,0 +1,41 @@
+require_dependency "new_relic_ping/application_controller"
+
+module NewRelicPing
+  class HealthController < ApplicationController
+
+    # 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
+      NewRelicPing.config
+    end
+
+  end
+end

data/app/helpers/new_relic_ping/application_helper.rb

@@ -0,0 +1,4 @@
+module NewRelicPing
+  module ApplicationHelper
+  end
+end

data/app/helpers/new_relic_ping/health_helper.rb

@@ -0,0 +1,4 @@
+module NewRelicPing
+  module HealthHelper
+  end
+end

data/app/views/layouts/new_relic_ping/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>NewRelicPing</title>
+  <%= stylesheet_link_tag    "new_relic_ping/application", :media => "all" %>
+  <%= javascript_include_tag "new_relic_ping/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

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

data/lib/new_relic_ping.rb

@@ -0,0 +1,6 @@
+require "new_relic_ping/engine"
+require "new_relic_ping/configuration"
+require "new_relic_ping/version"
+
+module NewRelicPing
+end

data/lib/new_relic_ping/configuration.rb

@@ -0,0 +1,82 @@
+module NewRelicPing
+  class Configuration
+
+    attr_accessor :monitors
+
+    def initialize(data={})
+      @data = {}
+      @monitors = {}
+      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)
+      if value.class == Hash
+        @data[key.to_sym] = Config.new(value)
+      else
+        @data[key.to_sym] = value
+      end
+    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
+
+    def load_default_monitors
+      if defined?(ActiveRecord::Base)
+        monitor('database') do
+          ActiveRecord::Base.connection.select_values("select 1") == [1]
+        end
+      end
+    end
+
+    def status_check
+      responses = {}
+      begin
+        @monitors.each do |label, mon|
+          return_value = nil
+          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/new_relic_ping/engine.rb

@@ -0,0 +1,5 @@
+module NewRelicPing
+  class Engine < ::Rails::Engine
+    isolate_namespace NewRelicPing
+  end
+end

data/lib/new_relic_ping/version.rb

@@ -0,0 +1,3 @@
+module NewRelicPing
+  VERSION = "0.1.0"
+end

data/lib/tasks/new_relic_ping_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :new_relic_ping do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.