From b9052d41edd3f6309f6e2308184b824ce2de6118 Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Thu, 11 Apr 2024 15:51:15 +0200 Subject: [PATCH 1/4] Rename gem upgrade guide --- docs/UpgradeGuide2.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/UpgradeGuide2.md b/docs/UpgradeGuide2.md index cecfbdd944..a9664b3aa4 100644 --- a/docs/UpgradeGuide2.md +++ b/docs/UpgradeGuide2.md @@ -1,11 +1,12 @@ -# Upgrading ddtrace from 1.x to 2.0 +# Upgrading from 1.x to 2.0 -Upgrading `ddtrace` from 1.x to 2.0 introduces some breaking changes which are outlined below. +Upgrading from 1.x to 2.0 introduces some breaking changes which are outlined below. [**Basic Usage**](#2.0-basic-usage) In most cases, (e.g. when you use out-of-the-box instrumentation and a configuration file) only minor changes to your current setup are needed: most applications take just minutes to update. +- [Renaming the Gem](#2.0-gem-rename) - [Requires Ruby 2.5+](#2.0-requires-ruby-2.5+) - [Extracts datadog-ci gem](#2.0-extracts-ci) - [Configuration changes](#2.0-configuration-changes) @@ -40,18 +41,32 @@ Outlines the changes for our instrumentations.

Basic Usage

+

Rename to `datadog` gem

+ +Historically, gem `ddtrace` started as Datadog's tracing product, nowadays, several products are harhored together in this gem. To better reflect its intention, the gem is renamed to `datadog`. + +Make sure to update Gemfile: + +```ruby +# === This is a shim to help migrating to the new `datadog` gem === +gem 'ddtrace', '~> 2.0', require: 'ddtrace/auto_instrument' + +# === Rename to `datadog` with 2.x === +gem 'datadog', '~> 2.0', require: 'datadog/auto_instrument' +``` +

Requires Ruby 2.5+

-The minimum Ruby version requirement for ddtrace 2.x is 2.5.0. For prior Ruby versions, you can use ddtrace 1.x. see more with our support policy. +The minimum Ruby version requirement is 2.5.0. For prior Ruby versions, you can use `ddtrace` 1.x. see more with our support policy.

Extracts datadog-ci gem

-The CI visibility component has been extracted as a separate gem named [datadog-ci](https://github.com/DataDog/datadog-ci-rb), and will no longer be installed together with ddtrace. +The CI visibility component has been extracted as a separate gem named [datadog-ci](https://github.com/DataDog/datadog-ci-rb), and will no longer be installed. If you are using our CI visibility product, include `datadog-ci` in your Gemfile and learn more about the [setup](https://github.com/DataDog/datadog-ci-rb). ```ruby -gem 'ddtrace', '>= 2' +gem 'datadog', '>= 2' group :test do gem 'datadog-ci' From 8a4caf28b828c76ce39cfb3c9716f220356bbe24 Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Thu, 11 Apr 2024 17:41:29 +0200 Subject: [PATCH 2/4] Update as commented --- docs/UpgradeGuide2.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/UpgradeGuide2.md b/docs/UpgradeGuide2.md index a9664b3aa4..384e283837 100644 --- a/docs/UpgradeGuide2.md +++ b/docs/UpgradeGuide2.md @@ -43,7 +43,9 @@ Outlines the changes for our instrumentations.

Rename to `datadog` gem

-Historically, gem `ddtrace` started as Datadog's tracing product, nowadays, several products are harhored together in this gem. To better reflect its intention, the gem is renamed to `datadog`. +The gem now includes new capabilities (Profiling, Application Security Monitoring) that extend beyond tracing. To better reflect the broad set of features already within this package, and our intention for this package to be an all-inclusive offering, the existing gem has been renamed to `datadog`. + +This name change is does not reflect any material change to existing capabilities in 2.0, but future 2.x versions may include additional capabilities or products. Make sure to update Gemfile: @@ -57,13 +59,12 @@ gem 'datadog', '~> 2.0', require: 'datadog/auto_instrument'

Requires Ruby 2.5+

-The minimum Ruby version requirement is 2.5.0. For prior Ruby versions, you can use `ddtrace` 1.x. see more with our support policy. +The minimum Ruby version requirement is 2.5.0. For prior Ruby versions, you can use `ddtrace` 1.x. see more with our [support policy](Compatibility.md#support-policy).

Extracts datadog-ci gem

-The CI visibility component has been extracted as a separate gem named [datadog-ci](https://github.com/DataDog/datadog-ci-rb), and will no longer be installed. +The CI visibility component has been extracted as a separate gem named [datadog-ci](https://github.com/DataDog/datadog-ci-rb), and will no longer be installed. If you would like to use the CI Visibility product, you can include the additional `datadog-ci` gem into your Gemfile. Learn more about [setting up `datadog-ci`](https://github.com/DataDog/datadog-ci-rb). -If you are using our CI visibility product, include `datadog-ci` in your Gemfile and learn more about the [setup](https://github.com/DataDog/datadog-ci-rb). ```ruby gem 'datadog', '>= 2' From 606c03fd786d3a21447cffd5397af26eea10429a Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Wed, 17 Apr 2024 14:12:08 +0200 Subject: [PATCH 3/4] Update example --- docs/UpgradeGuide2.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UpgradeGuide2.md b/docs/UpgradeGuide2.md index 384e283837..99cd63c4f0 100644 --- a/docs/UpgradeGuide2.md +++ b/docs/UpgradeGuide2.md @@ -50,10 +50,10 @@ This name change is does not reflect any material change to existing capabilitie Make sure to update Gemfile: ```ruby -# === This is a shim to help migrating to the new `datadog` gem === -gem 'ddtrace', '~> 2.0', require: 'ddtrace/auto_instrument' +# === Before === +gem 'ddtrace', '~> 1.0', require: 'ddtrace/auto_instrument' -# === Rename to `datadog` with 2.x === +# === After rename to `datadog` with 2.x === gem 'datadog', '~> 2.0', require: 'datadog/auto_instrument' ``` From 0246bde6970b945d552fcda652d53d3c96ad06e2 Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Wed, 17 Apr 2024 15:17:21 +0200 Subject: [PATCH 4/4] Fix typo --- docs/UpgradeGuide2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UpgradeGuide2.md b/docs/UpgradeGuide2.md index 99cd63c4f0..ff5359437b 100644 --- a/docs/UpgradeGuide2.md +++ b/docs/UpgradeGuide2.md @@ -45,7 +45,7 @@ Outlines the changes for our instrumentations. The gem now includes new capabilities (Profiling, Application Security Monitoring) that extend beyond tracing. To better reflect the broad set of features already within this package, and our intention for this package to be an all-inclusive offering, the existing gem has been renamed to `datadog`. -This name change is does not reflect any material change to existing capabilities in 2.0, but future 2.x versions may include additional capabilities or products. +This name change does not reflect any material change to existing capabilities in 2.0, but future 2.x versions may include additional capabilities or products. Make sure to update Gemfile: