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.

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

Document DI environment variables across languages #27176

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions content/en/dynamic_instrumentation/enabling/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@ Select your runtime below to learn how to enable Dynamic Instrumentation for you

{{< partial name="dynamic_instrumentation/dynamic-instrumentation-languages.html" >}}

## Supported environment variables

| Environment Variable | Default | Java | .NET | Python | Ruby | PHP | Node.js | Description
| -------------------- | ------- | ---- | ---- | ------ | ---- | --- | ------- | -----------
| `DD_DYNAMIC_INSTRUMENTATION_ENABLED` | `"false"` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Enable Dynamic Instrumentation
| `DD_DYNAMIC_INSTRUMENTATION_REDACTED_IDENTIFIERS` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Add identifiers to redact
| `DD_DYNAMIC_INSTRUMENTATION_REDACTED_TYPES` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Add types to redact
| `DD_DYNAMIC_INSTRUMENTATION_REDACTION_EXCLUDED_IDENTIFIERS` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Remove identifiers from redaction
| `DD_SERVICE` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Service name
| `DD_ENV` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Environment name
| `DD_VERSION` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Service version
| `DD_TAGS` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Tags
| `DD_GIT_REPOSITORY_URL` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Git repository URL
| `DD_GIT_COMMIT_SHA` | `""` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | Git commit SHA

## Further reading

{{< partial name="whats-next/whats-next.html" >}}
Expand Down
6 changes: 3 additions & 3 deletions content/en/dynamic_instrumentation/enabling/dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ further_reading:
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.
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. Then, go directly to enabling Dynamic Instrumentation in step 4.

## Prerequisites

