ghazel-newrelic_rpm 3.4.0.2 → 3.5.4

data/.gitignore

@@ -0,0 +1,21 @@
+Gemfile.lock
+newrelic_rpm.gemspec
+.DS\_Store
+.svn/
+*~
+*.rbc
+pkg/
+*.gem
+!rails
+Manifest*
+.idea/
+tmp/
+TAGS
+tags
+*.swp
+*.swo
+
+/log/
+/lerg/
+gems/newrelic_rpm.gemspec
+gems/newrelic_rpm*.tar.gz

data/.project

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>New Relic Agent</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.rubypeople.rdt.core.rubybuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+		<nature>org.rubypeople.rdt.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - jruby-18mode
+

data/CHANGELOG

@@ -1,6 +1,185 @@
+
+# New Relic Ruby Agent Release Notes #
+
+## v3.5.3 ##
+
+  * Update the collector protocol to use JSON and Ruby primitives
+
+    The communication between the agent and the NewRelic will not longer be
+    marshalled Ruby objects, but rather JSON in the case of Ruby 1.9 and marshalled
+    Ruby primitives in the case of 1.8.  This results in greater harvest efficiency
+    as well as feature parity with other New Relic agents.
+
+  * Fix incorrect application of conditions in sinatra instrumentation
+
+    The agent's sinatra instrumentation was causing sinatra's condidtions to
+    be incorrectly applied in some obscure cases.  The bug was triggered
+    when a condition was present on a lower priority route that would match
+    the current request, except for the precense of a higher priority route.
+
+## v3.5.2 ##
+
+ * Simplified process of running agent test suite and documented code
+   contribution process in GUIDELINES_FOR_CONTRIBUTING.
+
+## v3.5.1 ##
+
+ * Enabling Memory Profiling on Lion and Mountain Lion
+
+   The agent's list of supported platforms for memory profiling wasn't correctly checking
+   for more recent versions of OS X.
+
+ * Fixed an arity issue encountered when calling newrelic_notice_error from Rails applications.
+
+ * End user queue time was not being properly reported, works properly now.
+
+ * Server-side configuration for ignoring errors was not being heeded by agent.
+
+ * Better handling of a thread safety issue.
+
+   Some issues may remain, which we are working to address, but they should be gracefully handled
+   now, rather than crashing the running app.
+
+ * Use "java_import" rather than "include_class" when require Java Jars into a JRuby app.
+
+   Thanks to Jan Habermann for the pull request
+
+ * Replaced alias_method mechanism with super call in DataMapper instrumentation.
+
+   Thanks to Michael Rykov for the pull request
+
+ * Fixed the Rubinius GC profiler.
+
+   Thanks to Dirkjan Bussink
+
+ * Use ActiveSupport.on_load to load controller instrumentation Rails 3.
+
+   Thanks to Jonathan del Strother
+
+ * Reduce the number of thread local reference in a particular high traffic method
+
+   Thanks to Jeremy Kemper
+
+## v3.5.0.1 ##
+
+ * (Fix) Due to a serious resource leak we have ended support for versions of Phusion Passenger
+   older than 2.1.1. Users of older versions are encouraged upgrade to a more recent version.
+
+## v3.5.0 ##
+
+ * (Fix) RUM Stops Working After 3.4.2.1 Agent Upgrade
+
+   v3.4.2.1 introduced a bug that caused the browser monitor auto instrumentation
+   (for RUM) default to be false. The correct value of true is now used
+
+ * When the Ruby Agent detects Unicorn as the dispatcher it creates an INFO level log message
+   with additional information
+
+   To help customers using Unicorn, if the agent detects it (Unicorn) is being used as the
+   dispatcher an INFO level log message it created that includes a link to New Relic
+   online doc that has additional steps that may be required to get performance data reporting.
+
+ * (Fix) In version 3.4.2 of the Ruby Agent the server side value for Apdex T was disgregarded
+
+   With version 3.4.2 of the agent, the value set in the newrelic.yml file took precedence over the
+   value set in the New Relic UI.  As of version 3.5.0 only the value for Apdex T set in the
+   New Relic UI will be used. Any setting in the yaml file will be ignored.
+
+ * Improved Error Detection/Reporting capabilities for Rails 3 apps
+
+   Some errors are missed by the agent's exception reporting handlers because they are
+   generated in the rails stack, outside of the instrumented controller action. A Rack
+   middleware is now included that can detect these errors as they bubble out of the middleware stack.
+   Note that this does not include Routing Errors.
+
+ * The Ruby Agent now logs certain information it receives from the New Relic servers
+
+   After connecting to the New Relic servers the agent logs the New Relic URL
+   of the app it is reporting to.
+
+ * GC profiling overhead for Ruby 1.9 reduced
+
+   For Ruby 1.9 the amount of time spent in GC profiling has been reduced.
+
+ * Know issue with Ruby 1.8.7-p334, sqlite3-ruby 1.3.0 or older, and resque 1.23.0
+
+   The Ruby Agent will not work in conjunction with Ruby 1.8.7-p334, sqlite3-ruby 1.3.3
+   or earlier, and resque 1.23.0. Your app will likely stop functioning. This is a known problem
+   with Ruby versions up to 1.8.7-p334. Upgrading to the last release of Ruby 1.8.7
+   is recommended.  This issue has been present in every version of the agent we've tested
+   going back for a year.
+
+
+### previous versions ###
+## v3.4.2.1 ##
+
+* Fix issue when app_name is nil
+
+  If the app_name setting ends up being nil an exception got generated and the application
+  wouldn't run. This would notably occur when running a Heroku app locally without the
+  NEW_RELIC_APP_NAME environment variable set. A nil app_name is now detected and an
+  error logged specifying remediation.
+
+## v3.4.2 ##
+
+ * The RUM NRAGENT tk value gets more robustly sanitized to prevent potential XSS vulnerabilities
+
+   The code that scrubes the token used in Real User Monitoring has been enhanced to be
+   more robust.
+
+ * Support for Apdex T in server side configuration
+
+   For those using server side configuration the Ruby Agent now supports setting
+   the Apdex T value via the New Relic UI.
+
+ * Refactoring of agent config code
+
+   The code that reads the configuration information and confirgures the agent
+   got substantially reorganized, consolidated, simplified, and made more robust.
+
+## v3.4.1 ##
+#### Bug Fixes ####
+ * Fix edge case in RUM auto instrumentation where X-UA-Compatible meta tag is
+   present but </head> tag is missing.
+
+   There is a somewhat obscure edge case where RUM auto instrumentation will
+   crash a request. The issue seems to be triggered when the X-UA-Compatible
+   meta tag is present and the </head> tag is missing.
+
+ * Fixed reference to @service.request_timeout to @request_timeout in
+   new_relic_service.rb. (Thanks to Matthew Savage)
+
+   When a timeout occurred during connection to the collector an "undefined
+   method `request_timeout' for nil:NilClass'" would get raised.
+
+ * preserve visibility on traced methods.
+
+   Aliased methods now have the same visibility as the original traced method.
+   A couple of the esoteric methods created in the process weren't getting the
+   visibility  set properly.
+
+ * Agent service does not connect to directed shard collector after connecting
+   to proxy
+
+   After connecting to collector proxy name of real collector was updated, but
+   ip address was not being updated causing connections to go to the proxy.
+   Agent now looks up ip address for real collector.
+
+ * corrupt marshal data from pipe children crashing agent
+
+   If the agent receieved corrupted data from the Reqsue worker child agent
+   it could crash the agent itself. fixed.
+
+ * should reset RubyBench GC counter between polls
+
+   On Ruby REE, the GC profiler does not reset the counter between polls. This
+   is only a problem if GC could happen *between* transactions, as in, for
+   example, out-of-band GC in Unicorn. fixed.
+
 v3.4.0.1
  * Prevent the agent from resolving the collector address when disabled.
  * Fix for error collector configuration that was introduced during beta.
+ * Preserve method visibility when methods are traced with #add_method_tracer and #add_transaction_tracer
 
 v3.4.0
  * Major refactor of data transmission mechanism.  This enabled child processes to send data to parent processes, which then send the data to the New Relic service.  This should only affect Resque users, dramatically improving their experience.
@@ -282,7 +461,7 @@ v2.10.1.
   * add 'multi_threaded' config option to indicate when the app is running
     multi-threaded, so we can disable some instrumentation
   * fix test failures in JRuby, REE
-  * improve Net::HTTP instrumentation so its more efficient and distinguishes calls
+  * improve Net::HTTP instrumentation so it's more efficient and distinguishes calls
     between web and non-web transactions.
   * database instrumentation notices all database commands in addition to the core commands
   * add support for textmate to dev mode

data/GUIDELINES_FOR_CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Guidelines for Contributing Code
+
+At New Relic we welcome community code contributions to the Ruby Agent, and have
+taken effort to make this process easy for both contributors and our development
+team.
+
+When contributing keep in mind that the agent runs in a wide variety of ruby
+language implementations (e.g. 1.8.6, 1.8.7, 1.9.x, jruby, etc.) as well as a
+wide variety of application environments (e.g. rails, sinatra, roll-your-own,
+etc., etc.)
+
+Because of this we need to be more defensive in our coding practices than most
+projects.  Syntax must be compatible with all supported ruby implementations
+(e.g. no 1.9 specific hash syntax) and we can't assume the presence of any
+specific libraries such as `ActiveSupport`.
+
+## Testing
+
+The agent includes a suite of unit and functional tests which should be used to
+verify your changes don't break existing functionality.
+
+Unit tests are stored in the `test/new_relic` directory.
+
+Functional tests are stored in the `test/multiverse` directory.
+
+### Running Tests
+
+Running the test suite is simple.  Just invoke:
+
+    bundle
+    bundle exec rake
+
+This will run the unit tests in standalone mode, bootstrapping a basic Rails
+3.2 environment for the agent to instrument then executing the test suite.
+
+These tests are setup to run automatically in
+[travis-ci](https://travis-ci.org/newrelic/rpm) under several Ruby implementations.
+When you've pushed your changes to github you can confirm that the travis-ci
+build passes for your fork of the codebase.
+
+Additionally, our own CI jobs runs these tests under multiple versions of Rails to
+verify compatibility.
+
+### Writing Tests
+
+For most contributions it is strongly recommended to add additional tests which
+exercise your changes.
+
+This helps us efficiently incorporate your changes into our mainline codebase
+and provides a safeguard that your change won't be broken by future development.
+
+There are some rare cases where code changes do not result in changed
+functionality (e.g. a performance optimization) and new tests are not required.
+In general, including tests with your pull request dramatically increases the
+chances it will be accepted.
+
+### Functional Testing
+
+For cases where the unit test environment is not sufficient for testing a
+change (e.g. instrumentation for a non-rails framework, not available in the
+unit test environment), we have a functional testing suite called multiverse.
+These tests can be run by invoking:
+
+    bundle
+    bundle exec rake test:multiverse
+
+### And Finally...
+
+You are welcome to send pull requests to us - however, by doing so you agree
+that you are granting New Relic a non-exclusive, non-revokable, no-cost license
+to use the code, algorithms, patents, and ideas in that code in our products if
+we so choose. You also agree the code is provided as-is and you provide no
+warranties as to its fitness or correctness for any purpose.

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+group :development do
+  # require 0.9.2.2.
+  # There's problems with the test task in rake 10
+  # https://github.com/jimweirich/rake/issues/144
+  gem 'rake', '0.9.2.2'
+  gem 'mocha', '~>0.12.0'
+  gem 'shoulda', '~>3.0.1'
+  gem 'sdoc-helpers'
+  gem 'rdoc', '>= 2.4.2'
+  gem 'rails', '~>3.2.0'
+  gem 'sqlite3', :platform => 'mri'
+  gem 'activerecord-jdbcsqlite3-adapter', :platform => 'jruby'
+  gem 'jruby-openssl', :platform => 'jruby'
+end

data/InstallationNotes.md

@@ -0,0 +1,15 @@
+
+PLEASE NOTE:
+
+Developer Mode is now a Rack middleware.
+
+Developer Mode is no longer available in Rails 2.1 and earlier.
+However, starting in version 2.12 you can use Developer Mode in any
+Rack based framework, in addition to Rails.  To install developer mode
+in a non-Rails application, just add NewRelic::Rack::DeveloperMode to
+your middleware stack.
+
+If you are using JRuby, we recommend using at least version 1.4 or 
+later because of issues with the implementation of the timeout library.
+
+Refer to the README.md file for more information.

data/LICENSE

@@ -25,7 +25,7 @@ See https://github.com/jquery/jquery/blob/master/MIT-LICENSE.txt
 
 
 All other components of this product are
-Copyright (c) 2008-2011 New Relic, Inc.  All rights reserved.
+Copyright (c) 2008-2012 New Relic, Inc.  All rights reserved.
 
 Certain inventions disclosed in this file may be claimed within
 patents owned or patent applications filed by New Relic, Inc. or third

data/{README.rdoc → README.md}

@@ -1,30 +1,30 @@
-= New Relic Ruby Agent
+# New Relic Ruby Agent
 
 New Relic is a performance management system, developed by
 New Relic, Inc (http://www.newrelic.com).  It provides you with deep
 information about the performance of your Rails or Ruby
 application as it runs in production. The New Relic Ruby Agent is
 dual-purposed as a either a Rails plugin or a Gem, hosted on
-github[http://github.com/newrelic/rpm/tree/master].
+[github](http://github.com/newrelic/rpm/tree/master).
 
 The New Relic Ruby Agent runs in one of two modes:
 
-==== Production Mode
+#### Production Mode
 
 Low overhead instrumentation that captures detailed information on
 your application running in production and transmits them to
 newrelic.com where you can monitor them in real time.
 
-==== Developer Mode
+#### Developer Mode
 
-A Rack middleware that maps /newrelic to an application for showing
+A Rack middleware that maps `/newrelic` to an application for showing
 detailed performance metrics on a page by page basis.  Installed
 automatically in Rails applications.
 
-== Supported Environments
+## Supported Environments
 
-* Ruby 1.8.7, 1.9.1, or 1.9.2, including REE
-* JRuby 1.4 or higher
+* Ruby 1.8.6, 1.8.7, REE, 1.9.x
+* JRuby 1.6 and 1.7
 * Rails 2.0 or later for Production Mode
 * Rails 2.3 or later for Developer Mode
 * Sinatra
@@ -37,27 +37,42 @@ desired.  Report any problems to support@newrelic.com.
 You can also monitor non-web applications. Refer to the "Other
 Environments" section under "Getting Started".
 
-= Getting Started
+## Contributing Code
 
-Install the Ruby Agent as a gem.  If you are using Rails you can
-install the gem as a plug-in--details below.
+We welcome code contributions (in the form of pull requests) from our user
+community.  Before submitting a pull request please review
+[GUIDELINES_FOR_CONTRIBUTING](https://github.com/newrelic/rpm/blob/master/GUIDELINES_FOR_CONTRIBUTING.md).
 
-   gem install newrelic_rpm
+Following these helps us efficiently review and incorporate your contribution
+and avoid breaking your code with future changes to the agent.
+
+
+## Getting Started
+
+Install the Ruby Agent as a gem.
+
+    gem install newrelic_rpm
+
+Or add it to your project's Gemfile.
+
+    gem 'newrelic_rpm'
 
 To monitor your applications in production, create an account at
 http://newrelic.com/ .  There you can
 sign up for a free Lite account or one of our paid subscriptions.
 
 Once you receive the welcome e-mail with a license key and
-+newrelic.yml+ file, copy the +newrelic.yml+ file into your app config
+`newrelic.yml` file, copy the `newrelic.yml` file into your app config
 directory.
 
-All agent configuration is done in the +newrelic.yml+ file.  This file
-is by default read from the +config+ directory of the application root
+The initial configuration is done in the `newrelic.yml` file.  This file
+is by default read from the `config` directory of the application root
 and is subsequently searched for in the application root directory,
-and then in a <tt>~/.newrelic</tt> directory
+and then in a `~/.newrelic` directory.  Once you're up and running you can
+enable Server Side Config and manage your newrelic configuation from the web
+UI.
 
-=== Rails Installation
+#### Rails Installation
 
 You can install the agent as a Gem:
 
@@ -68,88 +83,87 @@ Add the following line to your Gemfile:
     gem 'newrelic_rpm'
 
 For Rails 2.x without Bundler:
-   
-edit +environment.rb+ and add to the initalizer block:
-
-    config.gem "newrelic_rpm" 
-
-=== Merb Installation
 
-To monitor a merb app install the newrelic_rpm gem and add
+edit `environment.rb` and add to the initalizer block:
 
-    dependency 'newrelic_rpm'
+    config.gem "newrelic_rpm"
 
-to your init.rb file.
-
-=== Sinatra Installation 
+#### Sinatra Installation
 
 To use the Ruby Agent with a Sinatra app, add
+
     require 'newrelic_rpm'
+
 in your Sinatra app, below the Sinatra require directive.
 
-Then make sure you set RACK_ENV to the environment corresponding to the
-configuration definitions in the newrelic.yml file; i.e., development,
+Then make sure you set `RACK_ENV` to the environment corresponding to the
+configuration definitions in the newrelic.yml file; e.g., development,
 staging, production, etc.
 
-To use Developer Mode in Sinatra, add NewRelic::Rack::DeveloperMode to 
-the middleware stack.  See the +config.ru+ sample below.
+To use Developer Mode in Sinatra, add `NewRelic::Rack::DeveloperMode` to
+the middleware stack.  See the `config.ru` sample below.
+
+#### Other Environments
 
-=== Other Environments
+You can use the Ruby Agent to monitor any Ruby application.  Add
 
-You can use the Ruby Agent to monitor any Ruby application.  Add 
     require 'newrelic_rpm'
+
 to your startup sequence and then manually start the agent using
+
     NewRelic::Agent.manual_start
 
 To instrument Rack based applications, refer to the docs in
-NewRelic::Agent::Instrumentation::Rack.
+`NewRelic::Agent::Instrumentation::Rack`.
 
-Refer to the docs in New Relic for details on how to monitor other web
-frameworks, background jobs, and daemons.
+Refer to the [New Relic's Docs](http://newrelic.com/docs) for details on how to
+monitor other web frameworks, background jobs, and daemons.
 
-Also, see if your environment is already supported by the
-rpm_contrib[http://newrelic.github.com/rpm_contrib] gem.
+The Ruby Agent provides an API that allows custom instrumentation of additional
+frameworks.  You can find a list of community created intrumentation plugins
+(e.g. [newrelic-redis](https://github.com/evanphx/newrelic-redis)) in the
+[RPM Contrib README](https://github.com/newrelic/rpm_contrib/blob/master/README.md#new-relic-ruby-agent-plugins-seperate-projects).
 
-== Developer Mode
+## Developer Mode
 
 When running the Developer Mode, the Ruby Agent will track the
 performance of every HTTP request serviced by your application, and
 store in memory this information for the last 100 HTTP transactions.
 
 To view this performance information, including detailed SQL statement
-analysis, open +/newrelic+ in your web application.  For instance if
+analysis, open `/newrelic` in your web application.  For instance if
 you are running mongrel or thin on port 3000, enter the following into
 your browser:
 
     http://localhost:3000/newrelic
 
-Developer Mode is only initialized if the +developer_mode+ setting in
+Developer Mode is only initialized if the `developer_mode` setting in
 the newrelic.yml file is set to true.  By default, it is turned off in
-all environments but +development+.
+all environments but `development`.
 
-==== Developer Mode in Rails
+#### Developer Mode in Rails
 
 Developer Mode is available automatically in Rails Applications based
 on Rails 2.3 and later.  No additional configuration is required. When
-your application starts and +developer_mode+ is enabled, the Ruby
+your application starts and `developer_mode` is enabled, the Ruby
 Agent injects a middleware into your Rails middleware stack.
 
 For earlier versions of Rails that support Rack, you can use
-a +config.ru+ as below.
+a `config.ru` as below.
 
-==== Developer Mode in Rack Applications
+#### Developer Mode in Rack Applications
 
 Developer Mode is available for any Rack based application such as
 Sinatra by installing the NewRelic::Rack::DeveloperMode
 middleware. This middleware passes all requests that do not start with
 /newrelic.
 
-Here's an example entry for Developer Mode in a +config.ru+ file:
+Here's an example entry for Developer Mode in a `config.ru` file:
 
     require 'new_relic/rack/developer_mode'
     use NewRelic::Rack::DeveloperMode
 
-== Production Mode
+## Production Mode
 
 When your application runs in the production environment, the New
 Relic agent runs in production mode. It connects to the New Relic
@@ -157,13 +171,13 @@ service and sends deep performance data to the UI for your
 analysis. To view this data, log in to http://rpm.newrelic.com.
 
 NOTE: You must have a valid account and license key to view this data
-online.  Refer to instructions in *Getting Started*, below.
+online.  Refer to instructions in *Getting Started*.
 
 
-= Support
+## Support
 
 Reach out to us--and to fellow users--at
-support.newrelic.com[http://support.newrelic.com/].
+[support.newrelic.com](http://support.newrelic.com/).
 There you'll find documentation, FAQs, and forums where you can submit
 suggestions and discuss New Relic with staff and other users.
 
@@ -171,9 +185,11 @@ Also available is community support on IRC: we generally use #newrelic
 on irc.freenode.net
 
 Find a bug?  E-mail support@newrelic.com, or post it to
-support.newrelic.com[http://support.newrelic.com/].
 
-Thank you, and may your application scale to infinity plus one.  
+[support.newrelic.com](http://support.newrelic.com/).
+
+Thank you, and may your application scale to infinity plus one.
+
+Lew Cirne, Founder and CEO
 
-Lew Cirne, Founder and CEO<br/>
 New Relic, Inc.