From 84c295c412f12f6f8f5d57459632cd9f62c42b55 Mon Sep 17 00:00:00 2001 From: Ivo Anjo Date: Thu, 7 Mar 2024 14:19:30 +0000 Subject: [PATCH 1/3] Clarify Ruby profiler SSI support **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 ). **Motivation:** Clearly document state of SSI for Ruby. --- content/en/profiler/enabling/ruby.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/profiler/enabling/ruby.md b/content/en/profiler/enabling/ruby.md index 238a7f00783ce..92cb63dd2017b 100644 --- a/content/en/profiler/enabling/ruby.md +++ b/content/en/profiler/enabling/ruby.md @@ -33,7 +33,7 @@ The following operating systems and architectures are supported: - Linux (GNU libc) x86-64, aarch64 - Alpine Linux (musl libc) x86-64, aarch64 -You also need either the [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) or the [`pkgconf`](https://github.com/pkgconf/pkgconf) Linux system utility installed. +You also need either the [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) or the [`pkgconf`](https://github.com/pkgconf/pkgconf) system utility installed. This utility is available on the software repositories of most Linux distributions. For example: - The `pkg-config` package is available for [Homebrew](https://formulae.brew.sh/formula/pkg-config), and [Debian](https://packages.debian.org/search?keywords=pkg-config)- and [Ubuntu](https://packages.ubuntu.com/search?keywords=pkg-config)-based Linux @@ -42,6 +42,8 @@ This utility is available on the software repositories of most Linux distributio 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. + ## Installation To begin profiling applications: From 773d45bb4b82e2ebd5bbb68d3f37ddae01231cc7 Mon Sep 17 00:00:00 2001 From: Ivo Anjo Date: Fri, 8 Mar 2024 10:55:40 +0000 Subject: [PATCH 2/3] Tweak language to hopefully make it clear which cases are supported, and which aren't --- content/en/profiler/enabling/ruby.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en/profiler/enabling/ruby.md b/content/en/profiler/enabling/ruby.md index 92cb63dd2017b..0d7b45d27830b 100644 --- a/content/en/profiler/enabling/ruby.md +++ b/content/en/profiler/enabling/ruby.md @@ -42,7 +42,8 @@ This utility is available on the software repositories of most Linux distributio 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. +[Single Step Instrumentation](https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/) for Linux host or VM and Docker are not supported. +Single Step Instrumentation for Kubernetes (using the Datadog Helm chart) is supported, but you will still need to manually set the `DD_PROFILING_ENABLED=true` environment variable to enable profiling. ## Installation From 31d7ee1a0a39c87fa59c5e42c3c934eca64d8635 Mon Sep 17 00:00:00 2001 From: Ivo Anjo Date: Tue, 9 Apr 2024 09:00:18 +0100 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Bryce Eadie --- content/en/profiler/enabling/ruby.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/profiler/enabling/ruby.md b/content/en/profiler/enabling/ruby.md index 81e5ee343c3a1..892c2aef91c77 100644 --- a/content/en/profiler/enabling/ruby.md +++ b/content/en/profiler/enabling/ruby.md @@ -42,8 +42,8 @@ This utility is available on the software repositories of most Linux distributio 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 Linux host or VM and Docker are not supported. -Single Step Instrumentation for Kubernetes (using the Datadog Helm chart) is supported, but you will still need to manually set the `DD_PROFILING_ENABLED=true` environment variable to enable profiling. +[Single Step Instrumentation](https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/single-step-apm/) is not supported for Linux hosts, VMs, or Docker. +Single Step Instrumentation is supported for Kubernetes (using the Datadog Helm chart), but you need to manually set the `DD_PROFILING_ENABLED=true` environment variable to enable profiling. ## Installation