https://github.com/xinminlabs/newrelic-grape

newrelic instrument for grape
https://github.com/xinminlabs/newrelic-grape

Last synced: 7 days ago
JSON representation

newrelic instrument for grape

• Host: GitHub
• URL: https://github.com/xinminlabs/newrelic-grape
• Owner: xinminlabs
• License: mit
• Archived: true
• Created: 2012-12-18T08:34:32.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2017-03-09T06:38:19.000Z (over 7 years ago)
• Last Synced: 2024-10-18T22:10:26.212Z (26 days ago)
• Language: Ruby
• Homepage:
• Size: 59.6 KB
• Stars: 119
• Watchers: 7
• Forks: 44
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# NewRelic::Grape

### NewRelic has already officially support grape, see more [here](https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/grape-instrumentation)

[![Build Status](https://travis-ci.org/xinminlabs/newrelic-grape.svg)](https://travis-ci.org/xinminlabs/newrelic-grape)

NewRelic instrumentation for the [Grape API DSL][0], inspired by [this blog post][1].

If you use newrelic_rpm < 3.9.0, please use newrelic-grape 1.4.x

If you use newrelic_rpm >= 3.9.0, please use newrelic-grape >= 2.0.0

**Please note**: newrelic_rpm 3.9.8 is [incompatible](https://discuss.newrelic.com/t/refusing-to-re-register-dependencydetection-block-with-name-grape/13734)! A fix was [included in 3.9.9](https://docs.newrelic.com/docs/release-notes/agent-release-notes/ruby-release-notes/ruby-agent-399275).

## Installation

Add this line to your application's Gemfile:

    gem 'newrelic-grape'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install newrelic-grape

If you're using Rails, make sure that you've told rack to start the agent for Grape:

    # config.ru

    require ::File.expand_path('../config/environment',  __FILE__)

    # You need to manually start the agent

    NewRelic::Agent.manual_start

    run YourApplication::Application

## Usage

Ensure that you have working NewRelic instrumentation. Add the `newrelic-grape` gem. That's it.

## Disabling Instrumentation

Set `disable_grape` in `newrelic.yml` or `ENV['DISABLE_NEW_RELIC_GRAPE']` to disable instrumentation.

## Testing

This gem naturally works in NewRelic developer mode. For more information see the [NewRelic Developer Documentation][2].

To ensure instrumentation in tests, check that `perform_action_with_newrelic_trace` is invoked on an instance of `NewRelic::Agent::Instrumentation::Grape` when calling your API.

### RSpec

``` ruby

describe NewRelic::Agent::Instrumentation::Grape do

  it "traces" do

    NewRelic::Agent::Instrumentation::Grape

      .any_instance

      .should_receive(:perform_action_with_newrelic_trace)

      .and_yield

    get "/ping"

    response.status.should == 200

  end

end

```

## Demos

* [Grape on Rack w/ NewRelic Instrumentation Enabled][3]

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Update `CHANGELOG.md` describing your changes

4. Commit your changes (`git commit -am 'Add some feature'`)

5. Push to the branch (`git push origin my-new-feature`)

6. Create new Pull Request

[0]: https://github.com/intridea/grape

[1]: http://artsy.github.com/blog/2012/11/29/measuring-performance-in-grape-apis-with-new-relic

[2]: https://newrelic.com/docs/ruby/developer-mode

[3]: https://github.com/dblock/grape-on-rack