newrelic-grape 1.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c545d92d15495cb96292ad77d6974efd96ff166f
-  data.tar.gz: bc1329532adab8dc61c47c43e558281cb9888f46
+  metadata.gz: 560a366131820b64816fde8d7599814a57f516f6
+  data.tar.gz: 9c31d2b9a3fdf7578f81a9bb9f113a5461f7d6d7
 SHA512:
-  metadata.gz: 32085b97c249625e064489d56f40c4839dce1e20af04bb8306afee7e4f468f34c132a6e5927700ae76929a572d0fa1aa392df129d637df0d2253b2da0e46476e
-  data.tar.gz: 939339e1fa59c3ebc7f52a6263e45a922cedf65cd6df2020ffe7460b677bd033ba1125b0cdc82201dbb428ea322f03260d59b3c4ec400a48966c74cd18cbe31d
+  metadata.gz: e88df3b36b2395d8ffb1c3cbbab940fe02ba2d297ee0142d26677c84b5f6e352468861e654828ee4ca7d0df8a4f92fcc8d68dffd5c3e6f04ad8f00318f1eb3dc
+  data.tar.gz: 53a411586c756abbada2ecafb03f39fd8d0f840d04d48d5f6ea510efb489865df6f3b0573fb1f7da19f9342aa7329c0d336eeedba13f3fdf6552802c239794fc

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+example_app/log
+example_app_with_newrelic_3_8/log

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Next Release
 
+## 2.0.0 (10/20/2014)
+
+* Work with newrelic_rpm 3.9
+
 ## 1.4.1 (07/04/2014)
 
 * Fix "uninitialized constant NewRelic::MetricSpec (NameError)" with

data/README.md

@@ -2,6 +2,9 @@
 
 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
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,7 +18,7 @@ And then execute:
 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
@@ -25,7 +28,7 @@ If you're using Rails, make sure that you've told rack to start the agent for Gr
     NewRelic::Agent.manual_start
 
     run YourApplication::Application
-    
+
 
 ## Usage
 

data/example_app/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'rack'
+gem 'grape'
+gem 'newrelic_rpm'
+gem 'newrelic-grape'
+
+group :test do
+  gem "rspec"
+  gem "rack-test", require: "rack/test"
+end

data/example_app/README.md

