Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEBUG-2334 Ruby DI documentation page #26924

Merged
merged 7 commits into from
Dec 31, 2024
Merged

DEBUG-2334 Ruby DI documentation page #26924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
094cc9d
Ruby DI documentation page
p Dec 18, 2024
8ab939a
Add missing PHP and Ruby entries to /dynamic_instrumentation/enabling…
brett0000FF Dec 30, 2024
457b374
Revert "Add missing PHP and Ruby entries to /dynamic_instrumentation/…
brett0000FF Dec 30, 2024
c516438
Update content/en/dynamic_instrumentation/enabling/ruby.md
p-datadog Dec 30, 2024
e56f843
Update content/en/dynamic_instrumentation/enabling/ruby.md
p-datadog Dec 30, 2024
88e21cb
update other languages to match
p Dec 30, 2024
26c657f
remove is_beta
p Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions content/en/dynamic_instrumentation/enabling/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/'
Expand All @@ -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" >}}

Expand Down
5 changes: 2 additions & 3 deletions content/en/dynamic_instrumentation/enabling/dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -38,15 +37,15 @@ 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 `<key>:<value>` separated by commas such as: `layer:api,team:intake`. |

## What to do next

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" >}}

Expand Down
5 changes: 2 additions & 3 deletions content/en/dynamic_instrumentation/enabling/java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -94,15 +93,15 @@ 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 `<key>:<value>` separated by commas such as: `layer:api,team:intake`. |

## What to do next

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" >}}

Expand Down
5 changes: 2 additions & 3 deletions content/en/dynamic_instrumentation/enabling/php.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -34,15 +33,15 @@ 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 `<key>:<value>` 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
## Further reading

{{< partial name="whats-next/whats-next.html" >}}

Expand Down
5 changes: 2 additions & 3 deletions content/en/dynamic_instrumentation/enabling/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -65,15 +64,15 @@ 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 `<key>:<value>` 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
## Further reading

{{< partial name="whats-next/whats-next.html" >}}

Expand Down
53 changes: 53 additions & 0 deletions content/en/dynamic_instrumentation/enabling/ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 `<key>:<value>` 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
Loading