diff --git a/content/en/profiler/enabling/ruby.md b/content/en/profiler/enabling/ruby.md index 75cb83bb6fe22..5db532bf39cae 100644 --- a/content/en/profiler/enabling/ruby.md +++ b/content/en/profiler/enabling/ruby.md @@ -122,6 +122,7 @@ You can configure the profiler using the following environment variables: | `DD_PROFILING_EXPERIMENTAL_HEAP_ENABLED` | Boolean | Set to `true` to enable heap live objects profiling. It requires that allocation profiling is enabled as well. Defaults to `false`. | | `DD_PROFILING_EXPERIMENTAL_HEAP_SIZE_ENABLED` | Boolean | Set to `true` to enable heap live size profiling. It requires that heap live objects profiling is enabled as well. Defaults to `false`. | | `DD_PROFILING_NO_SIGNALS_WORKAROUND_ENABLED` | Boolean | Automatically enabled when needed, can be used to force enable or disable this feature. See [Profiler Troubleshooting][15] for details. | +| `DD_PROFILING_PREVIEW_GVL_ENABLED` | Boolean | Set to `true` to enable Global VM Lock (GVL) profiling. It requires the profiler to be enabled already and Ruby 3.2+. Defaults to `false`. | | `DD_PROFILING_PREVIEW_OTEL_CONTEXT_ENABLED` | String | Set to `only` when using profiling directly with `opentelemetry-sdk`, or `true` for auto-detection of the correct context to read from. Defaults to `false`. | | `DD_ENV` | String | The [environment][10] name, for example: `production`. | | `DD_SERVICE` | String | The [service][10] name, for example, `web-backend`. | @@ -137,6 +138,7 @@ Alternatively, you can set profiler parameters in code with these functions, ins | `c.profiling.advanced.experimental_heap_enabled` | Boolean | Set to `true` to enable heap live objects profiling. It requires that allocation profiling is enabled as well. Defaults to `false`. | | `c.profiling.advanced.experimental_heap_size_enabled` | Boolean | Set to `true` to enable heap live size profiling. It requires that heap live objects profiling is enabled as well. Defaults to `false`. | | `c.profiling.advanced.no_signals_workaround_enabled` | Boolean | Automatically enabled when needed, can be used to force enable or disable this feature. See [Profiler Troubleshooting][15] for details. | +| `c.profiling.advanced.preview_gvl_enabled` | Boolean | Set to `true` to enable Global VM Lock (GVL) profiling. It requires the profiler to be enabled already and Ruby 3.2+. Defaults to `false`. | | `c.profiling.advanced.preview_otel_context_enabled` | String | Set to `only` when using profiling directly with `opentelemetry-sdk`, or `true` for auto-detection of the correct context to read from. Defaults to `false`. | | `c.env` | String | The [environment][10] name, for example: `production`. | | `c.service` | String | The [service][10] name, for example, `web-backend`. | diff --git a/content/en/profiler/enabling/supported_versions.md b/content/en/profiler/enabling/supported_versions.md index a5fb1d2a581ba..3573809772353 100644 --- a/content/en/profiler/enabling/supported_versions.md +++ b/content/en/profiler/enabling/supported_versions.md @@ -21,7 +21,7 @@ To use the Datadog Profiler, use at least the minimum versions summarized in the | | [Java][1] | [Python][2] | [Go][3] | [Ruby][4] | [Node.js][5] | [.NET][6] | [PHP][7] | [Rust/C/C++][8] | |-----------------------------------|:------------:|:----------------:|:-------------:|:--------------:|:-------------:|:-----------------------------------------------------------------------:|:-------------:|:---------------:| | Minimum runtime version | [JDK 8+][17] | Python 2.7+ | Go 1.19+ | Ruby 2.5+ | Node 14+ | .NET Core 2.1+, .NET 5+, .NET Framework 4.6.1+ | PHP 7.1+ | | -| Feature-complete runtime version | [JDK 11+][17] | Python 3.6+ | Go 1.21+ | Ruby 3.1+ | Node 18+ | .NET 7+ | PHP 8.0+ | | +| Feature-complete runtime version | [JDK 11+][17] | Python 3.6+ | Go 1.21+ | Ruby 3.2+ | Node 18+ | .NET 7+ | PHP 8.0+ | | | Feature-complete tracing library version | [latest][9] | [latest][10] | [latest][11] | [latest][12] | [latest][13] | [latest][14] | [latest][15] | [latest][16] | ## Profile types @@ -47,7 +47,7 @@ To access additional profiling features, use at least the minimum versions summa |-----------------------------------|:-------:|:-------:|:------------:|:------:|:---------:|:-------:|:------:|:----------:| | {{< ci-details title="Trace to Profiling integration" >}}Find specific lines of code related to performance issues. Learn more{{< /ci-details >}} | [JDK 8+][17] | tracer 2.12.0,
2.11.4, 2.10.7 | tracer 1.51.0 | tracer 1.21.1 | tracer 5.11.0,
4.35.0, 3.56.0 | tracer 2.30.0 | tracer 2.30.0 | | | {{< ci-details title="Endpoint Profiling" >}}Identify endpoints that are bottlenecks or responsible for heavy resource consumption. Learn more{{< /ci-details >}} | [JDK 8+][17] | tracer 0.54.0 | tracer 1.37.0 | tracer 0.52.0 | tracer 5.0.0,
4.24.0, 3.45.0 | tracer 2.15.0 | tracer 0.79.0 | | -| {{< ci-details title="Timeline View" >}}Surface time-based patterns and work distribution over the period of a span. Learn more{{< /ci-details >}} | [JDK 8+][17] | tracer 2.12.0,
2.11.4, 2.10.7 | tracer 1.51.0 | tracer 1.21.1 | tracer 5.11.0,
4.35.0, 3.56.0 | tracer 2.30.0 | tracer 0.89.0 | | +| {{< ci-details title="Timeline View" >}}Surface time-based patterns and work distribution over the period of a span. Learn more{{< /ci-details >}} | [JDK 8+][17] | tracer 2.12.0,
2.11.4, 2.10.7 | tracer 1.51.0 | tracer 1.21.1
(2.4.0 for GVL profiling) | tracer 5.11.0,
4.35.0, 3.56.0 | tracer 2.30.0 | tracer 0.89.0 | | ## Further reading diff --git a/content/en/profiler/profile_types.md b/content/en/profiler/profile_types.md index 3071da88a1440..e1ced505c948e 100644 --- a/content/en/profiler/profile_types.md +++ b/content/en/profiler/profile_types.md @@ -168,6 +168,10 @@ Heap Live Size (alpha, v2.3.0+) : 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.
_Requires: Ruby 3.1+_ and [manual enablement][2] +GVL profiling (in Timeline) (preview, v2.4.0+) +: Records time when threads are prevented from working by other "noisy neighbor" threads, including background threads. This is useful for investigating latency spikes in the application when using the timeline visualization.
+_Requires: Ruby 3.2+_ and [manual enablement][2] + [1]: /profiler/enabling/ruby/#requirements [2]: /profiler/enabling/ruby/#configuration {{< /programming-lang >}}