2.0 Upgrade guide #3467

TonyCTHsu · 2024-02-20T22:11:04Z

Upgrade Guide for 2.0

codecov-commenter · 2024-02-23T10:15:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.07%. Comparing base (5cb48c5) to head (494a667).
Report is 328 commits behind head on 2.0.

Additional details and impacted files

@@            Coverage Diff             @@
##              2.0    #3467      +/-   ##
==========================================
- Coverage   98.13%   98.07%   -0.06%     
==========================================
  Files        1249     1237      -12     
  Lines       72086    72256     +170     
  Branches     3372     3411      +39     
==========================================
+ Hits        70741    70868     +127     
- Misses       1345     1388      +43

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pr-commenter · 2024-02-27T11:05:44Z

Benchmarks

Benchmark execution time: 2024-02-27 13:00:39

Comparing candidate commit 0705a03 in PR branch tonycthsu/2.0-upgrade-guide with baseline commit d24fd06 in branch 2.0.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 7 metrics, 1 unstable metrics.

docs/UpgradeGuide2.md

ekump · 2024-03-06T16:59:50Z

docs/UpgradeGuide2.md

+| ------------------------------ | ------------------------------------ |
+| `DD_PROPAGATION_STYLE_INJECT`  | `DD_TRACE_PROPAGATION_STYLE_INJECT`  |
+| `DD_PROPAGATION_STYLE_EXTRACT` | `DD_TRACE_PROPAGATION_STYLE_EXTRACT` |
+


Perhaps it is my own ignorance on the topic, so feel free to ignore but it isn't clear to me why values becoming case-insensitive means the values mapped to different b3 strategies also changed? Since the values are case-insensitive, it isn't necessary to change existing ones?

docs/UpgradeGuide2.md

ekump

Some grammar suggestions, but LGTM.

ivoanjo

Thanks for working on this! I've left a bunch of notes. In general, I think the language of the doc would benefit from a pass of thinking "what does a customer upgrading need, and how should we convey that information".

Even as someone that works on the codebase, I had difficulty following some of the things being described -- they're a bit too terse for someone that doesn't live and breathe tracing ;)

docs/UpgradeGuide2.md

ivoanjo · 2024-03-06T17:23:58Z

docs/UpgradeGuide2.md

+    | `2.1.x` | `>= 2.1.11, < 2.2` |
+    | `2.0.x` | `>= 2.0.28, < 2.1` |
+    | `1.13.x` | `>= 1.13.21, < 2.0` |
+  - Do **NOT** support or patch defined-based schema.


What does this mean exactly?

docs/UpgradeGuide2.md

ivoanjo · 2024-03-06T17:27:00Z

docs/UpgradeGuide2.md

+
+<h4 id='2.0-instrumentation-rack'>Rack</h4>
+
+- The type for `request_queuing` option is `Boolean`. When enabled, the behaviour changes from 1 span to 2 spans. The original `http_server.queue` span rename to `http.proxy.request`, with an additional `http.proxy.queue` span representing the time spent in a load balancer queue before reaching application.


I think this needs clarification -- even for me it's a bit confusing, and I've been around the codebase for a while.

ivoanjo · 2024-03-06T17:27:33Z

docs/UpgradeGuide2.md

+  Changing the name of the top-level span (`http_server.queue` -> `http.proxy.request`) would break a lot of stuff (monitors, dashboards, notebooks). The following snippet rename the top-level span back to help migration.
+
+  ```ruby
+  Datadog::Tracing.before_flush(
+    Datadog::Tracing::Pipeline::SpanProcessor.new do |span|
+      if span.name == 'http.proxy.request'
+        span.name = 'http_server.queue'
+      end
+    end
+  )
+  ```


I don't think it's clear what we're trying to warn customers/get across here.

Co-authored-by: Edmund Kump <[email protected]>

Co-authored-by: Ivo Anjo <[email protected]>

ivoanjo

Did an extra pass on profiling things :)

ivoanjo · 2024-03-07T09:21:10Z

docs/UpgradeGuide2.md

