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

[PROF-11394] Graduate heap profiling from alpha to preview #4401

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

ivoanjo
Copy link
Member

@ivoanjo ivoanjo commented Feb 18, 2025

What does this PR do?

This PR updates the documentation and logs to mark that the heap profiling feature is no longer alpha, and is now considered a preview feature.

We still very much welcome all feedback on this feature.

Motivation:

Graduate feature.

Change log entry

Yes. Graduate heap profiling from alpha to preview

Also, here's a snippet for the release highlights:

### Heap Profiling is now in Preview

The heap profiling feature is now in preview. With this release, we've done extensive performance improvements and improved data accuracy.

This feature requires Ruby 3.1+. You can enable it by using the `DD_PROFILING_EXPERIMENTAL_HEAP_ENABLED=true` environment variable, or via code:

```ruby
Datadog.configure do |c|
  # ... existing configuration ...
  c.profiling.advanced.experimental_heap_enabled = true
end
```

(Note that this feature requires that allocation profiling is also enabled. To do so, set `DD_PROFILING_ALLOCATION_ENABLED=true` or `c.profiling.allocation_enabled = true` via code).

Additional Notes:

N/A

How to test the change?

This change includes test coverage.

**What does this PR do?**

This PR updates the documentation and logs to mark that the heap
profiling feature is no longer alpha, and is now considered a preview
feature.

We still very much welcome all feedback on this feature.

**Motivation:**

Graduate feature.

**Change log entry**

Yes. Graduate heap profiling from alpha to preview

Also, here's a snippet for the release highlights:

```markdown
 ### Heap Profiling is now in Preview

The heap profiling feature is now in preview. With this release, we've
done extensive performance improvements and improved data accuracy.

You can enable this feature by using the `DD_PROFILING_EXPERIMENTAL_HEAP_ENABLED=true` environment variable, or via code:

```ruby
Datadog.configure do |c|
  # ... existing configuration ...
  c.profiling.advanced.experimental_heap_size_enabled = true
end
```

(Note that this feature requires that allocation profiling is
also enabled. To do so, set `DD_PROFILING_ALLOCATION_ENABLED=true`
or `c.profiling.allocation_enabled = true` via code).
```

**Additional Notes:**

N/A

**How to test the change?**

This change includes test coverage.
@ivoanjo ivoanjo requested review from a team as code owners February 18, 2025 16:20
@ivoanjo ivoanjo added the profiling Involves Datadog profiling label Feb 18, 2025
@github-actions github-actions bot added the core Involves Datadog core libraries label Feb 18, 2025
@ivoanjo ivoanjo requested a review from AlexJF February 18, 2025 16:21
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.71%. Comparing base (c6d1822) to head (83e52b7).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4401      +/-   ##
==========================================
+ Coverage   97.70%   97.71%   +0.01%     
==========================================
  Files        1361     1361              
  Lines       83239    83240       +1     
  Branches     4226     4227       +1     
==========================================
+ Hits        81329    81340      +11     
+ Misses       1910     1900      -10     

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

@datadog-datadog-prod-us1
Copy link
Contributor

Datadog Report

Branch report: ivoanjo/prof-11394-heap-profiler-preview
Commit report: 83e52b7
Test service: dd-trace-rb

✅ 0 Failed, 20590 Passed, 1373 Skipped, 3m 18.11s Total Time

ivoanjo added a commit to DataDog/documentation that referenced this pull request Feb 18, 2025
This PR updates the documentation to reflect that heap profiling is
now in preview for Ruby.

Furthermore:
1. I've corrected the docs to point out that the default for heap size
   enabled is to follow heap size, not disabled.
2. I've done a pass on the Ruby docs to bump some of the minimum
   recommended versions and versions shown in examples.

The change on the Ruby side is in
DataDog/dd-trace-rb#4401 .
@ivoanjo ivoanjo merged commit 6f63c6d into master Feb 18, 2025
489 checks passed
@ivoanjo ivoanjo deleted the ivoanjo/prof-11394-heap-profiler-preview branch February 18, 2025 16:52
@github-actions github-actions bot added this to the 2.11.0 milestone Feb 18, 2025
@ivoanjo ivoanjo removed the core Involves Datadog core libraries label Feb 19, 2025
ivoanjo added a commit that referenced this pull request Feb 19, 2025
…-profiler-preview"

This reverts commit 6f63c6d, reversing
changes made to 5e20f11.
ivoanjo added a commit that referenced this pull request Feb 19, 2025
…profiling

[PROF-11394] Revert changes to heap profiling in PRs #4401, #4376, #4331
ivoanjo added a commit that referenced this pull request Mar 5, 2025
…ap-profiler-preview"

This reverts commit 32ded2e, thus
re-applying the changes from #4401.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
profiling Involves Datadog profiling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants