newrelic_rpm 4.8.0.341 → 6.13.1

data/CONTRIBUTING.md

@@ -1,13 +1,13 @@
 # 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.
+New Relic welcomes code contributions by the Ruby community, 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. 2.x.x, jruby, etc.) as well as a wide variety of
-application environments (e.g. Rails, Sinatra, roll-your-own, etc.) See
-https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks
+application environments (e.g. Rails, Sinatra, roll-your-own, etc.) See [Ruby agent requirements and supported frameworks]
+(https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks)
 for the current full list.
 
 Because of this, we need to be more defensive in our coding practices than most
@@ -15,10 +15,72 @@ projects. Syntax must be compatible with all supported Ruby implementations and
 we can't assume the presence of any specific libraries, including `ActiveSupport`,
 `ActiveRecord`, etc.
 
+## Process
+
+### Version Support
+
+When contributing, keep in mind that New Relic customers (that's you!) are
+running many different versions of Ruby, some of them pretty old. Changes that
+depend on the newest version of Ruby will probably be rejected, especially if
+they replace something backwards compatible.
+
+Be aware that the instrumentation needs to work with a wide range of versions of
+the instrumented modules, and that code that looks nonsensical or
+overcomplicated may be that way for compatibility-related reasons. Read all the
+comments and check the related tests before deciding whether existing code is
+incorrect.
+
+If you are planning on contributing a new feature or an otherwise complex
+contribution, we kindly ask you to start a conversation with the maintainer team
+by opening up an Github issue first.
+
+
+### General Guidelines
+The Ruby agent avoids requiring any dependencies in the main agent code base.
+Instrumentations and features that would otherwise require a dependency (such as
+Infinite Tracing, which require gRPC and protobuf) are built as separate gems.
+If you have a feature or instrumentation request that would require a
+dependency, please open an Issue to discuss with the maintainers before
+proceeding.
+
+Your code will be evaluated for completeness and accuracy in
+implementation and must be accompanied with appropriate unit tests.  New
+additions that do not break existing tests are the easiest and quickest to be
+accepted and merged.  New features and improvements that break existing
+functionality are slower to be accepted and merged as they require agreement
+with maintainers across a majority of the languages New Relic supports.  Any
+such breaking changes will require a major version bump whereas non-breaking
+additions only lead to minor version bumps.
+
+Please be aware that the maintainers of New Relic’s agents aim to have as much
+commonality of functionality across all language agents as makes sense, so we are
+always working to reconcile language-specific changes against the cross-language
+community set of agreements.
+
+### Feature Requests
+
+Feature requests should be submitted in the [Issue tracker](../../issues), with
+a description of the expected behavior & use case. Before submitting an Issue,
+please search for similar ones in the [closed
+issues](../../issues?q=is%3Aissue+is%3Aclosed).
+
+### Pull Requests
+
+We can only accept PRs for version v6.12.0 or greater due to open source
+licensing restrictions.
+
+### Code of Conduct
+
+Before contributing please read the [code of conduct](https://github.com/newrelic/.github/blob/master/CODE_OF_CONDUCT.md)
+
+Note that our [code of conduct](https://github.com/newrelic/.github/blob/master/CODE_OF_CONDUCT.md) applies to all platforms
+and venues related to this project; please follow it in all your interactions
+with the project and its participants.
+
 ## Branches
 
-The head of master will generally have New Relic's latest release. However,
-New Relic reserves the ability to push an edge to the master. If you download a
+The head of `main` will generally have New Relic's latest release. However,
+New Relic reserves the ability to push an edge to the `main`. If you download a
 release from this repo, use the appropriate tag. New Relic usually pushes beta
 versions of a release to a working branch before tagging them for General
 Availability.
@@ -39,13 +101,16 @@ 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.
+This will run the unit tests in standalone mode. You can run against a specific Rails version
+by passing the version name (which should match the name of a subdirectory in test/environments)
+as an argument to the test:env rake task, like this:
+
+bundle exec rake test:env[rails60]
 
 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
-build passes for your fork.
+[GitHub Actions](https://github.com/newrelic/newrelic-ruby-agent/actions) under several
+Ruby implementations. When you've pushed your changes to GitHub, you can confirm that
+the GitHub Actions test matrix passes for your fork.
 
 Additionally, our own CI jobs runs these tests under multiple versions of Rails
 to verify compatibility.
@@ -74,15 +139,37 @@ These tests can be run by invoking:
     bundle exec rake test:multiverse
 
 More details are available in
-[test/multiverse/README.md](https://github.com/newrelic/rpm/blob/master/test/multiverse/README.md).
+[test/multiverse/README.md](https://github.com/newrelic/newrelic-ruby-agent/blob/main/test/multiverse/README.md).
+
+## Contributor License Agreement
+
+Keep in mind that when you submit your Pull Request, you'll need to sign the CLA
+via the click-through using CLA-Assistant. If you'd like to execute our
+corporate CLA, or if you have any questions, please drop us an email at
+opensource@newrelic.com.
+
+For more information about CLAs, please check out Alex Russell’s excellent post,
+[“Why Do I Need to Sign This?”](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
+
+## Slack
+
+We host a public Slack with a dedicated channel for contributors and maintainers
+of open source projects hosted by New Relic.  If you are contributing to this
+project, you're welcome to request access to the #oss-contributors channel in
+the newrelicusers.slack.com workspace.  To request access, see
+https://newrelicusers-signup.herokuapp.com/.
+
+## Explorer's Hub
+
+New Relic hosts and moderates an online forum where customers can interact with
+New Relic employees as well as other customers to get help and share best
+practices. Like all official New Relic open source projects, there's a related
+Community topic in the New Relic Explorers Hub. You can find this project's
+topic/threads here:
 
-### And Finally...
+[Explorer's Hub](https://discuss.newrelic.com/tags/rubyagent)
 
-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. Fortunately, you also agree the code is provided as-is and you provide no
-warranties as to its fitness or correctness for any purpose.
+## And Finally...
 
 If you have any feedback on how we can make contributing easier, please get in
 touch at [support.newrelic.com](http://support.newrelic.com) and let us know!

data/Gemfile

@@ -1,3 +1,7 @@
-source 'https://rubygems.org'
+# encoding: utf-8
+# 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
 
-gemspec
+source 'https://rubygems.org'
+gemspec name: "newrelic_rpm"

data/Guardfile

@@ -1,8 +1,25 @@
-guard :minitest, :test_folders => ['test/new_relic'], :all_after_pass => false do
+require './test/multiverse/lib/multiverse/bundler_patch'
+
+test_folders = Dir.glob("test/new_relic/*").select{|f| File.directory?(f)}
+test_folders += Dir.glob("test/new_relic/**/*").select{|f| File.directory?(f)}
+
+rake_lib_path = Bundler.with_unbundled_env{ `bundle exec gem which rake`.chomp.gsub("lib/rake.rb", "lib") }
+ruby_options = %{-w -I"#{rake_lib_path}" "#{rake_lib_path}/rake/rake_test_loader.rb"}
+
+guard_options = {
+  spring: "bundle exec ruby #{ruby_options} ",
+  test_folders: ['test/new_relic'] + test_folders, 
+  all_after_pass: false,
+  all_on_start: false
+}
+
+guard :minitest, guard_options do
   watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/.+_test\.rb$})
   watch(%r{^test/rum/.*})       { "test/new_relic/rack/browser_monitoring_test.rb" }
+  watch(%r{^test/fixtures/cross_agent_tests/distributed_tracing/(.+).json}) { |m| "test/new_relic/agent/distributed_tracing/#{m[1]}_cross_agent_test.rb" }
   watch('test/test_helper.rb')  { "test/new_relic" }
   watch('test/agent_helper.rb') { "test/new_relic" }
   watch('lib/new_relic/agent/configuration/default_source.rb') { "test/new_relic/agent/configuration/orphan_configuration_test.rb" }
+  watch(%r{^lib/new_relic/agent/transaction/(.+).rb}) { |m| "test/new_relic/agent/distributed_tracing/#{m[1]}_cross_agent_test.rb" }
 end

data/LICENSE

@@ -1,38 +1,208 @@
-All components of this product are
-Copyright (c) 2008-2017 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
-parties.
-
-Subject to the terms of this notice, New Relic grants you a
-nonexclusive, nontransferable license, without the right to
-sublicense, to (a) install and execute one copy of these files on any
-number of workstations owned or controlled by you and (b) distribute
-verbatim copies of these files to third parties.  As a condition to the
-foregoing grant, you must provide this notice along with each copy you
-distribute and you must not remove, alter, or obscure this notice. All
-other use, reproduction, modification, distribution, or other
-exploitation of these files is strictly prohibited, except as may be set
-forth in a separate written license agreement between you and New
-Relic.  The terms of any such license agreement will control over this
-notice.  The license stated above will be automatically terminated and
-revoked if you exceed its scope or violate any of the terms of this
-notice.
-
-This License does not grant permission to use the trade names,
-trademarks, service marks, or product names of New Relic, except as
-required for reasonable and customary use in describing the origin of
-this file and reproducing the content of this notice.  You may not
-mark or brand this file with any trade name, trademarks, service
-marks, or product names other than the original brand (if any)
-provided by New Relic.
-
-Unless otherwise expressly agreed by New Relic in a separate written
-license agreement, these files are provided AS IS, WITHOUT WARRANTY OF
-ANY KIND, including without any implied warranties of MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT.  As a
-condition to your use of these files, you are solely responsible for
-such use. New Relic will have no liability to you for direct,
-indirect, consequential, incidental, special, or punitive damages or
-for lost profits or data.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Versions 6.12.0 and above for this project are licensed under 
+   Apache 2.0.  For prior versions of this project, please see the 
+   LICENSE file in the root directory of that version for more information.
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+

data/README.md

@@ -1,12 +1,15 @@
+[![Community Plus header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
+
 # 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 a either a Gem or a Rails plugin,
+hosted on [github](https://github.com/newrelic/newrelic-ruby-agent).
 
 ## Supported Environments
 
@@ -14,130 +17,120 @@ 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).
+### Quick Start
 
-Following these helps us efficiently review and incorporate your contribution
-and avoid breaking your code with future changes to the agent.
+#### With Bundler
 
+For using with Bundler, add the Ruby Agent to your project's Gemfile.
 
-## Getting Started
-
-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:
+#### Oher 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)
+* [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:
+## Support
 
-```ruby
-require 'newrelic_rpm'
-```
+Should you need assistance with New Relic products, you are in good hands with several support diagnostic tools and support channels.
 
-in your Sinatra app, below the Sinatra require directive.
+This [troubleshooting framework](https://discuss.newrelic.com/t/ruby-troubleshooting-framework-install/108685) steps you through common troubleshooting questions.
 
-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.
+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.
 
-#### Other Environments
+If the issue has been confirmed as a bug or is a Feature request, please file a Github issue.
 
-You can use the Ruby Agent to monitor any Ruby application. Add:
+**Support Channels**
 
-```ruby
-require 'newrelic_rpm'
-```
+* [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).
 
-to your startup sequence and then manually start the agent using:
+## Privacy
 
-```ruby
-NewRelic::Agent.manual_start
-```
+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.
 
-For information about instrumenting pure Rack applications, see our
-[Rack middlewares documentation](http://docs.newrelic.com/docs/ruby/rack-middlewares).
+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.
 
-Refer to the [New Relic's Docs](http://newrelic.com/docs) for details on how to
-monitor other web frameworks, background jobs, and daemons.
+Please review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy) for more information.
 
-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).
+## Roadmap
+See our [roadmap](https://github.com/newrelic/newrelic-ruby-agent/blob/main/ROADMAP.md), to learn more about our product vision, understand our plans, and provide us valuable feedback.
 
-## 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 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).
 
-You can find more detailed documentation [on our website](http://newrelic.com/docs),
-and specifically in the [Ruby category](http://newrelic.com/docs/ruby).
+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).
 
-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](http://forum.newrelic.com)
-and we'll be happy to help you.
+## License
 
-Also available is community support on IRC: we generally use #newrelic
-on irc.freenode.net
+The New Relic Ruby agent is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
+The New Relic Ruby agent also uses source code from third-party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the [THIRD_PARTY_NOTICES.md](https://github.com/newrelic/newrelic-ruby-agent/blob/main/THIRD_PARTY_NOTICES.md).
 
-Find a bug? Contact us via [support.newrelic.com](http://support.newrelic.com/),
-or email support@newrelic.com.
+## Thank You
 
 Thank you, and may your application scale to infinity plus one.
 
 Lew Cirne, Founder and CEO
 
-New Relic, Inc.
+New Relic, Inc.