Skip to content

Commit

Permalink
Merge pull request #3584 from DataDog/tonycthsu/gem-rename-doc
Browse files Browse the repository at this point in the history
Gem rename upgrade guide
  • Loading branch information
TonyCTHsu authored Apr 17, 2024
2 parents 7845340 + 0246bde commit 7c46b99
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions docs/UpgradeGuide2.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -40,18 +41,33 @@ Outlines the changes for our instrumentations.

<h2 id="2.0-basic-usage">Basic Usage</h2>

<h3 id="2.0-gem-rename">Rename to `datadog` gem</h3>

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 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:

```ruby
# === Before ===
gem 'ddtrace', '~> 1.0', require: 'ddtrace/auto_instrument'

# === After rename to `datadog` with 2.x ===
gem 'datadog', '~> 2.0', require: 'datadog/auto_instrument'
```

<h3 id="2.0-requires-ruby-2.5+">Requires Ruby 2.5+</h3>

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](Compatibility.md#support-policy).

<h3 id="2.0-extracts-ci">Extracts datadog-ci gem</h3>

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 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 'ddtrace', '>= 2'
gem 'datadog', '>= 2'

group :test do
gem 'datadog-ci'
Expand Down

0 comments on commit 7c46b99

Please sign in to comment.