Expand All @@ -26,7 +26,7 @@ For a better experience, Datadog recommends enabling [autocomplete and search (i

**Note**: Dynamic Instrumentation is available in the `dd-trace-dotnet` library in versions 2.54.0 and later.

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.
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 instrumentations 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][4].

## Configuration
Expand All @@ -43,7 +43,7 @@ Configure Dynamic Instrumentation using the following environment variables:

## What to do next

See [Dynamic Instrumentation][6] for information about setting snapshot and metric probes and browsing and indexing the data.
See [Dynamic Instrumentation][6] for information about adding instrumentations and browsing and indexing the data.

## Further reading

Expand Down
6 changes: 3 additions & 3 deletions content/en/dynamic_instrumentation/enabling/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ further_reading:
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.
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. Then, go directly to enabling Dynamic Instrumentation in step 4.

## Requirements

Expand Down Expand Up @@ -45,7 +45,7 @@ Dynamic Instrumentation is a feature of supporting Datadog tracing libraries. If

**Note**: Dynamic Instrumentation is available in the `dd-java-agent.jar` library in versions 1.34.0 and later.

3. Run your service with Dynamic Instrumentation enabled by setting `-Ddd.dynamic.instrumentation.enabled` flag or `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.
3. Run your service with Dynamic Instrumentation enabled by setting `-Ddd.dynamic.instrumentation.enabled` flag or `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 instrumentations and target active clients across these dimensions.
{{< tabs >}}
{{% tab "Command arguments" %}}

Expand Down Expand Up @@ -99,7 +99,7 @@ Configure Dynamic Instrumentation using the following environment variables:

## What to do next

See [Dynamic Instrumentation][6] for information about setting snapshot and metric probes and browsing and indexing the data.
See [Dynamic Instrumentation][6] for information about adding instrumentations and browsing and indexing the data.

## Further reading

Expand Down
106 changes: 106 additions & 0 deletions content/en/dynamic_instrumentation/enabling/nodejs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
title: Enable Dynamic Instrumentation for Node.js
aliases:
- /tracing/dynamic_instrumentation/enabling/nodejs/
private: false
code_lang: nodejs
type: multi-code-lang
code_lang_weight: 30
further_reading:
- link: 'agent'
tag: 'Documentation'
text: 'Getting Started with Datadog Agent'
---

<div class="alert alert-info">
<p><strong>Dynamic Instrumentation for Node.js is in limited preview</strong></p>
<p>It is not available to all customers. To join the waiting list, <a href="https://forms.gle/TODO" target="_blank">fill out this form</a>.</p>
<p>Certain limitations apply to the limited preview. See <a href="#limitations">Limitations</a> for more information.</p>
</div>

<div class="alert alert-warning">
<p><strong>Dynamic Instrumentation for Node.js is in limited preview</strong></p>
<p>It is not available to all customers. To join the waiting list, <a href="https://forms.gle/TODO" target="_blank">fill out this form</a>.</p>
<p>Certain limitations apply to the limited preview. See <a href="#limitations">Limitations</a> for more information.</p>
</div>

{{< beta-callout url="https://forms.gle/TODO" >}}
<p><strong>Dynamic Instrumentation for Node.js is in limited preview</strong></p>
<p>It is not available to all customers. Request access to join the waiting list.</p>
<p>Certain limitations apply to the limited preview. See <a href="#limitations">Limitations</a> for more information.</p>
{{< /beta-callout >}}

{{< beta-callout-private url="https://forms.gle/TODO" >}}
<p><strong>Dynamic Instrumentation for Node.js is in limited preview</strong></p>
<p>It is not available to all customers. Request access to join the waiting list.</p>
<p>Certain limitations apply to the limited preview. See <a href="#limitations">Limitations</a> for more information.</p>
{{< /beta-callout-private >}}

{{< callout url="https://forms.gle/TODO">}}
<p><strong>Dynamic Instrumentation for Node.js is in limited preview.</strong></p>
<p>It is not available to all customers. Request access to join the waiting list.</p>
<p>Certain limitations apply to the preview. See <a href="#limitations">Limitations</a> for more information.</p>
{{< /callout >}}

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. Then, 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 Node.js tracing library to version 5.32.0 or higher, by following the [relevant instructions][2].
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 instrumentations 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 adding instrumentations and browsing and indexing the data.

## Limitations

Dynamic Instrumentation for Node.js is currently in limited preview, which means it is not available to all customers. To join the waiting list, [fill out this form][6].

The following limitations apply to the limited preview:

### Supported features

- [Dynamic Logs][8] attached to a specific file/line
- Capturing of variables for Dynamic Logs
- [PII redaction][9] based on variable/property names
- [Source code integration][10]

### Unsupported features

- Dynamic Metrics, Spans, and Span Tags
- Dynamic Logs attached to a function/method
- Custom template for Dynamic Logs
- Dynamic Log conditions
- Source maps (e.g. if using TypeScript, the Dynamic Log needs to be configured against the transpiled JavaScript file)
- PII redaction based on specific classes or types

## Further reading

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

[1]: /tracing/trace_collection/
[2]: /tracing/trace_collection/dd_libraries/nodejs/
[3]: https://app.datadoghq.com/dynamic-instrumentation
[4]: /getting_started/tagging/unified_service_tagging
[5]: /dynamic_instrumentation/
[6]: https://forms.gle/TODO
[7]: https://app.datadoghq.com/account/settings/agent/latest?platform=overview
[8]: /dynamic_instrumentation/#creating-log-probes
[9]: /dynamic_instrumentation/sensitive-data-scrubbing/#custom-identifier-redaction
[10]: /integrations/guide/source-code-integration/?tab=nodejs#embed-git-information-in-your-build-artifacts
32 changes: 26 additions & 6 deletions content/en/dynamic_instrumentation/enabling/php.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,20 @@ further_reading:
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.
{{< beta-callout-private url="https://forms.gle/TODO" >}}
<p><strong>Dynamic Instrumentation for PHP is in limited preview</strong></p>
<p>It is not available to all customers. Request access to join the waiting list.</p>
<p>Certain limitations apply to the limited preview. See <a href="#limitations">Limitations</a> for more information.</p>
{{< /beta-callout-private >}}

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. Then, 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 PHP tracing libraries to version 1.4.0, by following the [relevant instructions][2].

**Note**: Dynamic Instrumentation is available in the `dd-trace-php` library in versions 1.4.0 and later. Only function and method probes are 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.
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 instrumentations 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
Expand All @@ -39,7 +42,22 @@ Configure Dynamic Instrumentation using the following environment variables:

## What to do next

See [Dynamic Instrumentation][5] for information about setting snapshot and metric probes and browsing and indexing the data.
See [Dynamic Instrumentation][5] for information about adding instrumentations and browsing and indexing the data.

## Limitations

Dynamic Instrumentation for PHP is currently in limited preview, which means it is not available to all customers. To join the waiting list, [fill out this form][6].

The following limitations apply to the limited preview:

### Supported features

- [Dynamic Logs][8] attached to a function/method

### Unsupported features

- Dynamic Logs attached to a specific file/line
- Dynamic Metrics, Spans, and Span Tags

## Further reading

Expand All @@ -50,4 +68,6 @@ See [Dynamic Instrumentation][5] for information about setting snapshot and metr
[3]: https://app.datadoghq.com/dynamic-instrumentation
[4]: /getting_started/tagging/unified_service_tagging
[5]: /dynamic_instrumentation/
[6]: https://forms.gle/TODO
[7]: https://app.datadoghq.com/account/settings/agent/latest?platform=overview
[8]: /dynamic_instrumentation/#creating-log-probes
6 changes: 3 additions & 3 deletions content/en/dynamic_instrumentation/enabling/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ further_reading:
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.
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. Then, go directly to enabling Dynamic Instrumentation in step 4.

## Prerequisites

Expand All @@ -31,7 +31,7 @@ Recommended, [autocomplete and search (in Preview)][6] is enabled.

**Note**: Dynamic Instrumentation is available in the `ddtrace` library version 2.2.0 and higher.

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.
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 instrumentations and target active clients across these dimensions.
{{< tabs >}}
{{% tab "Environment variables" %}}

Expand Down Expand Up @@ -70,7 +70,7 @@ Configure Dynamic Instrumentation using the following environment variables:

## What to do next

See [Dynamic Instrumentation][5] for information about setting snapshot and metric probes and browsing and indexing the data.
See [Dynamic Instrumentation][5] for information about adding instrumentations and browsing and indexing the data.

## Further reading

Expand Down
Loading
Loading