From 094cc9d907370904c6a822425939f7733c4490d1 Mon Sep 17 00:00:00 2001 From: Oleg Pudeyev Date: Wed, 18 Dec 2024 09:05:32 -0500 Subject: [PATCH 1/7] Ruby DI documentation page --- .../dynamic_instrumentation/enabling/ruby.md | 54 +++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 content/en/dynamic_instrumentation/enabling/ruby.md diff --git a/content/en/dynamic_instrumentation/enabling/ruby.md b/content/en/dynamic_instrumentation/enabling/ruby.md new file mode 100644 index 0000000000000..0858e1a56fa00 --- /dev/null +++ b/content/en/dynamic_instrumentation/enabling/ruby.md @@ -0,0 +1,54 @@ +--- +title: Enable Dynamic Instrumentation for Ruby +aliases: + - /tracing/dynamic_instrumentation/enabling/ruby/ +is_beta: true +private: true +code_lang: ruby +type: multi-code-lang +code_lang_weight: 30 +further_reading: + - link: 'agent' + tag: 'Documentation' + text: 'Getting Started with Datadog Agent' +--- + +Dynamic Instrumentation is a feature of supporting Datadog tracing libraries. If you are already using [APM to collect traces][1] for your application, ensure your Agent and tracing library are on the required version, and go directly to enabling Dynamic Instrumentation in step 4. + +## Installation + +1. Install or upgrade your Agent to version [7.45.0][7] or higher. +2. If you don't already have APM enabled, in your Agent configuration, set the `DD_APM_ENABLED` environment variable to `true` and listening to the port `8126/TCP`. +3. Install or upgrade the Ruby tracing library to version 2.8.0 or higher, by following the [relevant instructions][2]. + + **Note**: Dynamic Instrumentation is available in the `dd-trace-ruby` library in versions 2.8.0 and later. Only log probes are currently supported. + +4. Run your service with Dynamic Instrumentation enabled by setting the `DD_DYNAMIC_INSTRUMENTATION_ENABLED` environment variable to `true`. Specify `DD_SERVICE`, `DD_ENV`, and `DD_VERSION` Unified Service Tags so you can filter and group your probes and target active clients across these dimensions. +5. After starting your service with Dynamic Instrumentation enabled, you can start using Dynamic Instrumentation on the [APM > Dynamic Instrumentation page][3]. + +## Configuration + +Configure Dynamic Instrumentation using the following environment variables: + +| Environment variable | Type | Description | +| ------------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `DD_DYNAMIC_INSTRUMENTATION_ENABLED` | Boolean | Set to `true` to enable Dynamic Instrumentation. | +| `DD_SERVICE` | String | The [service][4] name, for example, `web-backend`. | +| `DD_ENV` | String | The [environment][4] name, for example: `production`. | +| `DD_VERSION` | String | The [version][4] of your service. | +| `DD_TAGS` | String | Tags to apply to produced data. Must be a list of `:` separated by commas such as: `layer:api,team:intake`. | + +## What to do next + +See [Dynamic Instrumentation][5] for information about setting snapshot and metric probes and browsing and indexing the data. + +## Further Reading + +{{< partial name="whats-next/whats-next.html" >}} + +[1]: /tracing/trace_collection/ +[2]: /tracing/trace_collection/dd_libraries/ruby/ +[3]: https://app.datadoghq.com/dynamic-instrumentation +[4]: /getting_started/tagging/unified_service_tagging +[5]: /dynamic_instrumentation/ +[7]: https://app.datadoghq.com/account/settings/agent/latest?platform=overview From 8ab939aa2622f504783c3fe7b12d5852f7ced172 Mon Sep 17 00:00:00 2001 From: Brett Blue Date: Mon, 30 Dec 2024 10:12:12 -0700 Subject: [PATCH 2/7] Add missing PHP and Ruby entries to /dynamic_instrumentation/enabling/ tile partial. --- .../dynamic-instrumentation-languages.html | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html b/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html index 77f099a3e8809..5e77eaa6550a6 100644 --- a/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html +++ b/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html @@ -1,7 +1,7 @@ {{ $dot := . }}
-
-
+
+
@@ -30,6 +30,20 @@
+
+ +
+ {{ partial "img.html" (dict "root" . "src" "integrations_logos/php.png" "class" "img-fluid" "alt" "PHP" "width" "400") }} +
+ +
+
+ +
+ {{ partial "img.html" (dict "root" . "src" "integrations_logos/ruby.png" "class" "img-fluid" "alt" "Ruby" "width" "400") }} +
+ +

