newrelic_rpm 6.3.0.355 → 9.2.0

data/README.md

@@ -1,12 +1,19 @@
+<a href="https://opensource.newrelic.com/oss-category/#community-plus"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"><img alt="New Relic Open Source community plus project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"></picture></a>
+
 # 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 and transmits them to
-newrelic.com where you can monitor them in real time. The New Relic
-Ruby Agent is dual-purposed as a either a Gem or a Rails plugin,
-hosted on [github](https://github.com/newrelic/rpm/tree/master).
+The New Relic Ruby agent monitors your applications to help you
+[identify and solve performance issues](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby#monitor-performance).
+You can also extend the agent's performance monitoring to
+[collect and analyze business data](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby#business-data)
+to help you improve the customer experience and make data-driven business decisions.
+
+The New Relic Ruby agent is dual-purposed as either a Gem or a Rails plugin,
+hosted on [github](https://github.com/newrelic/newrelic-ruby-agent).
+
+This code is actively maintained by New Relic engineering teams and delivered here in GitHub. See below for troubleshooting and defect reporting instructions.
+
+[![Gem Version](https://badge.fury.io/rb/newrelic_rpm.svg)](https://badge.fury.io/rb/newrelic_rpm)
 
 ## Supported Environments
 
@@ -14,127 +21,119 @@ An up-to-date list of Ruby versions and frameworks for the latest agent
 can be found on [our docs site](http://docs.newrelic.com/docs/ruby/supported-frameworks).
 
 You can also monitor non-web applications. Refer to the "Other
-Environments" section under "Getting Started".
+Environments" section below.
 
-## Contributing Code
+## Installing and Using
 
-We welcome code contributions (in the form of pull requests) from our user
-community.  Before submitting a pull request please review
-[these guidelines](https://github.com/newrelic/rpm/blob/master/CONTRIBUTING.md).
+The latest released gem for the Ruby agent can be found at [Rubygems.org](https://rubygems.org/gems/newrelic_rpm)
 
-Following these helps us efficiently review and incorporate your contribution
-and avoid breaking your code with future changes to the agent.
+### Quick Start
 
+#### With Bundler
 
-## Getting Started
+For using with Bundler, add the Ruby agent to your project's Gemfile.
 
-Add the Ruby Agent to your project's Gemfile.
+```ruby
+gem 'newrelic_rpm'
+```
 
-    gem 'newrelic_rpm'
+and run `bundle install` to activate the new gem.
 
-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.
+#### Without Bundler
 
-Once you receive the welcome email with a license key and
-`newrelic.yml` file, you can copy the `newrelic.yml` file into your app config
-directory OR can generate the file manually with command:
+If you are not using Bundler, install the gem with:
 
-    newrelic install --license_key="YOUR_KEY" "My application"
+```bash
+gem install newrelic_rpm
+```
 
-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 `~/.newrelic` directory.  Once you're up and running you can
-enable Server Side Config and manage your newrelic configuration from the web
-UI.
+and then require the New Relic Ruby agent in your Ruby start-up sequence:
 
-#### Rails Installation
+```ruby
+require 'newrelic_rpm'
+```
 
-You can install the agent as a Gem:
+#### Other Environments
 
-For Bundler:
+Assuming you have installed the agent per above, you may also need to tell the Ruby agent to start for some frameworks and non-framework environments. To do so, add the following to your Ruby start-up sequence start the agent:
 
-Add the following line to your Gemfile:
+```ruby
+NewRelic::Agent.manual_start
+```
 
-    gem 'newrelic_rpm'
+### Complete Install Instructions
 
-For Rails 2.x without Bundler:
+For complete documentation on installing the New Relic Ruby agent, see the following links:
 
-edit `environment.rb` and add to the initalizer block:
+* [Introduction](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby)
+* [Install the New Relic Ruby agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent)
+* [Configure the agent](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration)
+* [Update the agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/update-ruby-agent)
+* [Rails plugin installation](https://docs.newrelic.com/docs/agents/ruby-agent/installation/ruby-agent-installation-rails-plugin)
+* [GAE Flexible Environment](https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent-gae-flexible-environment)
+* [Pure Rack Apps](http://docs.newrelic.com/docs/ruby/rack-middlewares)
+* [Ruby agent and Heroku](https://docs.newrelic.com/docs/agents/ruby-agent/installation/ruby-agent-heroku)
+* [Background Jobs](https://docs.newrelic.com/docs/agents/ruby-agent/background-jobs/monitor-ruby-background-processes)
+* [Uninstall the Ruby agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/uninstall-ruby-agent)
 
-    config.gem "newrelic_rpm"
+### Recording Deploys
 
-#### Sinatra Installation
+The Ruby agent supports recording deployments in New Relic via a command line
+tool or Capistrano recipes. For more information on these features, see
+[our deployment documentation](http://docs.newrelic.com/docs/ruby/recording-deployments-with-the-ruby-agent)
+for more information.
 
-To use the Ruby Agent with a Sinatra app, add:
 
-```ruby
-require 'newrelic_rpm'
-```
+## Support
 
-in your Sinatra app, below the Sinatra require directive.
+Should you need assistance with New Relic products, you are in good hands with several support diagnostic tools and support channels.
 
-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.
+This [troubleshooting framework](https://discuss.newrelic.com/t/ruby-troubleshooting-framework-install/108685) steps you through common troubleshooting questions.
 
-#### Other Environments
+New Relic offers NRDiag, [a client-side diagnostic utility](https://docs.newrelic.com/docs/using-new-relic/cross-product-functions/troubleshooting/new-relic-diagnostics) that automatically detects common problems with New Relic agents. If NRDiag detects a problem, it suggests troubleshooting steps. NRDiag can also automatically attach troubleshooting data to a New Relic Support ticket.
 
-You can use the Ruby Agent to monitor any Ruby application. Add:
+If the issue has been confirmed as a bug or is a Feature request, please file a GitHub issue.
 
-```ruby
-require 'newrelic_rpm'
-```
+**Support Channels**
 
-to your startup sequence and then manually start the agent using:
+* [New Relic Documentation](https://docs.newrelic.com/docs/agents/ruby-agent): Comprehensive guidance for using our platform
+* [New Relic Community](https://discuss.newrelic.com/tags/rubyagent): The best place to engage in troubleshooting questions
+* [New Relic Developer](https://developer.newrelic.com/): Resources for building a custom observability applications
+* [New Relic University](https://learn.newrelic.com/): A range of online training for New Relic users of every level
+* [New Relic Technical Support](https://support.newrelic.com/) 24/7/365 ticketed support. Read more about our [Technical Support Offerings](https://docs.newrelic.com/docs/licenses/license-information/general-usage-licenses/support-plan).
 
-```ruby
-NewRelic::Agent.manual_start
-```
+## Privacy
 
-For information about instrumenting pure Rack applications, see our
-[Rack middlewares documentation](http://docs.newrelic.com/docs/ruby/rack-middlewares).
+At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise.
 
-Refer to the [New Relic's Docs](http://newrelic.com/docs) for details on how to
-monitor other web frameworks, background jobs, and daemons.
+We define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address, and email address.
 
-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
-[extends_newrelic_rpm project](https://github.com/newrelic/extends_newrelic_rpm).
+Please review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy) for more information.
 
-## Production Mode
+## Contributing
 
-When your application runs in the production environment, the New
-Relic agent runs in production mode. It connects to the New Relic
-service and sends deep performance data to the UI for your
-analysis. To view this data, log in to http://rpm.newrelic.com.
+We encourage contributions to improve the New Relic Ruby agent! Keep in mind when you submit your pull request, you'll need to sign the Contributor License Agreement (CLA) via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
+If you have any questions, or to execute our corporate CLA (required if your contribution is on behalf of a company), please drop us an email at opensource@newrelic.com.
 
-NOTE: You must have a valid account and license key to view this data
-online.  Refer to instructions in *Getting Started*.
+**A note about vulnerabilities**
 
-## Recording Deploys
+As noted in our [security policy](https://github.com/newrelic/newrelic-ruby-agent/security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
 
-The Ruby Agent supports recording deployments in New Relic via a command line
-tool or Capistrano recipes. For more information on these features see
-[our deployment documentation](http://docs.newrelic.com/docs/ruby/recording-deployments-with-the-ruby-agent)
-for more information.
+If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic).
 
-## Support
+If you would like to contribute to this project, please review [these guidelines](https://github.com/newrelic/newrelic-ruby-agent/blob/main/CONTRIBUTING.md).
+
+To [all contributors](https://github.com/newrelic/newrelic-ruby-agent/graphs/contributors), we thank you!  Without your contribution, this project would not be what it is today.  We also host a community project page dedicated to
+the [New Relic Ruby agent](https://opensource.newrelic.com/projects/newrelic/newrelic-ruby-agent).
 
-You can find more detailed documentation [on our website](http://newrelic.com/docs),
-and specifically in the [Ruby category](http://newrelic.com/docs/ruby).
+## License
 
-If you can't find what you're looking for there, reach out to us on our [support
-site](http://support.newrelic.com/) or our [community forum](https://discuss.newrelic.com/)
-and we'll be happy to help you.
+As of version 6.12 (released July 16, 2020), the New Relic Ruby agent is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for a copy of the license. For older agent versions, check the LICENSE file included with the source code.
 
-Find a bug? Contact us via [support.newrelic.com](http://support.newrelic.com/),
-or email support@newrelic.com.
+The New Relic Ruby agent may use source code from third-party libraries. When used, these libraries will be outlined in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
 
-Thank you, and may your application scale to infinity plus one.
+## Thank You
 
-Lew Cirne, Founder and CEO
+Thank you,
 
-New Relic, Inc.
+New Relic Ruby agent team

data/Rakefile

@@ -1,7 +1,13 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'rake/testtask'
 require 'yard'
 require "#{File.dirname(__FILE__)}/lib/tasks/all.rb"
+require_relative 'lib/tasks/helpers/prompt'
+include Prompt
 
 YARD::Rake::YardocTask.new
 
@@ -9,32 +15,30 @@ task :default => :test
 task :test => ['test:newrelic']
 
 namespace :test do
-  desc "Run all tests"
-  task :all => %w{newrelic multiverse}
-
-  begin
-    require 'test_bisect'
-    TestBisect::BisectTask.new do |t|
-      t.test_task_name = 'test:newrelic'
-    end
-  rescue LoadError
-  end
-
+  desc 'Run all tests'
+  task :all => %w[newrelic multiverse all_compatible_envs]
   agent_home = File.expand_path(File.dirname(__FILE__))
 
-  desc "Run agent performance tests"
+  desc 'Run agent performance tests'
   task :performance, [:suite, :name] => [] do |t, args|
     require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'performance', 'lib', 'performance'))
     options = {}
     options[:suite] = args[:suite] if args[:suite]
-    options[:name]  = args[:name]  if args[:name]
+    options[:name] = args[:name] if args[:name]
     Performance::Runner.new(options).run_and_report
   end
 
-  desc "Run agent within existing mini environments"
-  task :env, [:env1, :env2, :env3, :env4, :env5, :env6] => [] do |t, args|
+  desc 'Run agent within existing mini environment(s): env[name1,name2,name3,etc.]'
+  task :env do |t, args|
     require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'environments', 'lib', 'environments', 'runner'))
-    Environments::Runner.new(args.map{|_,v| v}).run_and_report
+    Environments::Runner.new(args.to_a).run_and_report
+  end
+
+  desc 'Run all mini environment tests known to work with the current Ruby version'
+  task :all_compatible_envs do |t, args|
+    require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'helpers', 'ruby_rails_mappings'))
+    rails_versions = rails_versions_for_ruby_version(RUBY_VERSION)
+    Rake::Task['test:env'].invoke(*rails_versions)
   end
 
   Rake::TestTask.new(:intentional_fail) do |t|
@@ -51,18 +55,17 @@ namespace :test do
 
   # Note unit testing task is defined in lib/tasks/tests.rake to facilitate
   # running them in a rails application environment.
-
 end
 
 desc 'Record build number and stage'
-task :record_build, [ :build_number, :stage ] do |t, args|
+task :record_build, [:build_number, :stage] do |t, args|
   build_string = args.build_number
   build_string << ".#{args.stage}" unless args.stage.nil? || args.stage.empty?
 
-  gitsha = File.exists?(".git") ? `git rev-parse HEAD` : "Unknown"
+  gitsha = File.exist?('.git') ? `git rev-parse HEAD` : 'Unknown'
   gitsha.chomp!
 
-  File.open("lib/new_relic/build.rb", "w") do |f|
+  File.open('lib/new_relic/build.rb', 'w') do |f|
     f.write("# GITSHA: #{gitsha}\n")
     f.write("module NewRelic; module VERSION; BUILD='#{build_string}'; end; end\n")
   end
@@ -90,14 +93,14 @@ task :update_ca_bundle do |t|
   bundle_last_update = `cd #{ca_bundle_path} && git show -s --format=%ci HEAD`
   puts "Source CA bundle last updated #{bundle_last_update}"
 
-  bundle_path = "cert/cacert.pem"
+  bundle_path = 'cert/cacert.pem'
   cert_paths = []
   Dir.glob("#{ca_bundle_path}/*.pem").each { |p| cert_paths << p }
   cert_paths.sort!
 
   puts "Writing #{cert_paths.size} certs to bundle at #{bundle_path}..."
 
-  File.open(bundle_path, "w") do |f|
+  File.open(bundle_path, 'w') do |f|
     cert_paths.each do |cert_path|
       cert_name = File.basename(cert_path, '.pem')
       puts "Adding #{cert_name}"
@@ -110,26 +113,23 @@ task :update_ca_bundle do |t|
 end
 
 namespace :cross_agent_tests do
-  cross_agent_tests_upstream_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'cross_agent_tests'))
-  cross_agent_tests_local_path    = File.expand_path(File.join(File.dirname(__FILE__), 'test', 'fixtures', 'cross_agent_tests'))
+  CROSS_AGENT_TESTS_UPSTREAM_PATH = File.expand_path(File.join('..', 'cross_agent_tests')).freeze
+  CROSS_AGENT_TESTS_LOCAL_PATH = File.expand_path(File.join('test', 'fixtures', 'cross_agent_tests')).freeze
 
   desc 'Pull latest changes from cross_agent_tests repo'
   task :pull do
-    puts "Updating embedded cross_agent_tests from #{cross_agent_tests_upstream_path}..."
-    cmd = "rsync -avu --exclude .git #{cross_agent_tests_upstream_path}/ #{cross_agent_tests_local_path}/"
-    puts cmd
-    system(cmd)
+    command = "  rsync -av --exclude .git #{CROSS_AGENT_TESTS_UPSTREAM_PATH}/ #{CROSS_AGENT_TESTS_LOCAL_PATH}/"
+    prompt_to_continue(command)
   end
 
   desc 'Copy changes from embedded cross_agent_tests to official repo working copy'
   task :push do
-    puts "Copying changes from embedded cross_agent_tests to #{cross_agent_tests_upstream_path}..."
-    cmd = "rsync -avu #{cross_agent_tests_local_path}/ #{cross_agent_tests_upstream_path}/"
-    puts cmd
-    system(cmd)
+    command = "rsync -av #{CROSS_AGENT_TESTS_LOCAL_PATH}/ #{CROSS_AGENT_TESTS_UPSTREAM_PATH}/"
+    prompt_to_continue(command, 'remote (agent spec repo)')
   end
 end
 
+desc 'Start an interactive console session'
 task :console do
   require 'pry'
   require 'newrelic_rpm'

data/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,28 @@
+# Third Party Notices
+
+The New Relic Ruby agent may make use of source code from third party libraries
+which carry their own copyright notices and license terms. Any such content will
+be provided below.
+
+In the event that a required notice is missing or incorrect, please notify us
+by e-mailing [open-source@newrelic.com](mailto:open-source@newrelic.com).
+
+For any licenses that require the disclosure of source
+code, the source code can be found at:
+[https://github.com/newrelic/newrelic-ruby-agent](https://github.com/newrelic/newrelic-ruby-agent).
+
+
+## Current Notices and Terms
+
+As of version 7.0 (released April 23, 2021), the New Relic Ruby agent does not
+include any third party software with its distribution.
+
+The Ruby agent team leverages a variety of open source third party software for
+the development of the agent but not distributed with the agent. Some of these
+software packages are referenced as development dependencies in the agent's
+[newrelic_rpm.gemspec](newrelic_rpm.gemspec) file. We are grateful
+to the maintainers and contributors for all of these packages.
+
+For versions older than 7.0, please consult the `THIRD_PARTY_NOTICES.md`
+document distributed with the agent. Any version of the agent not containing
+that document are not thought to include any third party software.

data/Thorfile

@@ -0,0 +1,5 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+Dir['./lib/tasks/**/*.thor'].sort.each { |f| load f }

data/bin/newrelic

@@ -1,13 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # executes one of the commands in the new_relic/commands directory
 # pass the name of the command as an argument
 
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..','lib'))
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'new_relic/cli/command'
 begin
   NewRelic::Cli::Command.run
 rescue NewRelic::Cli::Command::CommandFailure => failure
   STDERR.puts failure.message
   STDERR.puts failure.options if failure.options
-  exit 1
+  exit(1)
 end

data/bin/newrelic_cmd

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # This command has been renamed "newrelic"
 # executes one of the commands in the new_relic/commands directory
 # pass the name of the command as an argument