Skip to content

Commit dfff4d1

Browse files
committed
[PROF-10978] Bump minimum Ruby version for heap profiling
Due to a Ruby VM bug in older Ruby versions, we're going to require Ruby 3.1+ as a minimum version for heap profiling, as per DataDog/dd-trace-rb#4178 . This PR updates the docs to match this raised requirement.
1 parent 8070cb0 commit dfff4d1

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

content/en/profiler/enabling/supported_versions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To collect profile types, use at least the minimum versions summarized in the fo
3333
| {{< ci-details title="CPU" >}}The time each function/method spent running on the CPU.{{< /ci-details >}} | [JDK&nbsp;8+][17] | tracer&nbsp;0.35+ | tracer&nbsp;1.23+ | tracer&nbsp;0.48+ | tracer&nbsp;5.11.0,<br>4.35.0, 3.56.0 | tracer&nbsp;2.15+ | tracer&nbsp;0.71+ | Preview<br>ddprof&nbsp;0.1+ |
3434
| {{< ci-details title="Exceptions" >}}The number of exceptions raised, including those caught.{{< /ci-details >}} | [JDK&nbsp;8+][17] | Python 3.7+ | | | | .NET 5+<br>tracer&nbsp;2.31+ | tracer&nbsp;0.96+ | |
3535
| {{< ci-details title="Allocation" >}}Number and sizes of memory allocations made by each function/method, including allocations which were subsequently freed.{{< /ci-details >}} | [JDK&nbsp;11+][17] | Python 3.6+<br>tracer&nbsp;0.50+ | tracer&nbsp;1.47+ | tracer 2.3.0+ | | Preview<br>.NET 6+ and .NET Framework beta (requires Datadog Agent 7.51+ and tracer 3.2+)<br>tracer&nbsp;2.18+ | tracer&nbsp;0.88+ | Preview<br>ddprof&nbsp;0.9.3 |
36-
| {{< ci-details title="Heap" >}}The amount of heap memory allocated that remains in use.{{< /ci-details >}} | [JDK&nbsp;11+][17]<br>tracer&nbsp;1.39.0+ | Python 3.6+<br> tracer&nbsp;0.50+ | tracer&nbsp;1.23+ | alpha<br>Ruby 2.7+<br>tracer&nbsp;2.3.0+ | tracer&nbsp;0.23+ | beta<br>.NET 7+<br>tracer&nbsp;2.22+ | | Preview<br>ddprof&nbsp;0.15+ |
36+
| {{< ci-details title="Heap" >}}The amount of heap memory allocated that remains in use.{{< /ci-details >}} | [JDK&nbsp;11+][17]<br>tracer&nbsp;1.39.0+ | Python 3.6+<br> tracer&nbsp;0.50+ | tracer&nbsp;1.23+ | alpha<br>Ruby 3.1+<br>tracer&nbsp;2.3.0+ | tracer&nbsp;0.23+ | beta<br>.NET 7+<br>tracer&nbsp;2.22+ | | Preview<br>ddprof&nbsp;0.15+ |
3737
| {{< ci-details title="Wall time" >}}The elapsed time spent in each function/method. Elapsed time includes time when code is running on CPU, waiting for I/O, and anything else that happens while the function/method is running.{{< /ci-details >}} | [JDK&nbsp;8+][17] | tracer&nbsp;0.35+ | | tracer&nbsp;0.48+ | tracer&nbsp;0.23+ | tracer&nbsp;2.7+ | tracer&nbsp;0.71+ | |
3838
| {{< ci-details title="Locks" >}}The time each function/method spent waiting for and holding locks, and the number of times each function acquired a lock.{{< /ci-details >}} | [JDK&nbsp;8+][17] | tracer&nbsp;0.45+ | tracer&nbsp;1.47+ | | | .NET 5+ and .NET Framework beta (requires Datadog Agent 7.51+)<br>tracer&nbsp;2.49+ | | |
3939
| {{< ci-details title="I/O" >}}The time each method spent reading from and writing to files and sockets.{{< /ci-details >}} | [JDK&nbsp;8+][17] | | | | | | | |

content/en/profiler/profile_types.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -162,11 +162,11 @@ _Requires:_ [Manual enablement][2]
162162

163163
Heap Live Objects (alpha, v2.3.0+)
164164
: The number of objects allocated by each method in heap memory that have not yet been garbage collected. This is useful for investigating the overall memory usage of your service and identifying potential memory leaks.<br />
165-
_Requires: Ruby 2.7+_ and [manual enablement][2]
165+
_Requires: Ruby 3.1+_ and [manual enablement][2]
166166

167167
Heap Live Size (alpha, v2.3.0+)
168168
: The amount of heap memory allocated by each method that has not yet been garbage collected. This is useful for investigating the overall memory usage of your service and identifying potential memory leaks.<br />
169-
_Requires: Ruby 2.7+_ and [manual enablement][2]
169+
_Requires: Ruby 3.1+_ and [manual enablement][2]
170170

171171
[1]: /profiler/enabling/ruby/#requirements
172172
[2]: /profiler/enabling/ruby/#configuration

0 commit comments

Comments
 (0)