From 015802ef8feb5af932ebd399fb235e5649184d5e Mon Sep 17 00:00:00 2001 From: Hannah Ramadan <76922290+hannahramadan@users.noreply.github.com> Date: Fri, 3 Feb 2023 14:16:31 -0800 Subject: [PATCH 1/5] Remove support for deprecated gems This PR updates our support for gems that we will no longer instrument with the release of Ruby agent 9.0.0 --- ...y-agent-requirements-supported-frameworks.mdx | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx index d4a6b94b400..e22648aa429 100644 --- a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx +++ b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx @@ -168,11 +168,11 @@ Web servers supported by the Ruby agent include: - + * ~~4.5.0~~ - * 4.5.0 - Deprecated + * 4.5.0: Last supported agent was 8.16.0. @@ -395,7 +395,11 @@ The Ruby agent does not support experimental versions. Databases supported by th - * 1.0 - Deprecated + * ~~1.0~~ + + + + * 1.0.x: Last supported agent: 8.16.0. @@ -781,10 +785,10 @@ Currently supported gems that facilitate message brokers: APM's Ruby agent also supports: * ActiveMerchant: 1.25.0 or higher (Versions 1.25.0 - 1.64.x are Deprecated) -* Acts_as_Solr: Deprecated -* authlogic: Deprecated +* Acts_as_Solr: Last supported in agent version 8.16.0 +* authlogic: Last supported in agent version 8.16.0 * concurrent-ruby: 1.1.5 or higher -* Sunspot: Deprecated +* Sunspot: Last supported in agent version 8.16.0 * Tilt: 2.x for Ruby 2.2 or higher; 1.x for Ruby 2.7 or lower * Yajl-Ruby: 1.1.0 or higher From 73dc612ecfa45cc76aa9cc759511ace7184eb4bd Mon Sep 17 00:00:00 2001 From: Rob Siebens Date: Fri, 3 Feb 2023 18:17:51 -0800 Subject: [PATCH 2/5] fix(Ruby): Switch to --- .../ruby-agent-requirements-supported-frameworks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx index e22648aa429..f1878d9b6ed 100644 --- a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx +++ b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx @@ -167,7 +167,7 @@ Web servers supported by the Ruby agent include: Rainbows! - + * ~~4.5.0~~ From 29e5503a82e3a71d7c25ac84986162367c275bf0 Mon Sep 17 00:00:00 2001 From: alexa <81787716+akristen@users.noreply.github.com> Date: Mon, 6 Feb 2023 12:40:35 -0800 Subject: [PATCH 3/5] feat(content): fix `` --- ...agent-requirements-supported-frameworks.mdx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx index f1878d9b6ed..661c55a4ebe 100644 --- a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx +++ b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx @@ -137,9 +137,9 @@ Web servers supported by the Ruby agent include: * 6.0.x - + - + @@ -159,7 +159,7 @@ Web servers supported by the Ruby agent include: * 1.0.x - + @@ -169,7 +169,7 @@ Web servers supported by the Ruby agent include: * ~~4.5.0~~ - + * 4.5.0: Last supported agent was 8.16.0. @@ -185,9 +185,9 @@ Web servers supported by the Ruby agent include: * 1.x.x - + - + @@ -207,7 +207,7 @@ Web servers supported by the Ruby agent include: * 3.0.x - + @@ -219,9 +219,9 @@ Web servers supported by the Ruby agent include: Supported for all agent-supported versions of Ruby - + - + From 98a9892d27fd6ebc22cbef5f7a0d9322f619a8a1 Mon Sep 17 00:00:00 2001 From: alexa <81787716+akristen@users.noreply.github.com> Date: Mon, 6 Feb 2023 13:07:40 -0800 Subject: [PATCH 4/5] table fix attempt 2 --- ...by-agent-requirements-supported-frameworks.mdx | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx index 661c55a4ebe..0a5d546da1d 100644 --- a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx +++ b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx @@ -136,10 +136,6 @@ Web servers supported by the Ruby agent include: * 5.x.x * 6.0.x - - - - @@ -158,8 +154,6 @@ Web servers supported by the Ruby agent include: * 1.0.x - - @@ -170,10 +164,11 @@ Web servers supported by the Ruby agent include: * ~~4.5.0~~ - + * 4.5.0: Last supported agent was 8.16.0. + @@ -184,10 +179,6 @@ Web servers supported by the Ruby agent include: * 1.x.x - - - - @@ -219,8 +210,6 @@ Web servers supported by the Ruby agent include: Supported for all agent-supported versions of Ruby - - From 8ee7d728f07af08dcff7eda5632a35dd16c73efc Mon Sep 17 00:00:00 2001 From: alexa <81787716+akristen@users.noreply.github.com> Date: Mon, 6 Feb 2023 13:19:34 -0800 Subject: [PATCH 5/5] actual fix! --- ...gent-requirements-supported-frameworks.mdx | 179 +----------------- 1 file changed, 10 insertions(+), 169 deletions(-) diff --git a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx index 0a5d546da1d..2282c53a649 100644 --- a/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx +++ b/src/content/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks.mdx @@ -16,63 +16,47 @@ redirects: - /docs/ruby/rubinius - /docs/agents/ruby-agent/troubleshooting/new-relic-puma --- - Before you [install New Relic's Ruby agent](/docs/agents/ruby-agent/installation-and-configuration/ruby-agent-installation), make sure you meet these requirements for compatible operating systems, security requirements, and supported frameworks. - If you don't have one already, start by [creating a New Relic account](https://newrelic.com/signup). It's free, forever. - ## Operating systems [#os] - The Ruby agent supports UNIX-like operating systems such as Linux, Solaris, FreeBSD, and macOS. - ## Security requirements [#security] - As a standard [security measure for data collection](/docs/accounts-partnerships/accounts/security/data-security), your app server must support SHA-2 (256-bit). SHA-1 is not supported. - ## Ruby versions [#ruby_versions] - The New Relic Ruby agent does not support experimental versions. Ruby versions supported by the Ruby agent include: - - - - - - - - -
Ruby versions Supported Deprecated
JRuby * 9.0.x * 9.1.x * 9.2.x * 9.3.x * 1.7.x or earlier: Last supported agent was 3.18.1.330.
CRuby * ~~1.8.7~~ * ~~1.9.x~~ @@ -88,7 +72,6 @@ The New Relic Ruby agent does not support experimental versions. Ruby versions s * 3.1.x * 3.2.x * 2.0.x, 2.1.x Last supported agent: 6.15.0. * 1.8.7, 1.9.2, 1.9.3: Last supported agent was 3.18.1.330. @@ -97,38 +80,30 @@ The New Relic Ruby agent does not support experimental versions. Ruby versions s
- ## Web servers [#web_servers] - Web servers supported by the Ruby agent include: - - - - - - + - - - + - - @@ -168,80 +141,67 @@ Web servers supported by the Ruby agent include: - + - - + - - - - - + - - - - +
Web servers Supported Deprecated Experimental
Passenger * 2.2.x - Deprecated * 3.0.x - Deprecated @@ -136,13 +111,13 @@ Web servers supported by the Ruby agent include: * 5.x.x * 6.0.x +
Puma * 2.0.x - Deprecated * 3.x.x @@ -150,17 +125,15 @@ Web servers supported by the Ruby agent include: * 5.x.x * 6.x.x * 1.0.x
Rainbows! * ~~4.5.0~~ * 4.5.0: Last supported agent was 8.16.0.
Thin * 1.x.x +
Unicorn * 4.x.x * 5.x.x * 6.0.x * 1.0.x * 2.0.x * 3.0.x
Webrick Supported for all agent-supported versions of Ruby +
- ## Web frameworks [#web_frameworks] - The Ruby agent does not support experimental versions. Web frameworks supported by the Ruby agent are listed below. Please note that Grape, Padrino, and Sinatra are not supported for Ruby 3.0+. - - - - - - - - - - - - - - - - - -
Web frameworks Supported Deprecated
Grape * 0.2.0 - Deprecated * 0.19.2 @@ -252,45 +212,36 @@ The Ruby agent does not support experimental versions. Web frameworks supported * 1.6.x * 1.7.x
Padrino * 0.14.x - Deprecated * 0.15.1 * 0.15.2
Rack * 1.6.x * 2.x * 3.0.x * 1.0.x
Rails * 3.2.x - Deprecated * 4.0.x @@ -303,19 +254,16 @@ The Ruby agent does not support experimental versions. Web frameworks supported * 6.1.x * 7.0.x * 2.1.x, 2.2.x, 2.3.x: Last supported agent was 3.18.1.330. * 2.0.x: Last supported agent was 3.6.8.168. * 3.0.x, 3.1.x: Last supported agent was 6.15.0.
Sinatra * 1.4.x - Deprecated * 1.5.x - Deprecated @@ -323,41 +271,33 @@ The Ruby agent does not support experimental versions. Web frameworks supported * 2.1.x * 3.0.x * 1.2.x, 1.3.x: Last supported in agent version 6.15.0
- ## Databases - The Ruby agent does not support experimental versions. Databases supported by the Ruby agent include: - - - - - - - - @@ -390,28 +327,22 @@ The Ruby agent does not support experimental versions. Databases supported by th - - - - - - - - - - - - -
Databases Supported Deprecated
ActiveRecord * 3.2.x * 4.0.x @@ -370,19 +310,16 @@ The Ruby agent does not support experimental versions. Databases supported by th * 6.1.x * 7.0.x * 3.0.x, 3.1.x: Last supported in agent version 6.15.0. * 2.1.x, 2.2.x, 2.3.x: Last supported agent was 3.18.1.330. * 2.0.x Last supported agent was 3.6.8.168.
DataMapper * ~~1.0~~ * 1.0.x: Last supported agent: 8.16.0.
Elasticsearch * 7.x * 8.x
Mongo * 1.8.x or higher - Deprecated * 1.9.x - Deprecated @@ -421,15 +352,12 @@ The Ruby agent does not support experimental versions. Databases supported by th * 2.3.x - Deprecated * 2.4.x or higher
Redis * 3.x * 4.0.x @@ -437,272 +365,213 @@ The Ruby agent does not support experimental versions. Databases supported by th * 4.2.x * 5.0.x
Sequel * 3.37.x - Deprecated * 4.0.x - Deprecated * 4.45.x or higher * 5.x.x
- ## Other APM software [#other-monitoring-software] - If your application uses other application performance monitoring (APM) software besides our agent, we cannot guarantee that our agent will work correctly and we cannot offer technical support. For more information, see [Errors when using other monitoring software](/docs/apm/new-relic-apm/troubleshooting/errors-while-using-new-relic-apm-alongside-other-apm-software). - ## Instance details [#instance_details] - New Relic collects [instance details for a variety of databases and database drivers](/docs/apm/applications-menu/features/analyze-database-instance-level-performance-issues). The ability to view specific instances and the types of database information in APM depends on your New Relic agent version. - New Relic's Ruby agent [version 3.17.0 or higher](/docs/release-notes/agent-release-notes/ruby-release-notes/ruby-agent-3170325) supports the following ORM databases: - - - - - - - - - - - - - - - - - - - - -
ORM Database Adapter name Minimum agent version
ActiveRecord 5 or higher [PostgreSQL](https://www.postgresql.org/) [pg](https://rubygems.org/gems/pg) 3.17.0
[MySQL](https://www.mysql.com/) [mysql2](https://rubygems.org/gems/mysql2) 3.17.0
ActiveRecord 2.1 to 4 [PostgreSQL](https://www.postgresql.org/) [pg](https://rubygems.org/gems/pg) 3.17.0
[MySQL](https://www.mysql.com/) [mysql](https://rubygems.org/gems/mysql) 3.17.0
[MySQL](https://www.mysql.com/) [mysql2](https://rubygems.org/gems/mysql2) 3.17.0
- The Ruby agent also supports these `gem` databases: - - - - - - - - - - - - - - - -
Gem database Gem name Minimum gem version Minimum agent version
[Memcached](https://memcached.org/) * [Dalli](https://rubygems.org/gems/dalli) * [memcached](https://rubygems.org/gems/memcached) * [memcache-client](https://rubygems.org/gems/memcache-client) * 2.7.6 * 1.8.0 * 1.5.0 3.17.0
[Mongo DB](https://www.mongodb.com/) [mongo](https://rubygems.org/gems/mongo) 1.8.6 3.17.0
[Redis](http://redis.io/) [redis-rb](https://rubygems.org/gems/redis) 3.0.7 3.17.0
- To request instance-level information from datastores currently not listed for your New Relic agent, get support at [support.newrelic.com](https://support.newrelic.com). - ## Background jobs [#background_jobs] - Background jobs supported by the New Relic Ruby agent include: - - - - - - - - - - - - - - -
Background jobs Supported Deprecated
Delayed_Job * 2.0.x - Deprecated * 3.0.x - Deprecated * 4.0.x - Deprecated * 4.1.x
Rake * 12.3.3 or higher * 13.x * 10.x * 11.x @@ -710,46 +579,37 @@ Background jobs supported by the New Relic Ruby agent include: NOTE: Only 12.3.3 or higher tested due to [exploit potential](https://hackerone.com/reports/651518) in earlier versions.
Resque * 1.23.x * 1.27.x * 2.0.0 or higher * 1.22.x and earlier
Sidekiq * 4.2.x - Deprecated * 5.x * 6.x * 7.0.x * 2.8.x, 3.4.x, 4.0.x, and 4.1.x: Last supported in agent version 6.15.0
- ## HTTP / network clients [#http_network_clients] - HTTP clients supported by the Ruby agent include: - * Curb: 0.8.1 or higher * Excon: 0.19.0 or higher (Versions lower than 0.55.0 are deprecated) * gRPC: 1.0.0 or higher @@ -757,22 +617,13 @@ HTTP clients supported by the Ruby agent include: * HttpRb: 0.9.9 or higher (Versions 0.9.9 - 2.2.1 are deprecated) * Net::HTTP: Supported for all [agent-supported versions](/docs/agents/ruby-agent/features/http-client-tracing-ruby) of Ruby. * Typhoeus: 0.5.3 or higher (Versions 0.5.3 - 1.2.x are deprecated) - ## Message queuing [#http_clients] - [Message queue instrumentation](/docs/agents/ruby-agent/features/message-queues) is only available with the [Ruby agent version 4.3.0 or higher](/docs/release-notes/agent-release-notes/ruby-release-notes). Currently supported message brokers: - * RabbitMQ - Currently supported gems that facilitate message brokers: - * [Bunny](/docs/agents/ruby-agent/features/message-queues): 2.0 or higher (Versions 2.0.x - 2.6.x are Deprecated) - - ## Other - APM's Ruby agent also supports: - * ActiveMerchant: 1.25.0 or higher (Versions 1.25.0 - 1.64.x are Deprecated) * Acts_as_Solr: Last supported in agent version 8.16.0 * authlogic: Last supported in agent version 8.16.0 @@ -780,53 +631,43 @@ APM's Ruby agent also supports: * Sunspot: Last supported in agent version 8.16.0 * Tilt: 2.x for Ruby 2.2 or higher; 1.x for Ruby 2.7 or lower * Yajl-Ruby: 1.1.0 or higher - ## Connect the agent to other parts of New Relic [#digital-intelligence-platform] - The Ruby agent integrates with other New Relic capabilities to give you end-to-end visibility. - - - - - - - - -
Capability Integration
[Browser monitoring](/docs/browser/new-relic-browser/getting-started/introduction-browser-monitoring) The Ruby agent automatically injects the browser JavaScript agent when you [enable auto-instrumentation](/docs/browser/new-relic-browser/installation/install-browser-monitoring-agent#select-apm-app). After enabling browser injection, you can view browser data in the [APM Summary page](/docs/apm/applications-menu/monitoring/apm-overview-page-view-transaction-apdex-usage-data) and quickly switch between the APM and browser data for a particular app. For configuration options and manual instrumentation, see the [browser and Ruby agent documentation](/docs/agents/ruby-agent/features/new-relic-browser-ruby-agent).
[Infrastructure monitoring](/docs/infrastructure/infrastructure-monitoring/get-started/get-started-infrastructure-monitoring) When you install the Infrastructure and APM agents on the same host, they automatically detect one another. You can then view a list of hosts in the APM UI, and filter your Infrastructure hosts by APM app in the Infrastructure UI. For more information, see [APM data in infrastructure monitoring](/docs/infrastructure/new-relic-infrastructure/data-instrumentation/new-relic-apm-data-infrastructure).
[Synthetic monitoring](/docs/synthetics/synthetic-monitoring/getting-started/get-started-new-relic-synthetic-monitoring) [Synthetic transaction traces](/docs/synthetics/synthetic-monitoring/using-monitors/collect-synthetic-transaction-traces) connect requests from synthetic monitors to the underlying APM transaction.
+ \ No newline at end of file