Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bin/ddprofrb #3501

Merged
merged 2 commits into from
Mar 4, 2024
Merged

Add bin/ddprofrb #3501

merged 2 commits into from
Mar 4, 2024

Conversation

delner
Copy link
Contributor

@delner delner commented Mar 1, 2024

What does this PR do?

This adds the bin/ddprofrb script, which is identical to the bin/ddtracerb script, which it intends to replace. It also prints a deprecation warning for any use of bin/ddtracerb.

Motivation:

The naming did not reflect the actual function of the bin. This better aligns it to its purpose.

Additional Notes:

We will remove bin/ddtracerb in the 2.0 release.

@delner delner added the profiling Involves Datadog profiling label Mar 1, 2024
@delner delner added this to the 1.21.0 milestone Mar 1, 2024
@delner delner self-assigned this Mar 1, 2024
@delner delner marked this pull request as ready for review March 1, 2024 21:36
@delner delner requested review from a team as code owners March 1, 2024 21:36
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.23%. Comparing base (f1f69d9) to head (fc77122).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3501      +/-   ##
==========================================
- Coverage   98.24%   98.23%   -0.01%     
==========================================
  Files        1275     1275              
  Lines       75182    75182              
  Branches     3551     3551              
==========================================
- Hits        73859    73858       -1     
- Misses       1323     1324       +1     

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

@delner delner added the dev/refactor Involves refactoring existing components label Mar 1, 2024
Copy link
Member

@ivoanjo ivoanjo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable! Only thing missing is ddtracerb not working due to the require_relative.

Also note to self: I'll need to update https://docs.datadoghq.com/profiler/enabling/ruby/?tab=environmentvariables#installation once this is merged.

bin/ddtracerb Outdated Show resolved Hide resolved
lib/datadog/profiling/tasks/help.rb Outdated Show resolved Hide resolved
Copy link
Member

@ivoanjo ivoanjo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM

ivoanjo added a commit to DataDog/documentation that referenced this pull request Mar 4, 2024
**What does this PR do?**

This PR updates the "Enabling the Ruby profiler" page to use the
`ddprofrb` command as a replacement for the `ddtracerb` command
that was deprecated in DataDog/dd-trace-rb#3501 .

The old command is still going to be kept around for a while longer,
and emits a deprecation warning when used.

**Motivation:**

Make sure customers onboard using the recommended instructions.
@ivoanjo
Copy link
Member

ivoanjo commented Mar 4, 2024

Docs update PR: DataDog/documentation#22037

@delner delner merged commit bc1196b into master Mar 4, 2024
218 of 219 checks passed
@delner delner deleted the feature/add_ddprofrb_bin branch March 4, 2024 19:50
brett0000FF pushed a commit to DataDog/documentation that referenced this pull request Mar 19, 2024
…#22037)

* Update "Enabling the Ruby profiler" to use the new `ddprofrb` command

**What does this PR do?**

This PR updates the "Enabling the Ruby profiler" page to use the
`ddprofrb` command as a replacement for the `ddtracerb` command
that was deprecated in DataDog/dd-trace-rb#3501 .

The old command is still going to be kept around for a while longer,
and emits a deprecation warning when used.

**Motivation:**

Make sure customers onboard using the recommended instructions.

* Apply suggestions from code review

Co-authored-by: cecilia saixue watt <cecilia.watt@datadoghq.com>

---------

Co-authored-by: cecilia saixue watt <cecilia.watt@datadoghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev/refactor Involves refactoring existing components profiling Involves Datadog profiling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants