Code Monkey home page Code Monkey logo

newrelic-grape's Introduction

NewRelic::Grape

NewRelic instrumentation for the Grape API DSL, inspired by this blog post.

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

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.

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

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

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

newrelic-grape's People

Contributors

dblock avatar flyerhzm avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.