@@ -0,0 +1,29 @@
+Example App
+================
+
+A [Grape](http://github.com/intridea/grape) API mounted on Rack to demonstrate [newrelic-grape](https://github.com/xinminlabs/newrelic-grape).
+
+* [ping](api/ping.rb): a hello world example that returns a JSON document
+
+Run
+___
+
+```
+$bundle install
+$rackup
+```
+
+### Ping
+
+Navigate to http://localhost:9292/api/ping with a browser or use `curl`.
+
+```
+$ curl http://localhost:9292/api/ping
+
+{"ping":"pong"}
+```
+
+New Relic
+---------
+
+The application is setup with NewRelic w/ Developer Mode. Navigate to http://localhost:9292/newrelic after making some API calls.

data/example_app/api/ping.rb

@@ -0,0 +1,8 @@
+module Api
+  class Ping < Grape::API
+    format :json
+    get '/ping' do
+      { ping: 'pong' }
+    end
+  end
+end

data/example_app/app/api.rb

@@ -0,0 +1,8 @@
+module App
+  class Api < Grape::API
+    prefix 'api'
+    format :json
+
+    mount ::Api::Ping
+  end
+end

data/example_app/config/application.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'api'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'app'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'boot'
+
+Bundler.require :default, ENV['RACK_ENV']
+
+Dir[File.expand_path('../../api/*.rb', __FILE__)].each do |f|
+  require f
+end

data/example_app/config/boot.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'bundler/setup'

data/example_app/config/environment.rb

@@ -0,0 +1,3 @@
+ENV['RACK_ENV'] ||= 'test'
+
+require File.expand_path('../application', __FILE__)

data/example_app/config/newrelic.yml

@@ -0,0 +1,255 @@
+# Here are the settings that are common to all environments
+common: &default_settings
+  # ============================== LICENSE KEY ===============================
+
+  # You must specify the license key associated with your New Relic
+  # account.  This key binds your Agent's data to your account in the
+  # New Relic service.
+  license_key: '<%= ENV["NEW_RELIC_LICENSE_KEY"] %>'
+
+  # Agent Enabled (Rails Only)
+  # Use this setting to force the agent to run or not run.
+  # Default is 'auto' which means the agent will install and run only
+  # if a valid dispatcher such as Mongrel is running.  This prevents
+  # it from running with Rake or the console.  Set to false to
+  # completely turn the agent off regardless of the other settings.
+  # Valid values are true, false and auto.
+  #
+  # agent_enabled: auto
+
+  # Application Name Set this to be the name of your application as
+  # you'd like it show up in New Relic. The service will then auto-map
+  # instances of your application into an "application" on your
+  # dashboard page. If you want to map this instance into multiple
+  # apps, like "AJAX Requests" and "All UI" then specify a semicolon
+  # separated list of up to three distinct names, or a yaml list.
+  # Defaults to the capitalized RAILS_ENV or RACK_ENV (i.e.,
+  # Production, Staging, etc)
+  #
+  # Example:
+  #
+  #   app_name:
+  #       - Ajax Service
+  #       - All Services
+  #
+  app_name: <%= ENV["NEW_RELIC_APP_NAME"] || 'NewRelic::Grape Example Application' %>
+
+  # When "true", the agent collects performance data about your
+  # application and reports this data to the New Relic service at
+  # newrelic.com. This global switch is normally overridden for each
+  # environment below. (formerly called 'enabled')
+  monitor_mode: true
+
+  # Developer mode should be off in every environment but
+  # development as it has very high overhead in memory.
+  developer_mode: false
+
+  # The newrelic agent generates its own log file to keep its logging
+  # information separate from that of your application.  Specify its
+  # log level here.
+  log_level: info
+
+  # Optionally set the path to the log file This is expanded from the
+  # root directory (may be relative or absolute, e.g. 'log/' or
+  # '/var/log/') The agent will attempt to create this directory if it
+  # does not exist.
+  # log_file_path: 'log'
+
+  # Optionally set the name of the log file, defaults to 'newrelic_agent.log'
+  # log_file_name: 'newrelic_agent.log'
+
+  # The newrelic agent communicates with the service via http by
+  # default.  If you want to communicate via https to increase
+  # security, then turn on SSL by setting this value to true.  Note,
+  # this will result in increased CPU overhead to perform the
+  # encryption involved in SSL communication, but this work is done
+  # asynchronously to the threads that process your application code,
+  # so it should not impact response times.
+  ssl: false
+
+  # EXPERIMENTAL: enable verification of the SSL certificate sent by
+  # the server. This setting has no effect unless SSL is enabled
+  # above. This may block your application. Only enable it if the data
+  # you send us needs end-to-end verified certificates.
+  #
+  # This means we cannot cache the DNS lookup, so each request to the
+  # service will perform a lookup. It also means that we cannot
+  # use a non-blocking lookup, so in a worst case, if you have DNS
+  # problems, your app may block indefinitely.
+  # verify_certificate: true
+
+  # Set your application's Apdex threshold value with the 'apdex_t'
+  # setting, in seconds. The apdex_t value determines the buckets used
+  # to compute your overall Apdex score.
+  # Requests that take less than apdex_t seconds to process will be
+  # classified as Satisfying transactions; more than apdex_t seconds
+  # as Tolerating transactions; and more than four times the apdex_t
+  # value as Frustrating transactions.
+  # For more about the Apdex standard, see
+  # http://newrelic.com/docs/general/apdex
+
+  apdex_t: 0.5
+
+  #============================== Browser Monitoring ===============================
+  # New Relic Real User Monitoring gives you insight into the performance real users are
+  # experiencing with your website. This is accomplished by measuring the time it takes for
+  # your users' browsers to download and render your web pages by injecting a small amount
+  # of JavaScript code into the header and footer of each page.
+  browser_monitoring:
+      # By default the agent automatically injects the monitoring JavaScript
+      # into web pages. Set this attribute to false to turn off this behavior.
+      auto_instrument: true
+
+  # Proxy settings for connecting to the service.
+  #
+  # If a proxy is used, the host setting is required.  Other settings
+  # are optional.  Default port is 8080.
+  #
+  # proxy_host: hostname
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+
+  # Tells transaction tracer and error collector (when enabled)
+  # whether or not to capture HTTP params.  When true, frameworks can
+  # exclude HTTP parameters from being captured.
+  # Rails: the RoR filter_parameter_logging excludes parameters
+  # Java: create a config setting called "ignored_params" and set it to
+  #     a comma separated list of HTTP parameter names.
+  #     ex: ignored_params: credit_card, ssn, password
+  capture_params: true
+
+
+  # Transaction tracer captures deep information about slow
+  # transactions and sends this to the service once a
+  # minute. Included in the transaction is the exact call sequence of
+  # the transactions including any SQL statements issued.
+  transaction_tracer:
+
+    # Transaction tracer is enabled by default. Set this to false to
+    # turn it off. This feature is only available at the Professional
+    # and above product levels.
+    enabled: true
+
+    # Threshold in seconds for when to collect a transaction
+    # trace. When the response time of a controller action exceeds
+    # this threshold, a transaction trace will be recorded and sent to
+    # the service. Valid values are any float value, or (default)
+    # "apdex_f", which will use the threshold for an dissatisfying
+    # Apdex controller action - four times the Apdex T value.
+    transaction_threshold: apdex_f
+
+    # When transaction tracer is on, SQL statements can optionally be
+    # recorded. The recorder has three modes, "off" which sends no
+    # SQL, "raw" which sends the SQL statement in its original form,
+    # and "obfuscated", which strips out numeric and string literals
+    record_sql: obfuscated
+
+    # Threshold in seconds for when to collect stack trace for a SQL
+    # call. In other words, when SQL statements exceed this threshold,
+    # then capture and send the current stack trace. This is
+    # helpful for pinpointing where long SQL calls originate from
+    stack_trace_threshold: 0.500
+
+    # Determines whether the agent will capture query plans for slow
+    # SQL queries.  Only supported in mysql and postgres.  Should be
+    # set to false when using other adapters.
+    # explain_enabled: true
+
+    # Threshold for query execution time below which query plans will not
+    # not be captured.  Relevant only when `explain_enabled` is true.
+    # explain_threshold: 0.5
+
+  # Error collector captures information about uncaught exceptions and
+  # sends them to the service for viewing
+  error_collector:
+
+    # Error collector is enabled by default. Set this to false to turn
+    # it off. This feature is only available at the Professional and above
+    # product levels
+    enabled: true
+
+    # Rails Only - tells error collector whether or not to capture a
+    # source snippet around the place of the error when errors are View
+    # related.
+    capture_source: true
+
+    # To stop specific errors from reporting to New Relic, set this property
+    # to comma separated values.  Default is to ignore routing errors
+    # which are how 404's get triggered.
+    #
+    ignore_errors: ActionController::RoutingError
+
+  # (Advanced) Uncomment this to ensure the cpu and memory samplers
+  # won't run.  Useful when you are using the agent to monitor an
+  # external resource
+  # disable_samplers: true
+
+  # If you aren't interested in visibility in these areas, you can
+  # disable the instrumentation to reduce overhead.
+  #
+  # disable_view_instrumentation: true
+  # disable_activerecord_instrumentation: true
+  # disable_memcache_instrumentation: true
+  # disable_dj: true
+
+  # If you're interested in capturing memcache keys as though they
+  # were SQL uncomment this flag. Note that this does increase
+  # overhead slightly on every memcached call, and can have security
+  # implications if your memcached keys are sensitive
+  # capture_memcache_keys: true
+
+  # Certain types of instrumentation such as GC stats will not work if
+  # you are running multi-threaded.  Please let us know.
+  # multi_threaded = false
+
+# Application Environments
+# ------------------------------------------
+# Environment specific settings are in this section.
+# For Rails applications, RAILS_ENV is used to determine the environment
+# For Java applications, pass -Dnewrelic.environment <environment> to set
+# the environment
+
+# NOTE if your application has other named environments, you should
+# provide newrelic configuration settings for these environments here.
+
+development:
+  <<: *default_settings
+  # Turn off communication to New Relic service in development mode (also
+  # 'enabled').
+  # NOTE: for initial evaluation purposes, you may want to temporarily
+  # turn the agent on in development mode.
+  monitor_mode: false
+
+  # Rails Only - when running in Developer Mode, the New Relic Agent will
+  # present performance information on the last 100 transactions you have
+  # executed since starting the mongrel.
+  # NOTE: There is substantial overhead when running in developer mode.
+  # Do not use for production or load testing.
+  developer_mode: true
+
+  # Enable textmate links
+  # textmate: true
+
+test:
+  <<: *default_settings
+  # It almost never makes sense to turn on the agent when running
+  # unit, functional or integration tests or the like.
+  monitor_mode: false
+
+# Turn on the agent in production for 24x7 monitoring.  NewRelic
+# testing shows an average performance impact of < 5 ms per
+# transaction, you you can leave this on all the time without
+# incurring any user-visible performance degradation.
+production:
+  <<: *default_settings
+  monitor_mode: true
+
+# Many applications have a staging environment which behaves
+# identically to production.  Support for that environment is provided
+# here.  By default, the staging environment has the agent turned on.
+staging:
+  <<: *default_settings
+  monitor_mode: true
+  app_name: <%= ENV["NEW_RELIC_APP_NAME"] %> (Staging)

data/example_app/config.ru

@@ -0,0 +1,12 @@
+require File.expand_path('../config/environment', __FILE__)
+
+if ENV['RACK_ENV'] == 'development'
+  puts "Loading NewRelic in developer mode ..."
+  require 'new_relic/rack/developer_mode'
+  use NewRelic::Rack::DeveloperMode
+end
+
+NewRelic::Agent.manual_start
+
+require 'api'
+run App::Api

data/example_app/spec/api/ping_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Api::Ping do
+  include Rack::Test::Methods
+
+  def app
+    App::Api
+  end
+
+  it 'ping' do
+    get '/api/ping'
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq({ ping: 'pong' }.to_json)
+  end
+end

data/example_app/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ENV['RACK_ENV'] ||= 'test'
+require 'rack/test'
+require File.expand_path('../../config/environment', __FILE__)
+require 'api'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec
+  config.raise_errors_for_deprecations!
+end

data/example_app_with_newrelic_3_8/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'rack'
+gem 'grape'
+gem 'newrelic_rpm', '~> 3.8.0'
+gem 'newrelic-grape'
+
+group :test do
+  gem "rspec"
+  gem "rack-test", require: "rack/test"
+end

data/example_app_with_newrelic_3_8/README.md

@@ -0,0 +1,29 @@
+Example App
+================
+
+A [Grape](http://github.com/intridea/grape) API mounted on Rack to demonstrate [newrelic-grape](https://github.com/xinminlabs/newrelic-grape).
+
+* [ping](api/ping.rb): a hello world example that returns a JSON document
+
+Run
+___
+
+```
+$bundle install
+$rackup
+```
+
+### Ping
+
+Navigate to http://localhost:9292/api/ping with a browser or use `curl`.
+
+```
+$ curl http://localhost:9292/api/ping
+
+{"ping":"pong"}
+```
+
+New Relic
+---------
+
+The application is setup with NewRelic w/ Developer Mode. Navigate to http://localhost:9292/newrelic after making some API calls.

data/example_app_with_newrelic_3_8/api/ping.rb

@@ -0,0 +1,8 @@
+module Api
+  class Ping < Grape::API
+    format :json
+    get '/ping' do
+      { ping: 'pong' }
+    end
+  end
+end

data/example_app_with_newrelic_3_8/app/api.rb

@@ -0,0 +1,8 @@
+module App
+  class Api < Grape::API
+    prefix 'api'
+    format :json
+
+    mount ::Api::Ping
+  end
+end

data/example_app_with_newrelic_3_8/config/application.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'api'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'app'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'boot'
+
+Bundler.require :default, ENV['RACK_ENV']
+
+Dir[File.expand_path('../../api/*.rb', __FILE__)].each do |f|
+  require f
+end

data/example_app_with_newrelic_3_8/config/boot.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'bundler/setup'

data/example_app_with_newrelic_3_8/config/environment.rb

@@ -0,0 +1,3 @@
+ENV['RACK_ENV'] ||= 'test'
+
+require File.expand_path('../application', __FILE__)

data/example_app_with_newrelic_3_8/config/newrelic.yml

@@ -0,0 +1,255 @@
+# Here are the settings that are common to all environments
+common: &default_settings
+  # ============================== LICENSE KEY ===============================
+
+  # You must specify the license key associated with your New Relic
+  # account.  This key binds your Agent's data to your account in the
+  # New Relic service.
+  license_key: '<%= ENV["NEW_RELIC_LICENSE_KEY"] %>'
+
+  # Agent Enabled (Rails Only)
+  # Use this setting to force the agent to run or not run.
+  # Default is 'auto' which means the agent will install and run only
+  # if a valid dispatcher such as Mongrel is running.  This prevents
+  # it from running with Rake or the console.  Set to false to
+  # completely turn the agent off regardless of the other settings.
+  # Valid values are true, false and auto.
+  #
+  # agent_enabled: auto
+
+  # Application Name Set this to be the name of your application as
+  # you'd like it show up in New Relic. The service will then auto-map
+  # instances of your application into an "application" on your
+  # dashboard page. If you want to map this instance into multiple
+  # apps, like "AJAX Requests" and "All UI" then specify a semicolon
+  # separated list of up to three distinct names, or a yaml list.
+  # Defaults to the capitalized RAILS_ENV or RACK_ENV (i.e.,
+  # Production, Staging, etc)
+  #
+  # Example:
+  #
+  #   app_name:
+  #       - Ajax Service
+  #       - All Services
+  #
+  app_name: <%= ENV["NEW_RELIC_APP_NAME"] || 'NewRelic::Grape Example Application with NewRelic 3.8' %>
+
+  # When "true", the agent collects performance data about your
+  # application and reports this data to the New Relic service at
+  # newrelic.com. This global switch is normally overridden for each
+  # environment below. (formerly called 'enabled')
+  monitor_mode: true
+
+  # Developer mode should be off in every environment but
+  # development as it has very high overhead in memory.
+  developer_mode: false
+
+  # The newrelic agent generates its own log file to keep its logging
+  # information separate from that of your application.  Specify its
+  # log level here.
+  log_level: info
+
+  # Optionally set the path to the log file This is expanded from the
+  # root directory (may be relative or absolute, e.g. 'log/' or
+  # '/var/log/') The agent will attempt to create this directory if it
+  # does not exist.
+  # log_file_path: 'log'
+
+  # Optionally set the name of the log file, defaults to 'newrelic_agent.log'
+  # log_file_name: 'newrelic_agent.log'
+
+  # The newrelic agent communicates with the service via http by
+  # default.  If you want to communicate via https to increase
+  # security, then turn on SSL by setting this value to true.  Note,
+  # this will result in increased CPU overhead to perform the
+  # encryption involved in SSL communication, but this work is done
+  # asynchronously to the threads that process your application code,
+  # so it should not impact response times.
+  ssl: false
+
+  # EXPERIMENTAL: enable verification of the SSL certificate sent by
+  # the server. This setting has no effect unless SSL is enabled
+  # above. This may block your application. Only enable it if the data
+  # you send us needs end-to-end verified certificates.
+  #
+  # This means we cannot cache the DNS lookup, so each request to the
+  # service will perform a lookup. It also means that we cannot
+  # use a non-blocking lookup, so in a worst case, if you have DNS
+  # problems, your app may block indefinitely.
+  # verify_certificate: true
+
+  # Set your application's Apdex threshold value with the 'apdex_t'
+  # setting, in seconds. The apdex_t value determines the buckets used
+  # to compute your overall Apdex score.
+  # Requests that take less than apdex_t seconds to process will be
+  # classified as Satisfying transactions; more than apdex_t seconds
+  # as Tolerating transactions; and more than four times the apdex_t
+  # value as Frustrating transactions.
+  # For more about the Apdex standard, see
+  # http://newrelic.com/docs/general/apdex
+
+  apdex_t: 0.5
+
+  #============================== Browser Monitoring ===============================
+  # New Relic Real User Monitoring gives you insight into the performance real users are
+  # experiencing with your website. This is accomplished by measuring the time it takes for
+  # your users' browsers to download and render your web pages by injecting a small amount
+  # of JavaScript code into the header and footer of each page.
+  browser_monitoring:
+      # By default the agent automatically injects the monitoring JavaScript
+      # into web pages. Set this attribute to false to turn off this behavior.
+      auto_instrument: true
+
+  # Proxy settings for connecting to the service.
+  #
+  # If a proxy is used, the host setting is required.  Other settings
+  # are optional.  Default port is 8080.
+  #
+  # proxy_host: hostname
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+
+  # Tells transaction tracer and error collector (when enabled)
+  # whether or not to capture HTTP params.  When true, frameworks can
+  # exclude HTTP parameters from being captured.
+  # Rails: the RoR filter_parameter_logging excludes parameters
+  # Java: create a config setting called "ignored_params" and set it to
+  #     a comma separated list of HTTP parameter names.
+  #     ex: ignored_params: credit_card, ssn, password
+  capture_params: true
+
+
+  # Transaction tracer captures deep information about slow
+  # transactions and sends this to the service once a
+  # minute. Included in the transaction is the exact call sequence of
+  # the transactions including any SQL statements issued.
+  transaction_tracer:
+
+    # Transaction tracer is enabled by default. Set this to false to
+    # turn it off. This feature is only available at the Professional
+    # and above product levels.
+    enabled: true
+
+    # Threshold in seconds for when to collect a transaction
+    # trace. When the response time of a controller action exceeds
+    # this threshold, a transaction trace will be recorded and sent to
+    # the service. Valid values are any float value, or (default)
+    # "apdex_f", which will use the threshold for an dissatisfying
+    # Apdex controller action - four times the Apdex T value.
+    transaction_threshold: apdex_f
+
+    # When transaction tracer is on, SQL statements can optionally be
+    # recorded. The recorder has three modes, "off" which sends no
+    # SQL, "raw" which sends the SQL statement in its original form,
+    # and "obfuscated", which strips out numeric and string literals
+    record_sql: obfuscated
+
+    # Threshold in seconds for when to collect stack trace for a SQL
+    # call. In other words, when SQL statements exceed this threshold,
+    # then capture and send the current stack trace. This is
+    # helpful for pinpointing where long SQL calls originate from
+    stack_trace_threshold: 0.500
+
+    # Determines whether the agent will capture query plans for slow
+    # SQL queries.  Only supported in mysql and postgres.  Should be
+    # set to false when using other adapters.
+    # explain_enabled: true
+
+    # Threshold for query execution time below which query plans will not
+    # not be captured.  Relevant only when `explain_enabled` is true.
+    # explain_threshold: 0.5
+
+  # Error collector captures information about uncaught exceptions and
+  # sends them to the service for viewing
+  error_collector:
+
+    # Error collector is enabled by default. Set this to false to turn
+    # it off. This feature is only available at the Professional and above
+    # product levels
+    enabled: true
+
+    # Rails Only - tells error collector whether or not to capture a
+    # source snippet around the place of the error when errors are View
+    # related.
+    capture_source: true
+
+    # To stop specific errors from reporting to New Relic, set this property
+    # to comma separated values.  Default is to ignore routing errors
+    # which are how 404's get triggered.
+    #
+    ignore_errors: ActionController::RoutingError
+
+  # (Advanced) Uncomment this to ensure the cpu and memory samplers
+  # won't run.  Useful when you are using the agent to monitor an
+  # external resource
+  # disable_samplers: true
+
+  # If you aren't interested in visibility in these areas, you can
+  # disable the instrumentation to reduce overhead.
+  #
+  # disable_view_instrumentation: true
+  # disable_activerecord_instrumentation: true
+  # disable_memcache_instrumentation: true
+  # disable_dj: true
+
+  # If you're interested in capturing memcache keys as though they
+  # were SQL uncomment this flag. Note that this does increase
+  # overhead slightly on every memcached call, and can have security
+  # implications if your memcached keys are sensitive
+  # capture_memcache_keys: true
+
+  # Certain types of instrumentation such as GC stats will not work if
+  # you are running multi-threaded.  Please let us know.
+  # multi_threaded = false
+
+# Application Environments
+# ------------------------------------------
+# Environment specific settings are in this section.
+# For Rails applications, RAILS_ENV is used to determine the environment
+# For Java applications, pass -Dnewrelic.environment <environment> to set
+# the environment
+
+# NOTE if your application has other named environments, you should
+# provide newrelic configuration settings for these environments here.
+
+development:
+  <<: *default_settings
+  # Turn off communication to New Relic service in development mode (also
+  # 'enabled').
+  # NOTE: for initial evaluation purposes, you may want to temporarily
+  # turn the agent on in development mode.
+  monitor_mode: false
+
+  # Rails Only - when running in Developer Mode, the New Relic Agent will
+  # present performance information on the last 100 transactions you have
+  # executed since starting the mongrel.
+  # NOTE: There is substantial overhead when running in developer mode.
+  # Do not use for production or load testing.
+  developer_mode: true
+
+  # Enable textmate links
+  # textmate: true
+
+test:
+  <<: *default_settings
+  # It almost never makes sense to turn on the agent when running
+  # unit, functional or integration tests or the like.
+  monitor_mode: false
+
+# Turn on the agent in production for 24x7 monitoring.  NewRelic
+# testing shows an average performance impact of < 5 ms per
+# transaction, you you can leave this on all the time without
+# incurring any user-visible performance degradation.
+production:
+  <<: *default_settings
+  monitor_mode: true
+
+# Many applications have a staging environment which behaves
+# identically to production.  Support for that environment is provided
+# here.  By default, the staging environment has the agent turned on.
+staging:
+  <<: *default_settings
+  monitor_mode: true
+  app_name: <%= ENV["NEW_RELIC_APP_NAME"] %> (Staging)

data/example_app_with_newrelic_3_8/config.ru

@@ -0,0 +1,12 @@
+require File.expand_path('../config/environment', __FILE__)
+
+if ENV['RACK_ENV'] == 'development'
+  puts "Loading NewRelic in developer mode ..."
+  require 'new_relic/rack/developer_mode'
+  use NewRelic::Rack::DeveloperMode
+end
+
+NewRelic::Agent.manual_start
+
+require 'api'
+run App::Api

data/example_app_with_newrelic_3_8/spec/api/ping_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Api::Ping do
+  include Rack::Test::Methods
+
+  def app
+    App::Api
+  end
+
+  it 'ping' do
+    get '/api/ping'
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq({ ping: 'pong' }.to_json)
+  end
+end

data/example_app_with_newrelic_3_8/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ENV['RACK_ENV'] ||= 'test'
+require 'rack/test'
+require File.expand_path('../../config/environment', __FILE__)
+require 'api'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec
+  config.raise_errors_for_deprecations!
+end

data/lib/newrelic-grape/instrument.rb

@@ -54,14 +54,23 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::Rack::Builder.class_eval do
-      alias_method :origin_use, :use
+    NewRelic::Agent::Instrumentation::MiddlewareProxy.class_eval do
+      def self.needs_wrapping?(target)
+        (
+          !target.respond_to?(:_nr_has_middleware_tracing) &&
+          !is_sinatra_app?(target) &&
+          !target.is_a?(Proc)
+        )
+      end
+    end
 
-      def use(middleware, *args, &block)
-        if middleware == Grape::Middleware::Error
-          use ::NewRelic::Agent::Instrumentation::Grape
-        end
-        origin_use(middleware, *args, &block)
+    ::Grape::Endpoint.class_eval do
+      alias_method :origin_build_middleware, :build_middleware
+
+      def build_middleware
+        b = origin_build_middleware
+        b.use ::NewRelic::Agent::Instrumentation::Grape
+        b
       end
     end
   end

data/lib/newrelic-grape/version.rb

@@ -1,5 +1,5 @@
 module NewRelic
   module Grape
-    VERSION = "1.4.1"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newrelic-grape
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-04 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -53,6 +53,28 @@ files:
 - README.md
 - Rakefile
 - config/newrelic.yml
+- example_app/Gemfile
+- example_app/README.md
+- example_app/api/ping.rb
+- example_app/app/api.rb
+- example_app/config.ru
+- example_app/config/application.rb
+- example_app/config/boot.rb
+- example_app/config/environment.rb
+- example_app/config/newrelic.yml
+- example_app/spec/api/ping_spec.rb
+- example_app/spec/spec_helper.rb
+- example_app_with_newrelic_3_8/Gemfile
+- example_app_with_newrelic_3_8/README.md
+- example_app_with_newrelic_3_8/api/ping.rb
+- example_app_with_newrelic_3_8/app/api.rb
+- example_app_with_newrelic_3_8/config.ru
+- example_app_with_newrelic_3_8/config/application.rb
+- example_app_with_newrelic_3_8/config/boot.rb
+- example_app_with_newrelic_3_8/config/environment.rb
+- example_app_with_newrelic_3_8/config/newrelic.yml
+- example_app_with_newrelic_3_8/spec/api/ping_spec.rb
+- example_app_with_newrelic_3_8/spec/spec_helper.rb
 - lib/newrelic-grape.rb
 - lib/newrelic-grape/instrument.rb
 - lib/newrelic-grape/version.rb