Disable profiler on Ruby 3.3 due to incompatibility #3054
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**What does this PR do?**: In #3053 I reported the discovery that the profiler is currently not working on Ruby 3.3-head (reported by a customer that tests with head in CI). A full fix for #3053 seems like it may take a while, so until it's available, let's gracefully disable the profiler in Ruby 3.3, so that instead of a compilation failure, customers just get a nice message saying we don't support 3.3 right now. **Motivation**: Improve experience for current customers testing with 3.3-head and future customers trying to profile 3.3. **Additional Notes**: Customers will be shown the following message when trying to profile on Ruby 3.3: ``` WARN -- ddtrace: [ddtrace] Profiling was requested but is not supported, profiling disabled: Your ddtrace installation is missing support for the Continuous Profiler because the profiler in the current version of ddtrace does not yet support Ruby version 3.3. (See #3053 for details). Try upgrading to the latest ddtrace, as this issue may have been fixed by now. For help solving this issue, please contact Datadog support at <https://docs.datadoghq.com/help/>. You can also check out the Continuous Profiler troubleshooting page at <https://dtdg.co/ruby-profiler-troubleshooting>. ``` **How to test the change?**: Try to profile ruby-3.3 (any version) and confirm the profiler disables itself gracefully.
TonyCTHsu
approved these changes
Aug 17, 2023
ivoanjo
force-pushed
the
ivoanjo/disable-profiling-ruby3_3
branch
from
cd7069a to
21deae1
Compare
|
CircleCI seems to not be picking up the extra commits I added to this PR 😓... and triggering it manually gets me I'll wait for a few hours and see if they're able to recover. |
ivoanjo
force-pushed
the
ivoanjo/disable-profiling-ruby3_3
branch
from
21deae1 to
06c2ac6
Compare
This is slightly ugly, but we'll be able to remove it when we drop support for Ruby 2.1/2.2 and/or re-add support for Ruby 3.3.
ivoanjo
force-pushed
the
ivoanjo/disable-profiling-ruby3_3
branch
from
5296240 to
8b93b27
Compare
Sigh, trying to fix specs during meetings >_>
Codecov Report
@@ Coverage Diff @@
## master #3054 +/- ##
=======================================
Coverage 98.13% 98.13%
=======================================
Files 1328 1328
Lines 75039 75049 +10
Branches 3408 3411 +3
=======================================
+ Hits 73639 73651 +12
+ Misses 1400 1398 -2
... and 7 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
marcotc
approved these changes
Aug 17, 2023
|
After CircleCI went back up, I pushed a few small fixes for the integration apps (I had not disabled testing for profiler on 3.3 for those). Thanks Tony && Marco for the review, going ahead and merging! |
ivoanjo
added a commit
that referenced
this pull request
Sep 28, 2023
**What does this PR do?** Back in #3053, a customer reported that profiling was not working on ruby-head (for Ruby 3.3). At the time, I tracked it down to two issues: 1. A bunch of headers had changed, and thus we needed a new release of `debase-ruby_core_source` to include them 2. We were getting errors when loading the profiler due to the `ruby_current_ec` VM symbol no longer being available. At the time, I chose to disable profiling on Ruby 3.3 (#3054) until we could tackle these two items. Item 1. was fixed in #3163, that pulls in a new release of `debase-ruby_core_source` that includes the 3.3-preview2 headers. This PR fixes item 2. and re-enables profiling on Ruby 3.3 (and thus reverts #3054). **Motivation:** Make sure we're in good shape for the Ruby 3.3 final release in December. **Additional Notes:** We didn't use the magic `ruby_current_ec` VM symbol directly. Instead, we were using `GET_RACTOR()` and `GET_EC()` which call a few methods that are defined as `inline` in `vm_core.h`. Those methods all relied on `ruby_current_ec`, and thus hiding that symbol made them break. As an alternative, we can get to the same objects by starting with the current thread, and navigating the object graph a bit. The `rb_thread_current()` also relies on `ruby_current_ec` but crucially **is not inline** and is actually a public API of the VM, so that one kept working. I hesitated on if we should use `rb_thread_current()` on all Rubies with Ractors, or if we should keep the fast path for 3.0 to 3.2. I ended up deciding to keep the fast path since it was quite easy to do, but in the future we could instead choose to simplify this whole thing. P.s.: This is one of those PRs where a lot of work went into a handful of unimpressive lines of code 😅 . **How to test the change?** Validate that CI is passing on Ruby 3.3! Fixes #3053
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?:
In #3053 I reported the discovery that the profiler is currently not working on Ruby 3.3-head (reported by a customer that tests with head in CI).
A full fix for #3053 seems like it may take a while, so until it's available, let's gracefully disable the profiler in Ruby 3.3, so that instead of a compilation failure, customers just get a nice message saying we don't support 3.3 right now.
Motivation:
Improve experience for current customers testing with 3.3-head and future customers trying to profile 3.3.
Additional Notes:
Customers will be shown the following message when trying to profile on Ruby 3.3:
How to test the change?:
Try to profile ruby-3.3 (any version) and confirm the profiler disables itself gracefully.