+- [Requires Ruby 2.5+](#2.0-requires-ruby-2.5+)
+- [Extracts datadog-ci gem](#2.0-extracts-ci)
+- [Configuration changes](#2.0-configuration-changes)
+  - [Replace `use` with `instrument`](#2.0-use-instrument)
+  - [Type checking](#2.0-type-checking)
+  - [Propagation default](#2.0-propagation-default)
+  - [Options](#2.0-options)


I believe the change in #3506 should be included in this list, as it will break a lot of customers running profiling

I would like to add the datadog rename afterward.

docs/UpgradeGuide2.md

maycmlee

👍 for docs.

By the way, I noticed that at the end of the Racecar section there's an extra character that doesn't seem to belong there.

Co-authored-by: Ivo Anjo <[email protected]>

github-actions bot added the docs Involves documentation label Feb 20, 2024

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch 2 times, most recently from 964cf52 to 6deb980 Compare February 26, 2024 14:58

TonyCTHsu added 4 commits February 27, 2024 11:58

Initial draft for Upgrade guide 2.0

1b87aa1

Basic section

5dd03a7

Advanced section

bcc8ab3

GraphQL changes

79cdd56

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch from 6deb980 to 79cdd56 Compare February 27, 2024 11:00

B3

0705a03

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch from a36b138 to 0705a03 Compare February 27, 2024 12:56

TonyCTHsu added 3 commits February 28, 2024 14:12

Remove keep! changes

9708239

Merge branch '2.0' into tonycthsu/2.0-upgrade-guide

302a101

Propagation and lowercase

674beb6

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch from 8c8ccd0 to 674beb6 Compare February 28, 2024 13:47

TonyCTHsu added 2 commits February 28, 2024 21:39

Update

21f1cde

Bullet

27c7cf2

github-actions bot added core Involves Datadog core libraries integrations Involves tracing integrations tracing and removed docs Involves documentation core Involves Datadog core libraries labels Feb 29, 2024

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch from 278ce83 to 2ae288d Compare February 29, 2024 10:15

github-actions bot added docs Involves documentation and removed tracing integrations Involves tracing integrations labels Feb 29, 2024

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch from 2ae288d to c0bcfcc Compare February 29, 2024 10:34

Cleanup comments and link

061cdbd

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch from c0bcfcc to 061cdbd Compare February 29, 2024 10:47

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump reviewed Mar 6, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

ekump approved these changes Mar 6, 2024

View reviewed changes

ivoanjo reviewed Mar 6, 2024

View reviewed changes

TonyCTHsu and others added 9 commits March 6, 2024 21:03

Update docs/UpgradeGuide2.md

ee7e82a

Co-authored-by: Edmund Kump <[email protected]>

Update docs/UpgradeGuide2.md

6f95db4

Co-authored-by: Edmund Kump <[email protected]>

Update docs/UpgradeGuide2.md

8017482

Co-authored-by: Edmund Kump <[email protected]>

Update docs/UpgradeGuide2.md

4260568

Co-authored-by: Edmund Kump <[email protected]>

Update docs/UpgradeGuide2.md

ca76916

Co-authored-by: Edmund Kump <[email protected]>

Update docs/UpgradeGuide2.md

2c469ee

Co-authored-by: Edmund Kump <[email protected]>

Update docs/UpgradeGuide2.md

494a667

Co-authored-by: Ivo Anjo <[email protected]>

tpply most comment suggestions

43e2e3a

Rewrite rack changes

6b0bfb2

ivoanjo reviewed Mar 7, 2024

View reviewed changes

anmarchenko reviewed Mar 7, 2024

View reviewed changes

docs/UpgradeGuide2.md Outdated Show resolved Hide resolved

maycmlee approved these changes Mar 7, 2024

View reviewed changes

TonyCTHsu and others added 3 commits March 7, 2024 16:20

Merge branch '2.0' into tonycthsu/2.0-upgrade-guide

e7ce757

Update docs/UpgradeGuide2.md

456af11

Co-authored-by: Ivo Anjo <[email protected]>

Some minor changes

7699226

TonyCTHsu force-pushed the tonycthsu/2.0-upgrade-guide branch from e301b43 to 7699226 Compare March 7, 2024 15:33

TonyCTHsu merged commit 81f5976 into 2.0 Mar 7, 2024
59 of 64 checks passed

TonyCTHsu deleted the tonycthsu/2.0-upgrade-guide branch March 7, 2024 15:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2.0 Upgrade guide #3467

2.0 Upgrade guide #3467

TonyCTHsu commented Feb 20, 2024 •

edited

Loading

codecov-commenter commented Feb 23, 2024 •

edited

Loading

pr-commenter bot commented Feb 27, 2024 •

edited

Loading

ekump Mar 6, 2024

ekump left a comment

ivoanjo left a comment

ivoanjo Mar 6, 2024

ivoanjo Mar 6, 2024

ivoanjo Mar 6, 2024

ivoanjo left a comment

ivoanjo Mar 7, 2024

TonyCTHsu Mar 7, 2024

maycmlee left a comment


		<h4 id='2.0-instrumentation-rack'>Rack</h4>

		- The type for `request_queuing` option is `Boolean`. When enabled, the behaviour changes from 1 span to 2 spans. The original `http_server.queue` span rename to `http.proxy.request`, with an additional `http.proxy.queue` span representing the time spent in a load balancer queue before reaching application.

2.0 Upgrade guide #3467

2.0 Upgrade guide #3467

Conversation

TonyCTHsu commented Feb 20, 2024 • edited Loading

codecov-commenter commented Feb 23, 2024 • edited Loading

Codecov Report

pr-commenter bot commented Feb 27, 2024 • edited Loading

Benchmarks

ekump Mar 6, 2024

Choose a reason for hiding this comment

ekump left a comment

Choose a reason for hiding this comment

ivoanjo left a comment

Choose a reason for hiding this comment

ivoanjo Mar 6, 2024

Choose a reason for hiding this comment

ivoanjo Mar 6, 2024

Choose a reason for hiding this comment

ivoanjo Mar 6, 2024

Choose a reason for hiding this comment

ivoanjo left a comment

Choose a reason for hiding this comment

ivoanjo Mar 7, 2024

Choose a reason for hiding this comment

TonyCTHsu Mar 7, 2024

Choose a reason for hiding this comment

maycmlee left a comment

Choose a reason for hiding this comment

TonyCTHsu commented Feb 20, 2024 •

edited

Loading

codecov-commenter commented Feb 23, 2024 •

edited

Loading

pr-commenter bot commented Feb 27, 2024 •

edited

Loading