diff --git a/content/en/dynamic_instrumentation/enabling/_index.md b/content/en/dynamic_instrumentation/enabling/_index.md index 0a7007534f349..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/' @@ -17,7 +16,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..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 @@ -38,7 +37,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 +45,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..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 @@ -94,7 +93,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 +101,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..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 @@ -34,7 +33,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 +41,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..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 @@ -65,7 +64,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 +72,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/ruby.md b/content/en/dynamic_instrumentation/enabling/ruby.md new file mode 100644 index 0000000000000..92103a5fca51e --- /dev/null +++ b/content/en/dynamic_instrumentation/enabling/ruby.md @@ -0,0 +1,53 @@ +--- +title: Enable Dynamic Instrumentation for Ruby +aliases: + - /tracing/dynamic_instrumentation/enabling/ruby/ +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