newrelic-roda 1.0.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70df10cc3370b5695723b860f740ac300bec405d
+  data.tar.gz: 8ff5be219b8d753532b2b8658e236dbb8d26fe75
+SHA512:
+  metadata.gz: 99481f106dc1d50fdfed9030b7048d690e5243b4dbc035e5e45e91ce1470b517fc9bbb2564d7e6d66ab064c37532e4488d9473099a6939ff6da9dfaf9ea5635c
+  data.tar.gz: cfb1e8949933b90185a6fcd25345674b63bfd55fcc3f6c4883f4502eec276ccf7fd54db6b299f09af4a4c3ae61c7da084368900b7cd63bf6dffc20263d04adb5

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+example_app/log
+example_app_with_newrelic_3_8/log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Next Release
+
+## 1.0.0 (12/18/2012)
+
+* Initial public release - [mikz](https://github.com/mikz)
+* Forked from [newrelic-grape](https://github.com/flyerhzm/newrelic-grape)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newrelic-roda.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 10.0"
+  gem "bundler", "~> 1.0"
+  gem "rspec", "~> 2.6"
+  gem "rack-test", "~> 0.6.2"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Richard Huang, Michal Cichra
+
+MIT License
+
+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,70 @@
+# NewRelic::Roda
+
+NewRelic instrumentation for the [Roda][0], forked from [newrelic-grape][1].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'newrelic-roda'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newrelic-roda
+
+If you're using Rails, make sure that you've told rack to start the agent for Roda:
+
+    # 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-roda` gem. That's it.
+
+## Disabling Instrumentation
+
+Set `disable_roda` in `newrelic.yml` or `ENV['DISABLE_NEW_RELIC_RODA']` 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::Roda` when calling your API.
+
+### RSpec
+
+``` ruby
+describe NewRelic::Agent::Instrumentation::Roda do
+  it "traces" do
+    NewRelic::Agent::Instrumentation::Roda
+      .any_instance
+      .should_receive(:perform_action_with_newrelic_trace)
+      .and_yield
+    get "/ping"
+    response.status.should == 200
+  end
+end
+```
+
+## 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/jeremyevans/roda
+[1]: https://github.com/flyerhzm/newrelic-grape
+[2]: https://newrelic.com/docs/ruby/developer-mode

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/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"] %>
+
+  # 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: <%= !!ENV['NEW_RELIC_ID'] %>
+  
+  # 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/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'rack'
+gem 'roda'
+gem 'newrelic_rpm', '~> 3.9.0'
+gem 'newrelic-roda', path: '..'
+
+gem 'pry'
+group :test do
+  gem "rspec"
+  gem "rack-test", require: "rack/test"
+end

data/example_app/README.md

@@ -0,0 +1,29 @@
+Example App
+================
+
+A [Roda](http://github.com/jeremyevans/roda) API mounted on Rack to demonstrate [newrelic-roda](https://github.com/mikz/newrelic-roda).
+
+* [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,30 @@
+module Api
+  class Ping < Roda
+    route do |r|
+      r.on 'ping' do
+        r.get do
+          '{"ping":"pong"}'
+        end
+      end
+
+      r.on 'nested/:multi/:stuff' do |multi, stuff|
+        { multi => stuff }.to_json
+      end
+
+      r.on ':param' do |param|
+        sleep(0.2)
+        puts 'slept 0.2'
+        r.on ':other' do |other|
+          sleep(0.3)
+          puts 'slept 0.3'
+          r.get do
+            sleep(0.4)
+            puts 'slept 0.4'
+            { param => other }.to_s
+          end
+        end
+      end
+
+    end
+  end
+end

data/example_app/app/api.rb

@@ -0,0 +1,26 @@
+#$trace = TracePoint.new(:call) do |tp|
+#  params = tp.defined_class.instance_method(tp.method_id).parameters
+#  arguments = params.map do |(_type, name)|
+#    [name, tp.binding.local_variable_get(name)]
+#  end
+#  p [tp.defined_class, tp.method_id, tp.event, arguments]
+#end
+
+module App
+  class Api < Roda
+
+    route do |r|
+      # $enabled ||= ($trace.enable; true)
+
+      r.root do
+        'root route'
+      end
+
+      r.on 'api' do
+        sleep(0.1)
+        puts 'slept 0.1'
+        r.run ::Api::Ping
+      end
+    end
+  end
+end

data/example_app/config.ru

@@ -0,0 +1,14 @@
+require File.expand_path('../config/environment', __FILE__)
+
+if defined?(NewRelic)
+  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
+end
+
+require 'api'
+run App::Api

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::Roda 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: debug
+
+  # 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/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/lib/newrelic-roda.rb

@@ -0,0 +1,2 @@
+require "newrelic-roda/version"
+require "newrelic-roda/instrument"

data/lib/newrelic-roda/instrument.rb

@@ -0,0 +1,107 @@
+require 'new_relic/agent/instrumentation'
+require 'new_relic/agent/instrumentation/controller_instrumentation'
+require 'new_relic/agent/instrumentation/sinatra/transaction_namer'
+
+require 'roda'
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      module Roda
+        TransactionNamer = NewRelic::Agent::Instrumentation::Sinatra::TransactionNamer
+
+        module RequestMethods
+          include ::NewRelic::Agent::MethodTracer
+          add_method_tracer :match_all
+
+          private
+
+          def if_match(args, &block)
+            instrumented = proc do |*captures|
+              params = { env.fetch('new_relic.roda').last => captures }
+              @scope.perform_action_with_newrelic_trace(category: :controller, params: params) do
+                yield(*captures)
+              end
+            end
+            super(args, &instrumented)
+          end
+
+          def match_all(args)
+            if all = super
+              (env['new_relic.roda'] ||= [nil]) << args
+            end
+            all
+          end
+
+          def block_result(result)
+            begin
+              txn_name = _route_name
+              unless txn_name.nil?
+                ::NewRelic::Agent::Transaction.set_default_transaction_name(
+                    "#{self.class.name}/#{txn_name}", :category => :sinatra)
+              end
+            rescue => e
+              ::NewRelic::Agent.logger.debug("Failed during route_eval to set transaction name", e)
+            end
+
+            super
+          end
+
+          def _route_name
+            "#{request_method} #{env.fetch('new_relic.roda',['/']).join('/')}"
+          end
+        end
+
+        module InstanceMethods
+          def self.included(base)
+            base.include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
+          end
+
+          def call(env, &block)
+            super
+          rescue => error
+            ::NewRelic::Agent.notice_error(error)
+            raise error
+          end
+
+          def _route(&block)
+            perform_action_with_newrelic_trace(:category => :controller,
+                                               :params => @_request.params) do
+              super
+            end
+          end
+
+        end
+      end
+    end
+  end
+end
+
+DependencyDetection.defer do
+  @name = :roda
+
+  depends_on do
+    defined?(::Roda) && ! ::NewRelic::Control.instance['disable_roda'] && ! ENV['DISABLE_NEW_RELIC_RODA']
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing Roda instrumentation'
+    Roda::RodaPlugins.register_plugin(:new_relic, NewRelic::Agent::Instrumentation::Roda)
+    Roda.plugin(:new_relic)
+  end
+
+  executes do
+  end
+
+  executes do
+    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
+  end
+end

data/lib/newrelic-roda/version.rb

@@ -0,0 +1,5 @@
+module NewRelic
+  module Roda
+    VERSION = '1.0.0.pre1'
+  end
+end

data/newrelic-grape.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'newrelic-roda/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'newrelic-roda'
+  gem.version       = NewRelic::Roda::VERSION
+  gem.authors       = ['Michal Cichra', "Richard Huang"]
+  gem.email         = ['m@o2h.cz', "flyerhzm@gmail.com"]
+  gem.description   = %q{newrelic instrument for roda}
+  gem.summary       = %q{newrelic instrument for roda}
+  gem.homepage      = 'https://github.com/mikz/newrelic-roda'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'roda'
+  gem.add_runtime_dependency 'newrelic_rpm'
+end

data/spec/newrelic-roda/instrumenter_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe NewRelic::Agent::Instrumentation::Roda do
+
+  subject(:app) { Class.new(Roda) }
+
+  def route(&block)
+    app.route(&block)
+  end
+
+  context 'root' do
+    before do
+      route do |r|
+        r.root do
+          'Root!'
+        end
+      end
+    end
+
+    it 'perform_action_with_newrelic_trace' do
+      #NewRelic::Agent::Instrumentation::Roda.any_instance
+      #  .should_receive(:perform_action_with_newrelic_trace)
+      #  .with(hash_including(path: 'GET hello'))
+      #  .and_yield
+
+      get '/'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'Root!'
+    end
+  end
+
+  context 'nested routes' do
+    before do
+      route do |r|
+        r.on 'hello' do
+          r.is do
+            r.get do
+              'Hello!'
+            end
+          end
+        end
+      end
+    end
+
+    context 'in path' do
+      it 'perform_action_with_newrelic_trace' do
+        #NewRelic::Agent::Instrumentation::Roda.any_instance
+        #  .should_receive(:perform_action_with_newrelic_trace)
+        #  .with(hash_including(path: 'GET v1-hello'))
+        #  .and_yield
+
+        get '/hello'
+
+        expect(last_response.status).to eq 200
+        expect(last_response.body).to eq 'Hello!'
+      end
+    end
+  end
+
+end

data/spec/newrelic-roda/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe NewRelic::Roda do
+  it "has a version" do
+    NewRelic::Roda::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rack/test'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.before do
+    DependencyDetection.detect!
+  end
+end
+
+require 'roda'
+require 'newrelic_rpm'
+require 'newrelic-roda'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: newrelic-roda
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre1
+platform: ruby
+authors:
+- Michal Cichra
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: newrelic instrument for roda
+email:
+- m@o2h.cz
+- flyerhzm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- 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
+- lib/newrelic-roda.rb
+- lib/newrelic-roda/instrument.rb
+- lib/newrelic-roda/version.rb
+- newrelic-grape.gemspec
+- spec/newrelic-roda/instrumenter_spec.rb
+- spec/newrelic-roda/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mikz/newrelic-roda
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: newrelic instrument for roda
+test_files:
+- spec/newrelic-roda/instrumenter_spec.rb
+- spec/newrelic-roda/version_spec.rb
+- spec/spec_helper.rb