[NO-TICKET] Clarify Ruby profiler SSI support #22110
Conversation
**What does this PR do?** This PR tweaks the Ruby profiler onboarding docs to mention that SSI on Kubernetes is supported, but on Linux host or VM and Docker, is not supported. This is inspired, but not the same as the instructions for onboarding the .NET profiler (see <https://docs.datadoghq.com/profiler/enabling/dotnet/?tab=linuxwithsinglestepinstrumentation#enabling-the-profiler>). **Motivation:** Clearly document state of SSI for Ruby.
ivoanjo
changed the title
Preview links (active after the
|
content/en/profiler/enabling/ruby.md
Outdated
|
|
||
| Continuous Profiler is not supported on serverless platforms, such as AWS Lambda. | ||
|
|
||
| [Single Step Instrumentation](https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/) for Kubernetes (using the Datadog Helm chart) is supported, but Single Step Instrumentation for Linux host or VM and Docker are not supported. You will still need to manually set the `DD_PROFILING_ENABLED=true` environment variable to enable profiling. |
There was a problem hiding this comment.
I'm not sure to understand: Linux host / VM+docker are not supported BUT it could work if DD_PROFILING_ENABLED=true?
Or these are definitively not supported BUT DD_PROFILING_ENABLED=true is needed for Kubernetes?
There was a problem hiding this comment.
I'm not sure to understand: Linux host / VM+docker are not supported BUT it could work if DD_PROFILING_ENABLED=true?
Or these are definitively not supported BUT DD_PROFILING_ENABLED=true is needed for Kubernetes?
Linux host/VM + docker never work AND kubernetes works if you additionally set DD_PROFILING_ENABLED. But clearly my text was confusing, so I've given another pass at it, let me know if you think it's clear now, or if it's still confusing.
|
Thanks @ivoanjo for opening up this PR! I'll put a |
|
@maycmlee from the profiling team side we're happy with this, ready to move forward :) |
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
|
Applied the suggestions, thanks for the review! |
|
Thanks, let us know in the documentation channel when this is ready to merge! |
|
This is ready to merge, please go ahead :D |
What does this PR do? What is the motivation?
This PR tweaks the Ruby profiler onboarding docs to mention that SSI on Kubernetes is supported, but on Linux host or VM and Docker, is not supported.
This is inspired, but not the same as the instructions for onboarding the .NET profiler (see
https://docs.datadoghq.com/profiler/enabling/dotnet/?tab=linuxwithsinglestepinstrumentation#enabling-the-profiler).
Merge instructions
I'm opening this PR first as a draft to discuss with the profiling team if this is how we want to document the current state with Ruby. I'll mark the PR ready for review once we decide we're happy with it.
Additional notes
N/A