Rack::NewRelic::Starter

A Rack middleware that provides an endpoint to start the New Relic agent.

Add this line to your application's Gemfile:

gem 'rack-new_relic-starter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rack-new_relic-starter

By default, the middleware uses the path /_new_relic/start to provide an endpoint to start the New Relic agent:

# config.ru
require 'rack/new_relic/starter'
use Rack::NewRelic::Starter

You can specify the path of the endpoint using the path option:

# config.ru
require 'rack/new_relic/starter'
use Rack::NewRelic::Starter, path: '/foo'

If your Rack web server is a pre-forking web server and doesn't load the Rack application before forking, you will need to create a global latch object before forking:

$latch = Rack::NewRelic::Starter::Latch.new

# config.ru
require 'rack/new_relic/starter'
use Rack::NewRelic::Starter, latch: $latch

You can configure Rails to add the middleware to the middleware stack with the default options by requiring rack/new_relic/starter/rails.rb:

# Gemfile
gem 'rack-new_relic-starter', require: 'rack/new_relic/starter/rails'

If you need to specify options, you can manually configure the middleware:

# config/initializers/rack_new_relic_starter.rb
Rails.application.config.middleware.use Rack::NewRelic::Starter, path: '/foo'

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/kaorimatz/rack-new_relic-starter.

The gem is available as open source under the terms of the MIT License.

The idea of starting the New Relic agent using the Rack middleware is borrowed from partiarelic.