Single Step APM Instrumentation on Linux

Docs > APM > アプリケーションインスツルメンテーション > Single Step APM Instrumentation > Single Step APM Instrumentation on Linux

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Overview

On a Linux host or VM, use Single Step Instrumentation (SSI) for APM to install the Datadog Agent and instrument your applications in one step, with no additional configuration required.

Enable APM on your applications

Before proceeding, confirm that your environment is compatible by reviewing the SSI compatibility guide.

New Agent installation

If you don’t yet have a Datadog Agent installed, follow these steps to install the Agent and enable SSI simultaneously.

In Datadog, go to the Install the Datadog Agent on Linux page.
In the Customize your Agent coverage section, go to Core Observability and turn on Application Performance Monitoring.

(Optional) By default, SSI installs the latest SDK versions. To use specific versions instead, set your desired library versions with the DD_APM_INSTRUMENTATION_LIBRARIES variable in your Agent installation command:
```
DD_API_KEY=<YOUR_DD_API_KEY>
DD_SITE="US1-FED"
DD_APM_INSTRUMENTATION_ENABLED=host
DD_APM_INSTRUMENTATION_LIBRARIES="java:1,python:2,js:5,dotnet:3,php:1"
bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"
```
Available versions are listed in source repositories for each language: Java (java), Node.js (js), Python (python), .NET (dotnet), Ruby (ruby), PHP (php).

(Optional) By default, SSI installs the latest SDK versions. To use specific versions instead, set your desired library versions with the DD_APM_INSTRUMENTATION_LIBRARIES variable in your Agent installation command:
```
DD_API_KEY=<YOUR_DD_API_KEY>
DD_SITE="US2-FED"
DD_APM_INSTRUMENTATION_ENABLED=host
DD_APM_INSTRUMENTATION_LIBRARIES="java:1,python:2,js:5,dotnet:3,php:1"
bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"
```
Available versions are listed in source repositories for each language: Java (java), Node.js (js), Python (python), .NET (dotnet), Ruby (ruby), PHP (php).

Copy and run the Agent installation command on your Linux host or VM.
Restart your applications.

SSI adds a small amount of startup time to instrumented applications. If this overhead is not acceptable for your use case, contact Datadog Support.

Existing Agent installation

If you already have a Datadog Agent installed, use Fleet Automation to enable SSI.

In Datadog, go to Fleet Automation > Configuration.
Click Configure Agents.
Apply filters to select the agents you want to configure, then click Next.
Click the Application Performance Monitoring (APM) tile, then click Next.
In the Configure SDKs Installation screen, click Yes to automatically install the SDKs. Select Use latest version, or uncheck to specify individual SDK versions.
Click Next.
Review your configuration and click Deploy Configuration.

Configure Unified Service Tags

Unified Service Tags (USTs) apply consistent tags across traces, metrics, and logs, making it easier to navigate and correlate your observability data. Learn how to set USTs for Linux services.

Enable SDK-dependent products and features

After SSI loads the Datadog SDK into your applications and enables distributed tracing, you can configure additional products that rely on the SDK:

Product	Environment variable
Runtime Metrics	`DD_RUNTIME_METRICS_ENABLED`
Log Injection	`DD_LOGS_INJECTION`
Continuous Profiler	`DD_PROFILING_ENABLED`
Data Streams Monitoring	`DD_DATA_STREAMS_ENABLED`
App and API Protection	`DD_APPSEC_ENABLED`
Runtime Code Analysis (IAST)	`DD_IAST_ENABLED`
Dynamic Instrumentation	`DD_DYNAMIC_INSTRUMENTATION_ENABLED`
Data Jobs Monitoring	`DD_DATA_JOBS_ENABLED`
Software Composition Analysis	`DD_APPSEC_SCA_ENABLED`

Note: All variables accept true or false. DD_PROFILING_ENABLED also accepts auto, which profiles only eligible processes and is recommended for SSI.

Use one of the following setup methods:

Configure in application_monitoring.yaml:
Configure products and features across all services on a host without modifying application command lines.
Set environment variables:
Enable products by setting environment variables directly in your application configuration.

Advanced options

Update SDK version

The SDK version is fixed when you run the Agent installation command.

To update the SDK versions:

Re-run the Agent installation command. This command also updates the Agent to the latest version.
Restart your applications.

Define instrumentation rules

Instrumentation rules (available for Agent v7.73+) let you control which processes are automatically instrumented by SSI on Linux hosts.

To configure instrumentation rules:

In Datadog, go to APM > Service Setup > Manage Instrumentation Rules.
Click Add or Edit Rules.
Define instrumentation rules:
1. Click Add New Rule, then choose Allow Rule or Block Rule to specify whether matching processes should be instrumented.
2. Name your rule.
3. Add one or more conditions. See Define rule conditions to learn more.
(Optional) Drag and drop rules to reorder them.
Note: Rules are evaluated in order. After a process matches a rule, subsequent rules are ignored.
Set the default behavior (allow or block) for processes that do not match any rule.
Click Next to preview your rules.
Click Deploy Rules.

If Remote Configuration is enabled, rules are deployed to every host and applied on those with SSI enabled within 50 seconds. Alternatively, click Export to export the configuration file and apply it manually to your hosts.

Define rule conditions

Each rule consists of one or more conditions. A condition includes the following elements:

Attribute: The process property that the rule evaluates.
Operator: The comparison logic (equals, not equals, prefix, or contains).
Value: The text or pattern to match, such as a process name or command-line flag.

Supported attributes include:

Attribute	Description	Example
Operating System	OS of the host.	`linux`
Executable	Executable name of the process.	`python3.11`
Executable Full Path	Full path of the executable.	`/usr/bin/python3.11`
Arguments	Command-line arguments used to start the process.	`--env=production`
Working Directory	Working directory of the process.	`/app`
Language	Programming language detected for the process.	`python`
Entry Point File	The specific file used to launch the application.	`app.py`, `server.js`

Example use cases

Review the following examples demonstrating how to apply instrumentation rules:

Example 1: Instrument all processes except specific ones

Instrument all processes by default. Add block rules to exclude services that would add noise without value, such as analytics cron jobs and Java batch processors.

Two block instrumentation rules targeting Working Directory and Entry Point File conditions, with a default of allow instrumentation

Example 2: Instrument only specific processes

Block all instrumentation by default. Add allow rules to opt specific processes into APM. This approach gives you precise control and works well for gradual rollouts. For example, to instrument only a checkout service and a customer portal, create allow rules using Working Directory, then set the default behavior to Block Instrumentation.