From 457b3745522a580112eab7fabf03b24ffcf83a79 Mon Sep 17 00:00:00 2001 From: Brett Blue Date: Mon, 30 Dec 2024 10:53:20 -0700 Subject: [PATCH 3/7] Revert "Add missing PHP and Ruby entries to /dynamic_instrumentation/enabling/ tile partial." This reverts commit 5e466dc9995bd26d4cf354609796f455b0e96170. --- .../dynamic-instrumentation-languages.html | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html b/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html index 5e77eaa6550a6..77f099a3e8809 100644 --- a/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html +++ b/layouts/partials/dynamic_instrumentation/dynamic-instrumentation-languages.html @@ -1,7 +1,7 @@ {{ $dot := . }}
-
-
+
+
@@ -30,20 +30,6 @@
-
- -
- {{ partial "img.html" (dict "root" . "src" "integrations_logos/php.png" "class" "img-fluid" "alt" "PHP" "width" "400") }} -
- -
-
- -
- {{ partial "img.html" (dict "root" . "src" "integrations_logos/ruby.png" "class" "img-fluid" "alt" "Ruby" "width" "400") }} -
- -

From c516438f39845887556a66c694510e6c770cd38f Mon Sep 17 00:00:00 2001 From: Oleg Pudeyev <156273877+p-datadog@users.noreply.github.com> Date: Mon, 30 Dec 2024 13:54:18 -0500 Subject: [PATCH 4/7] Update content/en/dynamic_instrumentation/enabling/ruby.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> --- content/en/dynamic_instrumentation/enabling/ruby.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/dynamic_instrumentation/enabling/ruby.md b/content/en/dynamic_instrumentation/enabling/ruby.md index 0858e1a56fa00..85d732dac68c9 100644 --- a/content/en/dynamic_instrumentation/enabling/ruby.md +++ b/content/en/dynamic_instrumentation/enabling/ruby.md @@ -34,7 +34,7 @@ Configure Dynamic Instrumentation using the following environment variables: | ------------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------- | | `DD_DYNAMIC_INSTRUMENTATION_ENABLED` | Boolean | Set to `true` to enable Dynamic Instrumentation. | | `DD_SERVICE` | String | The [service][4] name, for example, `web-backend`. | -| `DD_ENV` | String | The [environment][4] name, for example: `production`. | +| `DD_ENV` | String | The [environment][4] name, for example, `production`. | | `DD_VERSION` | String | The [version][4] of your service. | | `DD_TAGS` | String | Tags to apply to produced data. Must be a list of `:` separated by commas such as: `layer:api,team:intake`. | From e56f843da6955756ce864f3809a009699e347a9c Mon Sep 17 00:00:00 2001 From: Oleg Pudeyev <156273877+p-datadog@users.noreply.github.com> Date: Mon, 30 Dec 2024 13:54:26 -0500 Subject: [PATCH 5/7] Update content/en/dynamic_instrumentation/enabling/ruby.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> --- content/en/dynamic_instrumentation/enabling/ruby.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/dynamic_instrumentation/enabling/ruby.md b/content/en/dynamic_instrumentation/enabling/ruby.md index 85d732dac68c9..c00d2f37d849f 100644 --- a/content/en/dynamic_instrumentation/enabling/ruby.md +++ b/content/en/dynamic_instrumentation/enabling/ruby.md @@ -42,7 +42,7 @@ Configure Dynamic Instrumentation using the following environment variables: See [Dynamic Instrumentation][5] for information about setting snapshot and metric probes and browsing and indexing the data. -## Further Reading +## Further reading {{< partial name="whats-next/whats-next.html" >}} From 88e21cb43d268ef505a720aa90db179623b41bb8 Mon Sep 17 00:00:00 2001 From: Oleg Pudeyev Date: Mon, 30 Dec 2024 13:56:36 -0500 Subject: [PATCH 6/7] update other languages to match --- content/en/dynamic_instrumentation/enabling/_index.md | 2 +- content/en/dynamic_instrumentation/enabling/dotnet.md | 4 ++-- content/en/dynamic_instrumentation/enabling/java.md | 4 ++-- content/en/dynamic_instrumentation/enabling/php.md | 4 ++-- content/en/dynamic_instrumentation/enabling/python.md | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/en/dynamic_instrumentation/enabling/_index.md b/content/en/dynamic_instrumentation/enabling/_index.md index 0a7007534f349..a37d1e686052c 100644 --- a/content/en/dynamic_instrumentation/enabling/_index.md +++ b/content/en/dynamic_instrumentation/enabling/_index.md @@ -17,7 +17,7 @@ Select your runtime below to learn how to enable Dynamic Instrumentation for you {{< partial name="dynamic_instrumentation/dynamic-instrumentation-languages.html" >}} -## Further Reading +## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/dynamic_instrumentation/enabling/dotnet.md b/content/en/dynamic_instrumentation/enabling/dotnet.md index 9dce3fcaa8877..4243c7eba4672 100644 --- a/content/en/dynamic_instrumentation/enabling/dotnet.md +++ b/content/en/dynamic_instrumentation/enabling/dotnet.md @@ -38,7 +38,7 @@ Configure Dynamic Instrumentation using the following environment variables: | ------------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------- | | `DD_DYNAMIC_INSTRUMENTATION_ENABLED` | Boolean | Set to `true` to enable Dynamic Instrumentation. | | `DD_SERVICE` | String | The [service][5] name, for example, `web-backend`. | -| `DD_ENV` | String | The [environment][5] name, for example: `production`. | +| `DD_ENV` | String | The [environment][5] name, for example, `production`. | | `DD_VERSION` | String | The [version][5] of your service. | | `DD_TAGS` | String | Tags to apply to produced data. Must be a list of `:` separated by commas such as: `layer:api,team:intake`. | @@ -46,7 +46,7 @@ Configure Dynamic Instrumentation using the following environment variables: See [Dynamic Instrumentation][6] for information about setting snapshot and metric probes and browsing and indexing the data. -## Further Reading +## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/dynamic_instrumentation/enabling/java.md b/content/en/dynamic_instrumentation/enabling/java.md index 1ccf132a3bd1c..ff78f7403b321 100644 --- a/content/en/dynamic_instrumentation/enabling/java.md +++ b/content/en/dynamic_instrumentation/enabling/java.md @@ -94,7 +94,7 @@ Configure Dynamic Instrumentation using the following environment variables: | ------------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------- | | `DD_DYNAMIC_INSTRUMENTATION_ENABLED` | Boolean | Alternate for `-Ddd.dynamic.instrumentation.enabled` argument. Set to `true` to enable Dynamic Instrumentation. | | `DD_SERVICE` | String | The [service][5] name, for example, `web-backend`. | -| `DD_ENV` | String | The [environment][5] name, for example: `production`. | +| `DD_ENV` | String | The [environment][5] name, for example, `production`. | | `DD_VERSION` | String | The [version][5] of your service. | | `DD_TAGS` | String | Tags to apply to produced data. Must be a list of `:` separated by commas such as: `layer:api,team:intake`. | @@ -102,7 +102,7 @@ Configure Dynamic Instrumentation using the following environment variables: See [Dynamic Instrumentation][6] for information about setting snapshot and metric probes and browsing and indexing the data. -## Further Reading +## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/dynamic_instrumentation/enabling/php.md b/content/en/dynamic_instrumentation/enabling/php.md index e940da5a8488c..27e94bf7b1914 100644 --- a/content/en/dynamic_instrumentation/enabling/php.md +++ b/content/en/dynamic_instrumentation/enabling/php.md @@ -34,7 +34,7 @@ Configure Dynamic Instrumentation using the following environment variables: | ------------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------- | | `DD_DYNAMIC_INSTRUMENTATION_ENABLED` | Boolean | Set to `true` to enable Dynamic Instrumentation. | | `DD_SERVICE` | String | The [service][4] name, for example, `web-backend`. | -| `DD_ENV` | String | The [environment][4] name, for example: `production`. | +| `DD_ENV` | String | The [environment][4] name, for example, `production`. | | `DD_VERSION` | String | The [version][4] of your service. | | `DD_TAGS` | String | Tags to apply to produced data. Must be a list of `:` separated by commas such as: `layer:api,team:intake`. | @@ -42,7 +42,7 @@ Configure Dynamic Instrumentation using the following environment variables: See [Dynamic Instrumentation][5] for information about setting snapshot and metric probes and browsing and indexing the data. -## Further Reading +## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/dynamic_instrumentation/enabling/python.md b/content/en/dynamic_instrumentation/enabling/python.md index b8474a382aa13..1d5577811909f 100644 --- a/content/en/dynamic_instrumentation/enabling/python.md +++ b/content/en/dynamic_instrumentation/enabling/python.md @@ -65,7 +65,7 @@ Configure Dynamic Instrumentation using the following environment variables: | ------------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------- | | `DD_DYNAMIC_INSTRUMENTATION_ENABLED` | Boolean | Set to `true` to enable Dynamic Instrumentation. | | `DD_SERVICE` | String | The [service][4] name, for example, `web-backend`. | -| `DD_ENV` | String | The [environment][4] name, for example: `production`. | +| `DD_ENV` | String | The [environment][4] name, for example, `production`. | | `DD_VERSION` | String | The [version][4] of your service. | | `DD_TAGS` | String | Tags to apply to produced data. Must be a list of `:` separated by commas such as: `layer:api, team:intake`. | @@ -73,7 +73,7 @@ Configure Dynamic Instrumentation using the following environment variables: See [Dynamic Instrumentation][5] for information about setting snapshot and metric probes and browsing and indexing the data. -## Further Reading +## Further reading {{< partial name="whats-next/whats-next.html" >}} From 26c657f8e4beb5aa9c58345cd7f991ff983167aa Mon Sep 17 00:00:00 2001 From: Oleg Pudeyev Date: Mon, 30 Dec 2024 14:28:21 -0500 Subject: [PATCH 7/7] remove is_beta --- content/en/dynamic_instrumentation/enabling/_index.md | 1 - content/en/dynamic_instrumentation/enabling/dotnet.md | 1 - content/en/dynamic_instrumentation/enabling/java.md | 1 - content/en/dynamic_instrumentation/enabling/php.md | 1 - content/en/dynamic_instrumentation/enabling/python.md | 1 - content/en/dynamic_instrumentation/enabling/ruby.md | 1 - 6 files changed, 6 deletions(-) diff --git a/content/en/dynamic_instrumentation/enabling/_index.md b/content/en/dynamic_instrumentation/enabling/_index.md index a37d1e686052c..b1b2d915c7f4f 100644 --- a/content/en/dynamic_instrumentation/enabling/_index.md +++ b/content/en/dynamic_instrumentation/enabling/_index.md @@ -3,7 +3,6 @@ title: Enabling Dynamic Instrumentation type: multi-code-lang aliases: - /tracing/dynamic_instrumentation/enabling/ -is_beta: false private: false further_reading: - link: '/agent/' diff --git a/content/en/dynamic_instrumentation/enabling/dotnet.md b/content/en/dynamic_instrumentation/enabling/dotnet.md index 4243c7eba4672..febf0d68a8551 100644 --- a/content/en/dynamic_instrumentation/enabling/dotnet.md +++ b/content/en/dynamic_instrumentation/enabling/dotnet.md @@ -2,7 +2,6 @@ title: Enable Dynamic Instrumentation for .NET aliases: - /tracing/dynamic_instrumentation/enabling/dotnet/ -is_beta: false private: false code_lang: dotnet type: multi-code-lang diff --git a/content/en/dynamic_instrumentation/enabling/java.md b/content/en/dynamic_instrumentation/enabling/java.md index ff78f7403b321..325ef4fdf6fd8 100644 --- a/content/en/dynamic_instrumentation/enabling/java.md +++ b/content/en/dynamic_instrumentation/enabling/java.md @@ -2,7 +2,6 @@ title: Enable Dynamic Instrumentation for Java aliases: - /tracing/dynamic_instrumentation/enabling/java/ -is_beta: false private: false code_lang: java type: multi-code-lang diff --git a/content/en/dynamic_instrumentation/enabling/php.md b/content/en/dynamic_instrumentation/enabling/php.md index 27e94bf7b1914..ec1ce07f52513 100644 --- a/content/en/dynamic_instrumentation/enabling/php.md +++ b/content/en/dynamic_instrumentation/enabling/php.md @@ -2,7 +2,6 @@ title: Enable Dynamic Instrumentation for PHP aliases: - /tracing/dynamic_instrumentation/enabling/php/ -is_beta: true private: true code_lang: php type: multi-code-lang diff --git a/content/en/dynamic_instrumentation/enabling/python.md b/content/en/dynamic_instrumentation/enabling/python.md index 1d5577811909f..214333c09d043 100644 --- a/content/en/dynamic_instrumentation/enabling/python.md +++ b/content/en/dynamic_instrumentation/enabling/python.md @@ -2,7 +2,6 @@ title: Enable Dynamic Instrumentation for Python aliases: - /tracing/dynamic_instrumentation/enabling/python/ -is_beta: false private: false code_lang: python type: multi-code-lang diff --git a/content/en/dynamic_instrumentation/enabling/ruby.md b/content/en/dynamic_instrumentation/enabling/ruby.md index c00d2f37d849f..92103a5fca51e 100644 --- a/content/en/dynamic_instrumentation/enabling/ruby.md +++ b/content/en/dynamic_instrumentation/enabling/ruby.md @@ -2,7 +2,6 @@ title: Enable Dynamic Instrumentation for Ruby aliases: - /tracing/dynamic_instrumentation/enabling/ruby/ -is_beta: true private: true code_lang: ruby type: multi-code-lang