@@ -215,7 +215,7 @@ DD_TAGS=datacenter:njc,key2:value2
## Resource filtering
-You can exclude traces based on the resource name to remove Synthetics traffic such as health checks. For more information about security and additional configurations, see [Configure the Datadog Agent or Tracer for Data Security][10].
+You can exclude traces based on the resource name to remove Synthetics traffic such as health checks. For more information about security and additional configurations, see [Configure the Datadog Agent or APM SDK for Data Security][10].
## Further Reading
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/dotnet/otel.md b/content/en/tracing/trace_collection/custom_instrumentation/dotnet/otel.md
index 53e07208450e5..ecf98b2264f11 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/dotnet/otel.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/dotnet/otel.md
@@ -22,9 +22,9 @@ further_reading:
To configure OpenTelemetry to use the Datadog trace provider:
-1. Add your desired manual OpenTelemetry instrumentation to your .NET code following the [OpenTelemetry .NET Manual Instrumentation documentation][5]. **Note**: Where those instructions indicate that your code should call the OpenTelemetry SDK, call the Datadog tracing library instead.
+1. Add your desired manual OpenTelemetry instrumentation to your .NET code following the [OpenTelemetry .NET Manual Instrumentation documentation][5]. **Note**: Where those instructions indicate that your code should call the OpenTelemetry SDK, call the Datadog APM SDK instead.
-2. Install the Datadog .NET tracing library and enable the tracer for your [.NET Framework service][10] or your [.NET Core (and .NET 5+) service][11]. **Beta**: You can optionally do this with [Single Step APM Instrumentation][13].
+2. Install the Datadog .NET APM SDK and enable the APM SDK for your [.NET Framework service][10] or your [.NET Core (and .NET 5+) service][11]. **Beta**: You can optionally do this with [Single Step APM Instrumentation][13].
3. Set `DD_TRACE_OTEL_ENABLED` environment variable to `true`.
@@ -128,4 +128,4 @@ You can configure the propagation of context for distributed traces by injecting
[10]: /tracing/trace_collection/dd_libraries/dotnet-framework/#installation-and-getting-started
[11]: /tracing/trace_collection/dd_libraries/dotnet-core/#installation-and-getting-started
[13]: /tracing/trace_collection/single-step-apm/
-[14]: /tracing/trace_collection/trace_context_propagation/dotnet/
\ No newline at end of file
+[14]: /tracing/trace_collection/trace_context_propagation/dotnet/
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/go/dd-api.md b/content/en/tracing/trace_collection/custom_instrumentation/go/dd-api.md
index 7a6db91541380..9a3572f9738c1 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/go/dd-api.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/go/dd-api.md
@@ -7,7 +7,7 @@ aliases:
- /tracing/setup_overview/custom_instrumentation/go
- /tracing/trace_collection/custom_instrumentation/go
- /tracing/trace_collection/custom_instrumentation/dd_libraries/go
-description: 'Instrument your code with the Datadog Go APM tracer.'
+description: 'Instrument your code with the Datadog Go APM APM SDK.'
code_lang: dd-api
type: multi-code-lang
code_lang_weight: 1
@@ -84,7 +84,7 @@ func handler(w http.ResponseWriter, r *http.Request) {
### Adding tags globally to all spans
-Add [tags][1] to all [spans][2] by configuring the tracer with the `WithGlobalTag` option:
+Add [tags][1] to all [spans][2] by configuring the APM SDK with the `WithGlobalTag` option:
```go
package main
@@ -114,7 +114,7 @@ span.Finish(tracer.WithError(err))
If you aren't using supported library instrumentation (see [Library compatibility][3]), you may want to to manually instrument your code.
-Unlike other Datadog tracing libraries, when tracing Go applications, it's recommended that you explicitly manage and pass the Go context of your spans. This approach ensures accurate span relationships and meaningful tracing. For more information, see the
Go context library documentation or documentation for any third-party libraries integrated with your application.
+Unlike other Datadog APM SDKs, when tracing Go applications, it's recommended that you explicitly manage and pass the Go context of your spans. This approach ensures accurate span relationships and meaningful tracing. For more information, see the
Go context library documentation or documentation for any third-party libraries integrated with your application.
### Manually creating a new span
@@ -223,4 +223,4 @@ Traces can be excluded based on their resource name, to remove synthetic traffic
[6]: https://pkg.go.dev/gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer#StartSpanFromContext
[7]: /tracing/glossary/#trace
[9]: /tracing/security
-[11]: /tracing/trace_collection/trace_context_propagation/go/
\ No newline at end of file
+[11]: /tracing/trace_collection/trace_context_propagation/go/
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/go/otel.md b/content/en/tracing/trace_collection/custom_instrumentation/go/otel.md
index fb2212a229932..d4c8fdc97501a 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/go/otel.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/go/otel.md
@@ -19,7 +19,7 @@ further_reading:
{{% otel-custom-instrumentation-lang %}}
## Imports
-
+
Import the following packages to setup the Datadog trace provider and use cases demonstrated below:
```go
@@ -41,7 +41,7 @@ import (
To configure OpenTelemetry to use the Datadog trace provider:
-1. Add your desired manual OpenTelemetry instrumentation to your Go code following the [OpenTelemetry Go Manual Instrumentation documentation][5]. **Important!** Where those instructions indicate that your code should call the OpenTelemetry SDK, call the Datadog tracing library instead.
+1. Add your desired manual OpenTelemetry instrumentation to your Go code following the [OpenTelemetry Go Manual Instrumentation documentation][5]. **Important!** Where those instructions indicate that your code should call the OpenTelemetry SDK, call the Datadog APM SDK instead.
2. Install the OpenTelemetry package `go.opentelemetry.io/otel` using the command:
@@ -76,7 +76,7 @@ To configure OpenTelemetry to use the Datadog trace provider:
```go
otel.SetTracerProvider(provider)
```
-
+
7. Run your application.
Datadog combines these OpenTelemetry spans with other Datadog APM spans into a single trace of your application.
@@ -96,10 +96,10 @@ span.SetAttributes(attribute.String(ext.ResourceName, "test.json"))
### Adding tags globally to all spans
-Add tags to all spans by configuring the tracer with the `WithGlobalTag` option:
+Add tags to all spans by configuring the APM SDK with the `WithGlobalTag` option:
```go
-// Here we can leverage the Datadog tracer options by passing them into the
+// Here we can leverage the Datadog tracer options by passing them into the
// NewTracerProvider function.
provider := ddotel.NewTracerProvider(
ddtracer.WithGlobalTag("datacenter", "us-1"),
@@ -126,7 +126,7 @@ ctx, span := t.Start(context.Background(), "span_name")
// Set an error on a span with 'span.SetAttributes'.
span.SetAttributes(attribute.String(ext.ErrorMsg, "error_message"))
-// ALternatively, it is possible to set an error on a span via end span options.
+// ALternatively, it is possible to set an error on a span via end span options.
EndOptions(sp, tracer.WithError(errors.New("persisted_option")))
sp.End()
@@ -151,7 +151,7 @@ s.End()
## Adding spans
-Unlike other Datadog tracing libraries, when tracing Go applications, Datadog recommends that you explicitly manage and pass the Go context of your spans. This approach ensures accurate span relationships and meaningful tracing. For more information, see the [Go context library documentation][16] or documentation for any third-party libraries integrated with your application.
+Unlike other Datadog APM SDKs, when tracing Go applications, Datadog recommends that you explicitly manage and pass the Go context of your spans. This approach ensures accurate span relationships and meaningful tracing. For more information, see the [Go context library documentation][16] or documentation for any third-party libraries integrated with your application.
```go
// Can only be done after the setup steps.
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/ios/otel.md b/content/en/tracing/trace_collection/custom_instrumentation/ios/otel.md
index 387e69d0ee6d9..c790181a112e6 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/ios/otel.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/ios/otel.md
@@ -227,7 +227,7 @@ Datadog.verbosityLevel = .debug
{{% /tab %}}
{{< /tabs >}}
-3. Datadog tracer implements the [Open Telemetry standard][13]. Enable the Datadog tracer, register the tracer provider, and get the tracer instance:
+3. Datadog APM SDK implements the [Open Telemetry standard][13]. Enable the Datadog APM SDK, register the TracerProvider, and get the SDK instance:
{{< tabs >}}
{{% tab "Swift" %}}
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/java/dd-api.md b/content/en/tracing/trace_collection/custom_instrumentation/java/dd-api.md
index a05116eba20e4..5574815637a99 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/java/dd-api.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/java/dd-api.md
@@ -7,7 +7,7 @@ aliases:
- /tracing/setup_overview/custom_instrumentation/java
- /tracing/trace_collection/custom_instrumentation/java
- /tracing/trace_collection/custom_instrumentation/dd_libraries/java
-description: 'Instrument your code with the Datadog Java APM tracer.'
+description: 'Instrument your code with the Datadog Java APM APM SDK.'
code_lang: dd-api
type: multi-code-lang
code_lang_weight: 1
@@ -22,7 +22,7 @@ further_reading:
This page details common use cases for adding and customizing observability with Datadog APM. If you have not read the setup instructions for automatic instrumentation, start with the [Java Setup Instructions][11].
-
The Datadog Java tracer is built on OpenTracing. Although OpenTracing is deprecated in favor of OpenTelemetry, the following examples correctly import the opentracing
library.
+
The Datadog Java APM SDK is built on OpenTracing. Although OpenTracing is deprecated in favor of OpenTelemetry, the following examples correctly import the opentracing
library.
## Adding tags
@@ -87,7 +87,7 @@ import io.opentracing.log.Fields;
}
```
-**Note**: `Span.log()` is a generic OpenTracing mechanism for associating events to the current timestamp. The Java Tracer only supports logging error events.
+**Note**: `Span.log()` is a generic OpenTracing mechanism for associating events to the current timestamp. The Java APM SDK only supports logging error events.
Alternatively, you can set error tags directly on the span without `log()`:
```java
@@ -261,9 +261,9 @@ class SomeClass {
}
```
-### Extending tracers
+### Extending APM SDKs
-The tracing libraries are designed to be extensible. Customers may consider writing a custom post-processor called a `TraceInterceptor` to intercept Spans then adjust or discard them accordingly (for example, based on regular expressions). The following example implements two interceptors to achieve complex post-processing logic.
+The APM SDKs are designed to be extensible. Customers may consider writing a custom post-processor called a `TraceInterceptor` to intercept Spans then adjust or discard them accordingly (for example, based on regular expressions). The following example implements two interceptors to achieve complex post-processing logic.
```java
import java.util.List;
@@ -358,4 +358,4 @@ Traces can be excluded based on their resource name, to remove synthetic traffic
[8]: /tracing/trace_collection/trace_context_propagation/java/
[9]: /tracing/security
[10]: /tracing/guide/ignoring_apm_resources/
-[11]: /tracing/setup/java/
\ No newline at end of file
+[11]: /tracing/setup/java/
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/nodejs/dd-api.md b/content/en/tracing/trace_collection/custom_instrumentation/nodejs/dd-api.md
index f5203009d3936..4248113f74ded 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/nodejs/dd-api.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/nodejs/dd-api.md
@@ -72,7 +72,7 @@ span.addTags({
{{% tab "Globally" %}}
-You can add tags to every span by configuring them directly on the tracer, either with with the comma-separated `DD_TAGS` environment variable or with the `tags` option on the tracer initialization:
+You can add tags to every span by configuring them directly on the APM SDK, either with the comma-separated `DD_TAGS` environment variable or with the `tags` option on the tracer initialization:
```javascript
// equivalent to DD_TAGS=foo:bar,baz:qux
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/nodejs/otel.md b/content/en/tracing/trace_collection/custom_instrumentation/nodejs/otel.md
index 5a8caa6f7b5c2..4bbf005152178 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/nodejs/otel.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/nodejs/otel.md
@@ -23,7 +23,7 @@ further_reading:
To configure OpenTelemetry to use the Datadog trace provider:
-1. Add your desired manual OpenTelemetry instrumentation to your Node.js code following the [OpenTelemetry Node.js Manual Instrumentation documentation][1]. **Note**: Where those instructions indicate that your code should call the OpenTelemetry SDK, call the Datadog tracing library instead.
+1. Add your desired manual OpenTelemetry instrumentation to your Node.js code following the [OpenTelemetry Node.js Manual Instrumentation documentation][1]. **Note**: Where those instructions indicate that your code should call the OpenTelemetry SDK, call the Datadog APM SDK instead.
2. Add the `dd-trace` module to your package.json:
@@ -76,7 +76,7 @@ function processData(i, param1, param2) {
// Add an attribute to the span
span.setAttribute('app.processedData', result.toString());
-
+
span.end();
return result;
});
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/otel_instrumentation/_index.md b/content/en/tracing/trace_collection/custom_instrumentation/otel_instrumentation/_index.md
index 3b8dd938b5a22..97d02b4d459fe 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/otel_instrumentation/_index.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/otel_instrumentation/_index.md
@@ -1,7 +1,7 @@
---
title: Custom Instrumentation with the OpenTelemetry API
type: multi-code-lang
-description: 'Sending spans from custom instrumentation through the OpenTelemetry API to the Datadog tracing libraries.'
+description: 'Sending spans from custom instrumentation through the OpenTelemetry API to the Datadog APM SDKs.'
aliases:
- /tracing/trace_collection/otel_instrumentation/
- /opentelemetry/otel_tracing/
diff --git a/content/en/tracing/trace_collection/custom_instrumentation/php/dd-api.md b/content/en/tracing/trace_collection/custom_instrumentation/php/dd-api.md
index 1fe1720ad8f6d..4c6021d46f38e 100644
--- a/content/en/tracing/trace_collection/custom_instrumentation/php/dd-api.md
+++ b/content/en/tracing/trace_collection/custom_instrumentation/php/dd-api.md
@@ -29,7 +29,7 @@ If you have not yet read the instructions for auto-instrumentation and setup, st
## Annotations
-If you are using PHP 8, as of v0.84 of the tracer, you can add attributes to your code to instrument it. It is a lighter alternative to [custom instrumentation written in code](#writing-custom-instrumentation). For example, add the `#[DDTrace\Trace]` attribute to methods for Datadog to trace them.
+If you are using PHP 8, as of v0.84 of the APM SDK, you can add attributes to your code to instrument it. It is a lighter alternative to [custom instrumentation written in code](#writing-custom-instrumentation). For example, add the `#[DDTrace\Trace]` attribute to methods for Datadog to trace them.
```php
Support for span links is in beta and requires the
PHP tracer v0.87.2+.
+
Note: Settings must be set on
TracerSettings
before creating the
Tracer
. Changes made to
TracerSettings
properties after the
Tracer
is created are ignored.
@@ -80,7 +80,7 @@ Tracer.Configure(settings);
{{% tab "JSON file" %}}
-To configure the tracer using a JSON file, create `datadog.json` in the instrumented application's directory. The root JSON object must be an object with a key-value pair for each setting. For example:
+To configure the APM SDK using a JSON file, create `datadog.json` in the instrumented application's directory. The root JSON object must be an object with a key-value pair for each setting. For example:
```json
{
@@ -113,7 +113,7 @@ If specified, adds the `env` tag with the specified value to all generated spans
`DD_SERVICE`
: **TracerSettings property**: `ServiceName`
-If specified, sets the service name. Otherwise, the .NET Tracer tries to determine service name automatically from the application name (IIS application name, process entry assembly, or process name). Added in version 1.17.0.
+If specified, sets the service name. Otherwise, the .NET APM SDK tries to determine service name automatically from the application name (IIS application name, process entry assembly, or process name). Added in version 1.17.0.
`DD_VERSION`
: **TracerSettings property**: `ServiceVersion`
@@ -178,7 +178,7 @@ If the **Request** has a header `User-ID`, its value is applied as tag `http.req
If the **Response** has a header `User-ID`, its value is applied as tag `http.response.headers.User-ID`.
Added in version 1.18.3.
Response header support and entries without tag names added in version 1.26.0.
-**Beta**: Starting in version 2.35.0, if [Agent Remote Configuration][16] is enabled where this service runs, you can set `DD_TRACE_HEADER_TAGS` in the [Service Catalog][17] UI.
+**Beta**: Starting in version 2.35.0, if [Agent Remote Configuration][16] is enabled where this service runs, you can set `DD_TRACE_HEADER_TAGS` in the [Service Catalog][17] UI.
`DD_TRACE_CLIENT_IP_ENABLED`
: Enables client IP collection from relevant IP headers.
@@ -198,11 +198,11 @@ If specified, adds all of the specified tags to all generated spans.
Added in version 1.17.0.
`DD_TRACE_LOG_DIRECTORY`
-: Sets the directory for .NET Tracer logs.
+: Sets the directory for .NET APM SDK logs.
**Default**: `%ProgramData%\Datadog .NET Tracer\logs\` on Windows, `/var/log/datadog/dotnet` on Linux
`DD_TRACE_LOGFILE_RETENTION_DAYS`
-: During the tracer's startup, this configuration uses the tracer's current log directory to delete log files the same age and older than the given number of days. Added in version 2.19.0.
+: During the APM SDK's startup, this configuration uses the SDK's current log directory to delete log files the same age and older than the given number of days. Added in version 2.19.0.
**Default**: `31`
`DD_TRACE_LOGGING_RATE`
@@ -309,7 +309,7 @@ The following configuration variables are for features that are available for us
#### Deprecated settings
`DD_TRACE_LOG_PATH`
-: Sets the path for the automatic instrumentation log file and determines the directory of all other .NET Tracer log files. Ignored if `DD_TRACE_LOG_DIRECTORY` is set.
+: Sets the path for the automatic instrumentation log file and determines the directory of all other .NET APM SDK log files. Ignored if `DD_TRACE_LOG_DIRECTORY` is set.
`DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED`
: Enables improved resource names for web spans when set to `true`. Uses route template information where available, adds an additional span for ASP.NET Core integrations, and enables additional tags. Added in version 1.26.0. Enabled by default in 2.0.0
diff --git a/content/en/tracing/trace_collection/library_config/dotnet-framework.md b/content/en/tracing/trace_collection/library_config/dotnet-framework.md
index 3c5078608fa70..6c96390630ef0 100644
--- a/content/en/tracing/trace_collection/library_config/dotnet-framework.md
+++ b/content/en/tracing/trace_collection/library_config/dotnet-framework.md
@@ -1,5 +1,5 @@
---
-title: Configuring the .NET Framework Tracing Library
+title: Configuring the .NET Framework APM SDK
code_lang: dotnet-framework
type: multi-code-lang
code_lang_weight: 70
@@ -39,17 +39,17 @@ further_reading:
text: "OpenTelemetry Environment Variable Configurations"
---
-After you set up the tracing library with your code and configure the Agent to collect APM data, optionally configure the tracing library as desired, including setting up [Unified Service Tagging][4].
+After you set up the APM SDK with your code and configure the Agent to collect APM data, optionally configure the APM SDK as desired, including setting up [Unified Service Tagging][4].
-{{< img src="tracing/dotnet/dotnet_framework_configuration.png" alt=".NET Framework Tracer configuration setting precedence" style="width:100%" >}}
+{{< img src="tracing/dotnet/dotnet_framework_configuration.png" alt=".NET Framework APM SDK configuration setting precedence" style="width:100%" >}}
-You can set configuration settings in the .NET Tracer with any of the following methods:
+You can set configuration settings in the .NET APM SDK with any of the following methods:
{{< tabs >}}
{{% tab "Environment variables" %}}
-To configure the tracer using environment variables, set the variables before launching the instrumented application. To learn how to set environment variables in different environments, see [Configuring process environment variables][1].
+To configure the APM SDK using environment variables, set the variables before launching the instrumented application. To learn how to set environment variables in different environments, see [Configuring process environment variables][1].
[1]: /tracing/trace_collection/dd_libraries/dotnet-framework/#configuring-process-environment-variables
@@ -57,7 +57,7 @@ To configure the tracer using environment variables, set the variables before la
{{% tab "Code" %}}
-To configure the Tracer in application code, create a `TracerSettings` instance from the default configuration sources. Set properties on this `TracerSettings` instance before calling `Tracer.Configure()`. For example:
+To configure the APM SDK in application code, create a `TracerSettings` instance from the default configuration sources. Set properties on this `TracerSettings` instance before calling `Tracer.Configure()`. For example:
Note: Settings must be set on
TracerSettings
before creating the
Tracer
. Changes made to
TracerSettings
properties after the
Tracer
is created are ignored.
@@ -84,7 +84,7 @@ Tracer.Configure(settings);
{{% tab "web.config" %}}
-To configure the Tracer using an `app.config` or `web.config` file, use the `
` section. For example:
+To configure the APM SDK using an `app.config` or `web.config` file, use the `` section. For example:
```xml
@@ -101,7 +101,7 @@ To configure the Tracer using an `app.config` or `web.config` file, use the `
-If specified, sets the service name. Otherwise, the .NET Tracer tries to determine service name automatically from application name (IIS application name, process entry assembly, or process name). Added in version 1.17.0.
+If specified, sets the service name. Otherwise, the .NET APM SDK tries to determine service name automatically from application name (IIS application name, process entry assembly, or process name). Added in version 1.17.0.
`DD_VERSION`
: **TracerSettings property**: `ServiceVersion`
@@ -214,7 +214,7 @@ If specified, adds all of the specified tags to all generated spans.
Added in version 1.17.0.
`DD_TRACE_LOG_DIRECTORY`
-: Sets the directory for .NET Tracer logs.
+: Sets the directory for .NET APM SDK logs.
**Default**: `%ProgramData%\Datadog .NET Tracer\logs\`
`DD_TRACE_LOGFILE_RETENTION_DAYS`
@@ -325,7 +325,7 @@ The following configuration variables are for features that are available for us
#### Deprecated settings
`DD_TRACE_LOG_PATH`
-: Sets the path for the automatic instrumentation log file and determines the directory of all other .NET Tracer log files. Ignored if `DD_TRACE_LOG_DIRECTORY` is set.
+: Sets the path for the automatic instrumentation log file and determines the directory of all other .NET APM SDK log files. Ignored if `DD_TRACE_LOG_DIRECTORY` is set.
`DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED`
: Enables improved resource names for web spans when set to `true`. Uses route template information where available, adds an additional span for ASP.NET Core integrations, and enables additional tags. Added in version 1.26.0. Enabled by default in 2.0.0
diff --git a/content/en/tracing/trace_collection/library_config/go.md b/content/en/tracing/trace_collection/library_config/go.md
index 8eb34fd7fdcd5..53e2a8d2e4529 100644
--- a/content/en/tracing/trace_collection/library_config/go.md
+++ b/content/en/tracing/trace_collection/library_config/go.md
@@ -1,5 +1,5 @@
---
-title: Configuring the Go Tracing Library
+title: Configuring the Go APM SDK
code_lang: go
type: multi-code-lang
code_lang_weight: 20
@@ -21,13 +21,13 @@ further_reading:
text: "OpenTelemetry Environment Variable Configurations"
---
-After you [set up the tracing library with your code, configure the Agent to collect APM data, and activate the Go integration][1], optionally configure the tracing library as desired.
+After you [set up the APM SDK with your code, configure the Agent to collect APM data, and activate the Go integration][1], optionally configure the APM SDK as desired.
Datadog recommends using `DD_ENV`, `DD_SERVICE`, and `DD_VERSION` to set `env`, `service`, and `version` for your services.
-Read the [Unified Service Tagging][2] documentation for recommendations on how to configure these environment variables. These variables are available for versions 1.24.0+ of the Go tracer.
+Read the [Unified Service Tagging][2] documentation for recommendations on how to configure these environment variables. These variables are available for versions 1.24.0+ of the Go APM SDK.
-You may also elect to provide `env`, `service`, and `version` through the tracer's API:
+You may also elect to provide `env`, `service`, and `version` through the APM SDK's API:
```go
package main
@@ -49,7 +49,7 @@ func main() {
}
```
-The Go tracer supports additional environment variables and functions for configuration.
+The Go APM SDK supports additional environment variables and functions for configuration.
See all available options in the [configuration documentation][3].
`DD_VERSION`
@@ -114,7 +114,7 @@ Enable startup configuration and the diagnostic log.
`DD_TRACE_DEBUG`
: **Default**: `false`
-Enable debug logging in the tracer.
+Enable debug logging in the APM SDK.
`DD_TRACE_ENABLED`
: **Default**: `true`
@@ -162,7 +162,7 @@ Configures trace header injection and extraction style. See [Propagating Go Trac
## Configure APM environment name
-The [APM environment name][7] may be configured [in the Agent][8] or using the [WithEnv][3] start option of the tracer.
+The [APM environment name][7] may be configured [in the Agent][8] or using the [WithEnv][3] start option of the APM SDK.
## Further reading
diff --git a/content/en/tracing/trace_collection/library_config/java.md b/content/en/tracing/trace_collection/library_config/java.md
index 663820de8b48b..3ff6be5f01b1d 100644
--- a/content/en/tracing/trace_collection/library_config/java.md
+++ b/content/en/tracing/trace_collection/library_config/java.md
@@ -1,5 +1,5 @@
---
-title: Configuring the Java Tracing Library
+title: Configuring the Java APM SDK
code_lang: java
type: multi-code-lang
code_lang_weight: 0
@@ -18,7 +18,7 @@ further_reading:
text: "OpenTelemetry Environment Variable Configurations"
---
-After you set up the tracing library with your code and configure the Agent to collect APM data, optionally configure the tracing library as desired, including setting up [Unified Service Tagging][1].
+After you set up the APM SDK with your code and configure the Agent to collect APM data, optionally configure the APM SDK as desired, including setting up [Unified Service Tagging][1].
All configuration options below have system property and environment variable equivalents.
If the same key type is set for both, the system property configuration takes priority.
@@ -32,7 +32,7 @@ Unless otherwise stated, you can convert between system properties and environme
- To set an environment variable as a system property, lowercase the variable name and replace `_` with `.`
For example, `DD_TAGS` becomes `dd.tags`.
-**Note**: When using the Java tracer's system properties, list the properties before `-jar`. This ensures the properties are read in as JVM options.
+**Note**: When using the Java APM SDK's system properties, list the properties before `-jar`. This ensures the properties are read in as JVM options.
## Configuration options
@@ -154,7 +154,7 @@ List of class/interface and methods to trace. Similar to adding `@Trace`, but wi
: **Environment Variable**: `DD_TRACE_CLASSES_EXCLUDE`
**Default**: `null`
**Example**: `package.ClassName,package.ClassName$Nested,package.Foo*,package.other.*`
-A list of fully qualified classes (that may end with a wildcard to denote a prefix) which will be ignored (not modified) by the tracer. Must use the jvm internal representation for names (eg package.ClassName$Nested and not package.ClassName.Nested)
+A list of fully qualified classes (that may end with a wildcard to denote a prefix) which will be ignored (not modified) by the APM SDK. Must use the jvm internal representation for names (eg package.ClassName$Nested and not package.ClassName.Nested)
`dd.trace.partial.flush.min.spans`
: **Environment Variable**: `DD_TRACE_PARTIAL_FLUSH_MIN_SPANS`
@@ -190,7 +190,7 @@ When set to `true`, the query string parameters are added to Elasticsearch and O
`dd.trace.health.metrics.enabled`
: **Environment Variable**: `DD_TRACE_HEALTH_METRICS_ENABLED`
**Default**: `true`
-When set to `true` sends tracer health metrics
+When set to `true` sends APM SDK health metrics
`dd.trace.health.metrics.statsd.host`
: **Environment Variable**: `DD_TRACE_HEALTH_METRICS_STATSD_HOST`
@@ -282,7 +282,7 @@ A regex to redact sensitive data from incoming requests' query string reported i
`dd.integration.opentracing.enabled`
: **Environment Variable**: `DD_INTEGRATION_OPENTRACING_ENABLED`
**Default**: `true`
-By default the tracing client detects if a GlobalTracer is being loaded and dynamically registers a tracer into it. By turning this to false, this removes any tracer dependency on OpenTracing.
+By default the tracing client detects if a GlobalTracer is being loaded and dynamically registers an APM SDK into it. By turning this to false, this removes any APM SDK dependency on OpenTracing.
`dd.hystrix.tags.enabled`
: **Environment Variable**: `DD_HYSTRIX_TAGS_ENABLED`
@@ -307,17 +307,17 @@ When `true`, user principal is collected. Available for versions 0.61+.
`dd.instrumentation.telemetry.enabled`
: **Environment Variable**: `DD_INSTRUMENTATION_TELEMETRY_ENABLED`
**Default**: `true`
-When `true`, the tracer collects [telemetry data][8]. Available for versions 0.104+. Defaults to `true` for versions 0.115+.
+When `true`, the APM SDK collects [telemetry data][8]. Available for versions 0.104+. Defaults to `true` for versions 0.115+.
`dd.trace.128.bit.traceid.generation.enabled`
: **Environment Variable**: `DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED`
**Default**: `true`
-When `true`, the tracer generates 128 bit Trace IDs, and encodes Trace IDs as 32 lowercase hexadecimal characters with zero padding.
+When `true`, the APM SDK generates 128 bit Trace IDs, and encodes Trace IDs as 32 lowercase hexadecimal characters with zero padding.
`dd.trace.128.bit.traceid.logging.enabled`
: **Environment Variable**: `DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED`
**Default**: `false`
-When `true`, the tracer will inject 128 bit Trace IDs as 32 lowercase hexadecimal characters with zero padding, and 64 bit Trace IDs as decimal numbers. Otherwise, the tracer always injects Trace IDs as decimal numbers.
+When `true`, the APM SDK injects 128 bit Trace IDs as 32 lowercase hexadecimal characters with zero padding, and 64 bit Trace IDs as decimal numbers. Otherwise, the APM SDK always injects Trace IDs as decimal numbers.
`dd.trace.otel.enabled`
: **Environment Variable**: `DD_TRACE_OTEL_ENABLED`
@@ -519,4 +519,4 @@ Deprecated since version 1.9.0
[14]: /integrations/java/?tab=host#metric-collection
[15]: /tracing/trace_collection/trace_context_propagation/java/
[16]: /tracing/trace_collection/custom_instrumentation/java/otel/
-[17]: /opentelemetry/interoperability/environment_variable_support
\ No newline at end of file
+[17]: /opentelemetry/interoperability/environment_variable_support
diff --git a/content/en/tracing/trace_collection/library_config/nodejs.md b/content/en/tracing/trace_collection/library_config/nodejs.md
index fe0369557b3e4..98714836f63f2 100644
--- a/content/en/tracing/trace_collection/library_config/nodejs.md
+++ b/content/en/tracing/trace_collection/library_config/nodejs.md
@@ -1,5 +1,5 @@
---
-title: Configuring the Node.js Tracing Library
+title: Configuring the Node.js APM SDK
code_lang: nodejs
type: multi-code-lang
code_lang_weight: 30
@@ -24,9 +24,9 @@ further_reading:
text: "OpenTelemetry Environment Variable Configurations"
---
-After you set up the tracing library with your code and configure the Agent to collect APM data, optionally configure the tracing library as desired, including setting up [Unified Service Tagging][1].
+After you set up the APM SDK with your code and configure the Agent to collect APM data, optionally configure the APM SDK as desired, including setting up [Unified Service Tagging][1].
-Tracer settings can be configured with the following environment variables:
+APM SDK settings can be configured with the following environment variables:
### Tagging
@@ -75,7 +75,7 @@ When `true`, OpenTelemetry-based tracing for [custom][15] instrumentation is ena
`DD_TRACE_DEBUG`
: **Configuration**: N/A
**Default**: `false`
-Enable debug logging in the tracer.
+Enable debug logging in the APM SDK.
`DD_TRACING_ENABLED`
: **Configuration**: N/A
@@ -85,22 +85,22 @@ Whether to enable tracing.
`DD_TRACE_AGENT_URL`
: **Configuration**: `url`
**Default**: `http://localhost:8126`
-The URL of the Trace Agent that the tracer submits to. Takes priority over hostname and port, if set. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_TRACE_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it. Supports Unix Domain Sockets in combination with the `apm_config.receiver_socket` in your `datadog.yaml` file, or the `DD_APM_RECEIVER_SOCKET` environment variable.
+The URL of the Trace Agent that the APM SDK submits to. Takes priority over hostname and port, if set. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_TRACE_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it. Supports Unix Domain Sockets in combination with the `apm_config.receiver_socket` in your `datadog.yaml` file, or the `DD_APM_RECEIVER_SOCKET` environment variable.
`DD_TRACE_AGENT_HOSTNAME`
: **Configuration**: `hostname`
**Default**: `localhost`
-The address of the Agent that the tracer submits to.
+The address of the Agent that the APM SDK submits to.
`DD_TRACE_AGENT_PORT`
: **Configuration**: `port`
**Default**: `8126`
-The port of the Trace Agent that the tracer submits to. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_TRACE_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it.
+The port of the Trace Agent that the APM SDK submits to. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_TRACE_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it.
`DD_DOGSTATSD_PORT`
: **Configuration**: `dogstatsd.port`
**Default**: `8125`
-The port of the DogStatsD Agent that metrics are submitted to. If the [Agent configuration][13] sets `dogstatsd_port` or `DD_DOGSTATSD_PORT` to something other than the default `8125`, then this tracing library `DD_DOGSTATSD_PORT` must match it.
+The port of the DogStatsD Agent that metrics are submitted to. If the [Agent configuration][13] sets `dogstatsd_port` or `DD_DOGSTATSD_PORT` to something other than the default `8125`, then this APM SDK `DD_DOGSTATSD_PORT` must match it.
`DD_LOGS_INJECTION`
: **Configuration**: `logInjection`
@@ -120,7 +120,7 @@ The maximum number of traces per second per service instance.
`DD_TRACE_SAMPLING_RULES`
: **Configuration**: `samplingRules`
**Default**: `[]`
-Sampling rules to apply to priority sampling. A JSON array of objects. Each object must have a `sample_rate` value between 0.0 and 1.0 (inclusive). Each rule has optional `name` and `service` fields, which are regex strings to match against a trace's `service` and `name`. Rules are applied in configured order to determine the trace's sample rate. If omitted, the tracer defers to the Agent to dynamically adjust sample rate across all traces.
+Sampling rules to apply to priority sampling. A JSON array of objects. Each object must have a `sample_rate` value between 0.0 and 1.0 (inclusive). Each rule has optional `name` and `service` fields, which are regex strings to match against a trace's `service` and `name`. Rules are applied in configured order to determine the trace's sample rate. If omitted, the APM SDK defers to the Agent to dynamically adjust sample rate across all traces.
`DD_SPAN_SAMPLING_RULES`
: **Configuration**: `spanSamplingRules`
@@ -150,17 +150,17 @@ Provide service names for each plugin. Accepts comma separated `plugin:service-n
: **Configuration**: N/A
**Default**: N/A
**Example**: `DD_TRACE_DISABLED_PLUGINS=express,dns`
-A comma-separated string of integration names automatically disabled when the tracer is initialized.
+A comma-separated string of integration names automatically disabled when the APM SDK is initialized.
`DD_TRACE_LOG_LEVEL`
: **Configuration**: `logLevel`
**Default**: `debug`
-A string for the minimum log level for the tracer to use when debug logging is enabled, for example, `error`, `debug`.
+A string for the minimum log level for the APM SDK to use when debug logging is enabled, for example, `error`, `debug`.
Flush Interval
: **Configuration**: `flushInterval`
**Default**: `2000`
-Interval in milliseconds at which the tracer submits traces to the Agent.
+Interval in milliseconds at which the APM SDK submits traces to the Agent.
`DD_TRACE_PARTIAL_FLUSH_MIN_SPANS`
: **Configuration**: `flushMinSpans`
@@ -210,7 +210,7 @@ Whether to enable automatic instrumentation of external libraries using the buil
`DD_TRACE_STARTUP_LOGS`
: **Configuration**: `startupLogs`
**Default**: `false`
-Enable tracer startup configuration and diagnostic log.
+Enable APM SDK startup configuration and diagnostic log.
`DD_DBM_PROPAGATION_MODE`
: **Configuration**: `dbmPropagationMode`
diff --git a/content/en/tracing/trace_collection/library_config/php.md b/content/en/tracing/trace_collection/library_config/php.md
index 0ddda3fbd9bf4..015bed56dc7bc 100644
--- a/content/en/tracing/trace_collection/library_config/php.md
+++ b/content/en/tracing/trace_collection/library_config/php.md
@@ -1,5 +1,5 @@
---
-title: Configuring the PHP Tracing Library
+title: Configuring the PHP APM SDK
code_lang: php
type: multi-code-lang
code_lang_weight: 40
@@ -24,9 +24,9 @@ further_reading:
text: "OpenTelemetry Environment Variable Configurations"
---
-After you set up the tracing library with your code and configure the Agent to collect APM data, optionally configure the tracing library as desired, including setting up [Unified Service Tagging][1].
+After you set up the APM SDK with your code and configure the Agent to collect APM data, optionally configure the APM SDK as desired, including setting up [Unified Service Tagging][1].
-The PHP tracer can be configured using environment variables and INI settings.
+The PHP APM SDK can be configured using environment variables and INI settings.
INI settings can be configured globally, for example, in the `php.ini` file, or for a specific web server or virtual host.
@@ -34,7 +34,7 @@ INI settings can be configured globally, for example, in the `php.ini` file, or
### Apache
-For Apache with php-fpm, use the `env` directive in your `www.conf` configuration file to configure the PHP tracer, for example:
+For Apache with php-fpm, use the `env` directive in your `www.conf` configuration file to configure the PHP APM SDK, for example:
```
; Example of passing the host environment variable SOME_ENV
@@ -97,7 +97,7 @@ The Agent host name.
`DD_AUTOFINISH_SPANS`
: **INI**: `datadog.autofinish_spans`
**Default**: `0`
-Whether spans are automatically finished when the tracer is flushed.
+Whether spans are automatically finished when the APM SDK is flushed.
`DD_DISTRIBUTED_TRACING`
: **INI**: `datadog.distributed_tracing`
@@ -190,7 +190,7 @@ Change the default name of an APM integration. Rename one or more integrations a
`DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED`
: **INI**: `datadog.trace.128_bit_traceid_generation_enabled`
**Default**: `true`
-When true, the tracer generates 128 bit Trace IDs, and encodes Trace IDs as 32 lowercase hexadecimal characters with zero padding.
+When true, the APM SDK generates 128 bit Trace IDs, and encodes Trace IDs as 32 lowercase hexadecimal characters with zero padding.
`DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED`
: **INI**: `datadog.trace.128_bit_traceid_logging_enabled`
@@ -202,7 +202,7 @@ When true, the trace ID is printed as a full 128-bit trace ID in hexadecimal for
`DD_TRACE_HEALTH_METRICS_ENABLED`
: **INI**: `datadog.trace_health_metrics_enabled`
**Default**: `false`
-When enabled, the tracer sends stats to DogStatsD. In addition, where `sigaction` is available at build time, the tracer sends uncaught exception metrics upon segfaults.
+When enabled, the APM SDK sends stats to DogStatsD. In addition, where `sigaction` is available at build time, the APM SDK sends uncaught exception metrics upon segfaults.
`DD_TRACE_AGENT_CONNECT_TIMEOUT`
: **INI**: `datadog.trace.agent_connect_timeout`
@@ -237,7 +237,7 @@ The port used to connect to DogStatsD, used in combination with `DD_AGENT_HOST`
`DD_TRACE_AUTO_FLUSH_ENABLED`
: **INI**: `datadog.trace.auto_flush_enabled`
**Default**: `0`
-Automatically flush the tracer when all the spans are closed; set to `1` in conjunction with `DD_TRACE_GENERATE_ROOT_SPAN=0` to trace [long-running processes][14].
+Automatically flush the APM SDK when all the spans are closed; set to `1` in conjunction with `DD_TRACE_GENERATE_ROOT_SPAN=0` to trace [long-running processes][14].
`DD_TRACE_CLI_ENABLED`
: **INI**: `datadog.trace.cli_enabled`
@@ -267,7 +267,7 @@ Indicates whether to trace a forked process. Set to `1` to trace forked processe
`DD_TRACE_ENABLED`
: **INI**: `datadog.trace.enabled`
**Default**: `1`
-Enable the tracer globally.
+Enable the APM SDK globally.
`DD_TRACE_GENERATE_ROOT_SPAN`
: **INI**: `datadog.trace.generate_root_span`
@@ -473,7 +473,7 @@ A comma-separated list of WordPress action hooks to be instrumented. This featur
`DD_TRACE_WORDPRESS_CALLBACKS`
: **INI**: `datadog.trace.wordpress_callbacks`
-**Default**: `true` for PHP tracer >= v1.0
+**Default**: `true` for PHP APM SDK >= v1.0
Enables WordPress action hook callbacks instrumentation. This feature is only available when `DD_TRACE_WORDPRESS_ENHANCED_INTEGRATION` is enabled. Added in version `0.91.0`.
`DD_DBM_PROPAGATION_MODE`
@@ -628,7 +628,7 @@ When the application runs in a docker container, the path `/proc/self` should al
### Headers extraction and injection
-Read [Trace Context Propagation][11] for information about configuring the PHP tracing library to extract and inject headers for propagating distributed trace context.
+Read [Trace Context Propagation][11] for information about configuring the PHP APM SDK to extract and inject headers for propagating distributed trace context.
## Further Reading
{{< partial name="whats-next/whats-next.html" >}}
diff --git a/content/en/tracing/trace_collection/library_config/python.md b/content/en/tracing/trace_collection/library_config/python.md
index 25ccc4bae76d8..5495fe30057bd 100644
--- a/content/en/tracing/trace_collection/library_config/python.md
+++ b/content/en/tracing/trace_collection/library_config/python.md
@@ -1,5 +1,5 @@
---
-title: Configuring the Python Tracing Library
+title: Configuring the Python APM SDK
code_lang: python
type: multi-code-lang
code_lang_weight: 20
@@ -24,13 +24,13 @@ further_reading:
text: "OpenTelemetry Environment Variable Configurations"
---
-After you set up the tracing library with your code and configure the Agent to collect APM data, optionally configure the tracing library as desired, including setting up [Unified Service Tagging][1].
+After you set up the APM SDK with your code and configure the Agent to collect APM data, optionally configure the APM SDK as desired, including setting up [Unified Service Tagging][1].
When using **ddtrace-run**, the following [environment variable options][2] can be used:
`DD_TRACE_DEBUG`
: **Default**: `false`
-Enable debug logging in the tracer.
+Enable debug logging in the APM SDK.
`DD_PATCH_MODULES`
: Override the modules patched for this application execution. Follow the format: `DD_PATCH_MODULES=module:patch,module:patch...`
@@ -88,25 +88,25 @@ Enable web framework and library instrumentation. When `false`, the application
`DD_AGENT_HOST`
: **Default**: `localhost`
-Override the address of the trace Agent host that the default tracer attempts to submit traces to.
+Override the address of the trace Agent host that the default APM SDK attempts to submit traces to.
`DD_AGENT_PORT`
: **Default**: `8126`
-Overrides the port that the default tracer submit traces to. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it.
+Overrides the port that the default APM SDK submit traces to. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it.
`DD_TRACE_AGENT_URL`
-: The URL of the Trace Agent that the tracer submits to. If set, this takes priority over hostname and port. Supports Unix Domain Sockets (UDS) in combination with the `apm_config.receiver_socket` configuration in your `datadog.yaml` file or the `DD_APM_RECEIVER_SOCKET` environment variable set on the Datadog Agent. For example, `DD_TRACE_AGENT_URL=http://localhost:8126` for HTTP URL and `DD_TRACE_AGENT_URL=unix:///var/run/datadog/apm.socket` for UDS. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it.
+: The URL of the Trace Agent that the APM SDK submits to. If set, this takes priority over hostname and port. Supports Unix Domain Sockets (UDS) in combination with the `apm_config.receiver_socket` configuration in your `datadog.yaml` file or the `DD_APM_RECEIVER_SOCKET` environment variable set on the Datadog Agent. For example, `DD_TRACE_AGENT_URL=http://localhost:8126` for HTTP URL and `DD_TRACE_AGENT_URL=unix:///var/run/datadog/apm.socket` for UDS. If the [Agent configuration][13] sets `receiver_port` or `DD_APM_RECEIVER_PORT` to something other than the default `8126`, then `DD_AGENT_PORT` or `DD_TRACE_AGENT_URL` must match it.
`DD_DOGSTATSD_URL`
-: The URL used to connect to the Datadog Agent for DogStatsD metrics. If set, this takes priority over hostname and port. Supports Unix Domain Sockets (UDS) in combination with the `dogstatsd_socket` configuration in your `datadog.yaml` file or the `DD_DOGSTATSD_SOCKET` environment variable set on the Datadog Agent. For example, `DD_DOGSTATSD_URL=udp://localhost:8126` for UDP URL and `DD_DOGSTATSD_URL=unix:///var/run/datadog/dsd.socket` for UDS. If the [Agent configuration][13] sets `dogstatsd_port` or `DD_DOGSTATSD_PORT` to something other than the default `8125`, then this tracing library `DD_DOGSTATSD_URL` or `DD_DOGSTATSD_PORT` must match it.
+: The URL used to connect to the Datadog Agent for DogStatsD metrics. If set, this takes priority over hostname and port. Supports Unix Domain Sockets (UDS) in combination with the `dogstatsd_socket` configuration in your `datadog.yaml` file or the `DD_DOGSTATSD_SOCKET` environment variable set on the Datadog Agent. For example, `DD_DOGSTATSD_URL=udp://localhost:8126` for UDP URL and `DD_DOGSTATSD_URL=unix:///var/run/datadog/dsd.socket` for UDS. If the [Agent configuration][13] sets `dogstatsd_port` or `DD_DOGSTATSD_PORT` to something other than the default `8125`, then this APM SDK `DD_DOGSTATSD_URL` or `DD_DOGSTATSD_PORT` must match it.
`DD_DOGSTATSD_HOST`
: **Default**: `localhost`
-Override the address of the trace Agent host that the default tracer attempts to submit DogStatsD metrics to. Use `DD_AGENT_HOST` to override `DD_DOGSTATSD_HOST`.
+Override the address of the trace Agent host that the default APM SDK attempts to submit DogStatsD metrics to. Use `DD_AGENT_HOST` to override `DD_DOGSTATSD_HOST`.
`DD_DOGSTATSD_PORT`
: **Default**: `8125`
-Override the port that the default tracer submits DogStatsD metrics to. If the [Agent configuration][13] sets `dogstatsd_port` or `DD_DOGSTATSD_PORT` to something other than the default `8125`, then this tracing library `DD_DOGSTATSD_PORT` or `DD_DOGSTATSD_URL` must match it.
+Override the port that the default APM SDK submits DogStatsD metrics to. If the [Agent configuration][13] sets `dogstatsd_port` or `DD_DOGSTATSD_PORT` to something other than the default `8125`, then this APM SDK `DD_DOGSTATSD_PORT` or `DD_DOGSTATSD_URL` must match it.
`DD_LOGS_INJECTION`
: **Default**: `false`
diff --git a/content/en/tracing/trace_collection/library_config/ruby.md b/content/en/tracing/trace_collection/library_config/ruby.md
index c1a68a8fc9daa..9115dd31b0388 100644
--- a/content/en/tracing/trace_collection/library_config/ruby.md
+++ b/content/en/tracing/trace_collection/library_config/ruby.md
@@ -1,5 +1,5 @@
---
-title: Configuring the Ruby Tracing Library
+title: Configuring the Ruby APM SDK
code_lang: ruby
type: multi-code-lang
code_lang_weight: 30
@@ -15,9 +15,9 @@ further_reading:
text: "OpenTelemetry Environment Variable Configurations"
---
-After you set up the tracing library with your code and configure the Agent to collect APM data, optionally configure the tracing library as desired, including setting up [Unified Service Tagging][1].
+After you set up the APM SDK with your code and configure the Agent to collect APM data, optionally configure the APM SDK as desired, including setting up [Unified Service Tagging][1].
-For information about configuring the Ruby tracing library, see [Additional Ruby configuration][2].
+For information about configuring the Ruby APM SDK, see [Additional Ruby configuration][2].
## Further Reading
{{< partial name="whats-next/whats-next.html" >}}
diff --git a/content/en/tracing/trace_collection/proxy_setup/_index.md b/content/en/tracing/trace_collection/proxy_setup/_index.md
index 6434c82224a23..47ecdf581091f 100644
--- a/content/en/tracing/trace_collection/proxy_setup/_index.md
+++ b/content/en/tracing/trace_collection/proxy_setup/_index.md
@@ -285,8 +285,8 @@ To configure your sampling rate with `DD_TRACE_SAMPLING_RULES`, use one of the f
Note: The variables DD_AGENT_HOST
, DD_TRACE_AGENT_PORT
and DD_TRACE_AGENT_URL
do not apply to Envoy, as the address of the Datadog Agent is configured using the cluster
settings.
-The available [environment variables][2] depend on the version of the C++ tracer embedded in Envoy.
-The version of the C++ tracer can be found in the logs, indicated by the line starting with "DATADOG TRACER CONFIGURATION".
+The available [environment variables][2] depend on the version of the C++ APM SDK embedded in Envoy.
+The version of the C++ APM SDK can be found in the logs, indicated by the line starting with "DATADOG TRACER CONFIGURATION".
[1]: /tracing/trace_pipeline/ingestion_mechanisms/#in-the-agent
[2]: /tracing/setup/cpp/#environment-variables
diff --git a/content/en/tracing/trace_collection/runtime_config/_index.md b/content/en/tracing/trace_collection/runtime_config/_index.md
index 561162f903d01..b25f5a726f921 100644
--- a/content/en/tracing/trace_collection/runtime_config/_index.md
+++ b/content/en/tracing/trace_collection/runtime_config/_index.md
@@ -43,7 +43,7 @@ You can tell when the configuration changes have been successfully applied by re
## Supported configuration options
-The following options are supported with configuration at runtime. The required tracer version is listed for each language:
+The following options are supported with configuration at runtime. The required APM SDK version is listed for each language:
| Option | Java | Javascript | Python | .NET | Ruby | Go | C++ |
|----------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------------|----------|-----------|-----------|-----------|-|
diff --git a/content/en/tracing/trace_collection/span_links/_index.md b/content/en/tracing/trace_collection/span_links/_index.md
index 26360be5ce284..47ef4f0e82f30 100644
--- a/content/en/tracing/trace_collection/span_links/_index.md
+++ b/content/en/tracing/trace_collection/span_links/_index.md
@@ -48,9 +48,9 @@ If your application is instrumented with:
**Note***: This section documents minimum support for generating span links with Datadog APM client libraries (with the OpenTelemetry API). Span links generated by the OpenTelemetry SDK are sent to Datadog through [OTLP Ingest][8].
-Agent v7.52.0 or greater is required to generate span links using [Datadog tracing libraries][7]. Support for span links was introduced in the following releases:
+Agent v7.52.0 or greater is required to generate span links using [Datadog APM SDKs][7]. Support for span links was introduced in the following releases:
-| Language | Minimum tracing library version |
+| Language | Minimum APM SDK version |
|-----------|---------------------------------|
| C++/Proxy | Not yet supported |
| Go | 1.61.0 |
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/cpp.md b/content/en/tracing/trace_collection/trace_context_propagation/cpp.md
index 35c110372527f..832a39cd0eef4 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/cpp.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/cpp.md
@@ -14,7 +14,7 @@ further_reading:
## Overview
-Datadog APM tracer supports [B3][11] and [W3C][1] headers extraction and injection for distributed tracing.
+Datadog APM APM SDK supports [B3][11] and [W3C][1] headers extraction and injection for distributed tracing.
Distributed headers injection and extraction is controlled by configuring injection/extraction styles. The supported styles for C++ are:
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/dotnet.md b/content/en/tracing/trace_collection/trace_context_propagation/dotnet.md
index 1626bcdcb6e30..cc8247024bb5a 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/dotnet.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/dotnet.md
@@ -12,12 +12,11 @@ further_reading:
text: 'Interoperability of OpenTelemetry API and Datadog instrumented traces'
---
-
-The Datadog APM Tracer supports [B3][5] and [W3C Trace Context][6] headers extraction and injection for distributed tracing.
+The Datadog APM SDK supports [B3][5] and [W3C Trace Context][6] header extraction and injection for distributed tracing.
You can configure injection and extraction styles for distributed headers.
-The .NET Tracer supports the following styles:
+The .NET APM SDK supports the following styles:
- W3C Trace Context: `tracecontext` (`W3C` alias is deprecated)
- Datadog: `datadog`
@@ -31,7 +30,7 @@ You can use the following environment variables to configure injection and extra
The environment variable values are comma-separated lists of header styles enabled for injection or extraction. If multiple extraction styles are enabled, the extraction attempt is completed in the order of configured styles, and uses the first successful extracted value.
-**Notes**:
+**Notes**:
- Starting from version [2.48.0](https://github.com/DataDog/dd-trace-dotnet/releases/tag/v2.48.0), the default propagation style is `datadog, tracecontext`, so the Datadog headers are used, followed by the W3C Trace Context. Prior to version 2.48.0, the order was `tracecontext, Datadog` for both extraction and injection propagation. Prior to version [2.22.0](https://github.com/DataDog/dd-trace-dotnet/releases/tag/v2.22.0), only the `Datadog` injection style was enabled.
- Starting from version [2.42.0](https://github.com/DataDog/dd-trace-dotnet/releases/tag/v2.42.0), when multiple extractors are specified, the `DD_TRACE_PROPAGATION_EXTRACT_FIRST=true` configuration specifies whether context extraction should exit immediately upon detecting the first valid `tracecontext`. The default value is `false`.
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/java.md b/content/en/tracing/trace_collection/trace_context_propagation/java.md
index 4ba5853a9b7df..fde266a6d5ad4 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/java.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/java.md
@@ -13,11 +13,11 @@ further_reading:
---
-The Datadog APM Tracer supports [B3][13] and [W3C Trace Context][14] header extraction and injection for distributed tracing.
+The Datadog APM SDK supports [B3][13] and [W3C Trace Context][14] header extraction and injection for distributed tracing.
You can configure injection and extraction styles for distributed headers.
-The Java Tracer supports the following styles:
+The Java APM SDK supports the following styles:
- Datadog: `datadog`
- B3 Multi Header: `b3multi` (`b3` alias is deprecated)
@@ -40,7 +40,7 @@ The value of the property or environment variable is a comma (or space) separate
When multiple extraction styles are enabled, the extraction attempt is done on the order those styles are configured, using the first successful extracted value. If later valid trace contexts are found, they are terminated and appended as span links. Moreover, if the `tracecontext` style is enabled, W3C Tracestate is propagated if W3C Traceparent matches the extracted context.
-For reference details about the context propagation settings and other configuration, read [Java Tracing Library Configuration][1].
+For reference details about the context propagation settings and other configuration, read [Java APM SDK Configuration][1].
## Further Reading
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/nodejs.md b/content/en/tracing/trace_collection/trace_context_propagation/nodejs.md
index 295df5077f550..d81963aa461f6 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/nodejs.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/nodejs.md
@@ -12,11 +12,11 @@ further_reading:
text: 'Interoperability of OpenTelemetry API and Datadog instrumented traces'
---
-The Datadog APM Tracer supports [B3][5] and [W3C Trace Context][6] header extraction and injection for distributed tracing.
+The Datadog APM SDK supports [B3][5] and [W3C Trace Context][6] header extraction and injection for distributed tracing.
You can configure injection and extraction styles for distributed headers.
-The Node.js Tracer supports the following styles:
+The Node.js SDK supports the following styles:
- Datadog: `datadog`
- B3 Multi Header: `b3multi` (`B3` alias is deprecated)
@@ -25,7 +25,7 @@ The Node.js Tracer supports the following styles:
The default setting for both injection and extraction style is `datadog,tracecontext`.
-For more information about the context propagation settings, read [Node.js Tracing Library Configuration][1].
+For more information about the context propagation settings, read [Node.js APM SDK Configuration][1].
## Further Reading
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/php.md b/content/en/tracing/trace_collection/trace_context_propagation/php.md
index ce2ab218cbe74..35b0a779bf47d 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/php.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/php.md
@@ -12,27 +12,27 @@ further_reading:
text: 'Interoperability of OpenTelemetry API and Datadog instrumented traces'
---
-The Datadog APM Tracer supports [B3][7] and [W3C Trace Context][10] headers extraction and injection for distributed tracing.
+The Datadog APM SDK supports [B3][7] and [W3C Trace Context][10] headers extraction and injection for distributed tracing.
You can configure injection and extraction styles for distributed headers.
-The PHP Tracer supports the following styles:
+The PHP APM SDK supports the following styles:
- Datadog: `datadog`
- W3C Trace Context: `tracecontext`
- B3 Multi Header: `b3multi` (`B3` alias is deprecated)
- B3 Single Header: `B3 single header`
-You can use the following environment variables to configure the PHP tracing library injection and extraction styles. For instance:
+You can use the following environment variables to configure the PHP APM SDK injection and extraction styles. For instance:
- `DD_TRACE_PROPAGATION_STYLE_INJECT=datadog,tracecontext,B3 single header`
- `DD_TRACE_PROPAGATION_STYLE_EXTRACT=datadog,tracecontext,B3 single header`
-The environment variable values are comma-separated lists of header styles enabled for injection or extraction. The default style setting is `datadog,tracecontext` (for PHP tracer versions prior to v0.98.0, the default setting is `tracecontext,Datadog`).
+The environment variable values are comma-separated lists of header styles enabled for injection or extraction. The default style setting is `datadog,tracecontext` (for PHP APM SDK versions prior to v0.98.0, the default setting is `tracecontext,Datadog`).
If multiple extraction styles are enabled, the extraction attempt is done on the order those styles are configured and first successful extracted value is used.
-When a new PHP script is launched, the tracer automatically checks for the presence of Datadog headers for distributed tracing:
+When a new PHP script is launched, the APM SDK automatically checks for the presence of Datadog headers for distributed tracing:
- `x-datadog-trace-id` (environment variable: `HTTP_X_DATADOG_TRACE_ID`)
- `x-datadog-parent-id` (environment variable: `HTTP_X_DATADOG_PARENT_ID`)
- `x-datadog-origin` (environment variable: `HTTP_X_DATADOG_ORIGIN`)
@@ -76,7 +76,7 @@ $headers = DDTrace\generate_distributed_tracing_headers();
## RabbitMQ
-Although the PHP tracer supports automatic tracing of the `php-amqplib/php-amqplib` library starting with version **0.87.0**, there are some known cases where your distributed trace can be disconnected. Most notably, when reading messages from a distributed queue using the `basic_get` method while not already in a trace, you would need to add a custom trace surrounding a `basic_get` call and the corresponding message processing.
+Although the PHP APM SDK supports automatic tracing of the `php-amqplib/php-amqplib` library starting with version **0.87.0**, there are some known cases where your distributed trace can be disconnected. Most notably, when reading messages from a distributed queue using the `basic_get` method while not already in a trace, you would need to add a custom trace surrounding a `basic_get` call and the corresponding message processing.
Here is an example:
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/python.md b/content/en/tracing/trace_collection/trace_context_propagation/python.md
index 5f55c013b434a..cf804c2380e21 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/python.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/python.md
@@ -12,7 +12,7 @@ further_reading:
text: 'Interoperability of OpenTelemetry API and Datadog instrumented traces'
---
-The Datadog APM tracer supports extraction and injection of [B3][2] and [W3C Trace Context][3] headers for distributed tracing.
+The Datadog APM SDK supports extraction and injection of [B3][2] and [W3C Trace Context][3] headers for distributed tracing.
Distributed headers injection and extraction is controlled by
configuring injection and extraction styles. Supported styles are:
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/ruby.md b/content/en/tracing/trace_collection/trace_context_propagation/ruby.md
index 4abe20e16b9e5..94a74abee8ec3 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/ruby.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/ruby.md
@@ -53,7 +53,7 @@ Datadog.configure do |c|
end
```
-For more information about trace context propagation configuration, read [the Distributed Tracing section][1] in the Ruby Tracing Library Configuration docs.
+For more information about trace context propagation configuration, read [the Distributed Tracing section][1] in the Ruby APM SDK Configuration docs.
## Further Reading
diff --git a/content/en/tracing/trace_collection/trace_context_propagation/ruby_v1.md b/content/en/tracing/trace_collection/trace_context_propagation/ruby_v1.md
index b965625c44cdf..96e96fe2b86fa 100644
--- a/content/en/tracing/trace_collection/trace_context_propagation/ruby_v1.md
+++ b/content/en/tracing/trace_collection/trace_context_propagation/ruby_v1.md
@@ -51,7 +51,7 @@ Datadog.configure do |c|
end
```
-For more information about trace context propagation configuration, read [the Distributed Tracing section][1] in the Ruby Tracing Library Configuration docs.
+For more information about trace context propagation configuration, read [the Distributed Tracing section][1] in the Ruby APM SDK Configuration docs.
## Further Reading
diff --git a/content/en/tracing/trace_collection/tracing_naming_convention/_index.md b/content/en/tracing/trace_collection/tracing_naming_convention/_index.md
index 0690390f2248e..10656d0b3e4e2 100644
--- a/content/en/tracing/trace_collection/tracing_naming_convention/_index.md
+++ b/content/en/tracing/trace_collection/tracing_naming_convention/_index.md
@@ -14,7 +14,7 @@ further_reading:
## Overview
-[Datadog tracing libraries][1] provide out-of-the-box support for instrumenting a variety of libraries.
+[Datadog APM SDKs][1] provide out-of-the-box support for instrumenting a variety of libraries.
These instrumentations generate spans to represent logical units of work in distributed systems.
Each span consists of [span tags][2] to provide additional information on the unit of work happening in the system. Naming conventions describe the name and content that can be used in span events.
diff --git a/content/en/tracing/trace_explorer/_index.md b/content/en/tracing/trace_explorer/_index.md
index 721b8713ea9c3..dbc65008be91a 100644
--- a/content/en/tracing/trace_explorer/_index.md
+++ b/content/en/tracing/trace_explorer/_index.md
@@ -128,7 +128,7 @@ All spans indexed by custom retention filters *and* the intelligent retention fi
All spans indexed by custom retention filters or the intelligent retention filter are available to be searched when using trace analytics.
-From the timeseries view, export your query to a [dashboard][1], [monitor][2], or [notebook][3] to investigate further or to alert automatically when an aggregate number of spans crosses a specific threshold.
+From the timeseries view, export your query to a [dashboard][1], [monitor][2], or [notebook][3] to investigate further or to alert automatically when an aggregate number of spans crosses a specific threshold.
**Note**: Spans indexed by the intelligent retention filter are excluded from APM trace analytics monitor evaluations. For more information, see [Trace Retention][4].
@@ -155,7 +155,7 @@ You can customize which spans are retained and at what retention rates. By defau
[5]: /tracing/glossary/#indexed-span
[6]: /tracing/trace_pipeline/
[7]: /tracing/trace_pipeline/ingestion_mechanisms/#in-the-agent
-[8]: /tracing/trace_pipeline/ingestion_mechanisms/#in-tracing-libraries-user-defined-rules
+[8]: /tracing/trace_pipeline/ingestion_mechanisms/#in-apm-sdks-user-defined-rules
[9]: /account_management/billing/apm_distributed_tracing/
[10]: /glossary/#service-entry-span
[11]: /glossary/#trace-root-span
diff --git a/content/en/tracing/trace_pipeline/ingestion_controls.md b/content/en/tracing/trace_pipeline/ingestion_controls.md
index 0da2744ea4f1c..cd3d2ccaf504d 100644
--- a/content/en/tracing/trace_pipeline/ingestion_controls.md
+++ b/content/en/tracing/trace_pipeline/ingestion_controls.md
@@ -21,7 +21,7 @@ further_reading:
Ingestion controls affect what traces are sent by your applications to Datadog. [APM metrics][1] are always calculated based on all traces, and are not impacted by ingestion controls.
-The Ingestion Control page provides visibility at the Agent and tracing libraries level into the ingestion configuration of your applications and services. From the [ingestion control configuration page][2], you can:
+The Ingestion Control page provides visibility at the Agent and APM SDK level into the ingestion configuration of your applications and services. From the [ingestion control configuration page][2], you can:
- Gain visibility on your service-level ingestion configuration and adjust trace sampling rates for high throughput services.
- Understand which ingestion mechanisms are responsible for sampling most of your traces.
- Investigate and act on potential ingestion configuration issues, such as limited CPU or RAM resources for the Agent.
@@ -76,7 +76,7 @@ Traffic Breakdown
: A detailed breakdown of traffic sampled and unsampled for traces starting from the service. See [Traffic breakdown](#traffic-breakdown) for more information.
Ingestion Configuration
-: Shows `Automatic` if the [default head-based sampling mechanism][4] from the Agent applies. If the ingestion was configured in the tracing libraries with [trace sampling rules][8], the service is marked as `Configured`. For more information about configuring ingestion for a service, read about [changing the default ingestion rate](#configure-the-service-ingestion-rate).
+: Shows `Automatic` if the [default head-based sampling mechanism][4] from the Agent applies. If the ingestion was configured in the APM SDKs with [trace sampling rules][8], the service is marked as `Configured`. For more information about configuring ingestion for a service, read about [changing the default ingestion rate](#configure-the-service-ingestion-rate).
Infrastructure
: Hosts, containers, and functions on which the service is running.
@@ -97,12 +97,12 @@ The Traffic Breakdown column breaks down the destination of all traces originati
The breakdown is composed of the following parts:
- **Complete traces ingested** (blue): The percentage of traces that have been ingested by Datadog.
-- **Complete traces not retained** (gray): The percentage of traces that have intentionally not been forwarded to Datadog by the Agent or the tracing library. This can happen for one of two reasons depending on your configuration:
+- **Complete traces not retained** (gray): The percentage of traces that have intentionally not been forwarded to Datadog by the Agent or the APM SDK. This can happen for one of two reasons depending on your configuration:
1. By default, the [Agent distributes an ingestion rate][4] to services depending on service traffic.
- 2. When the service is manually [configured][8] to ingest a certain percentage of traces at the tracing library level.
+ 2. When the service is manually [configured][8] to ingest a certain percentage of traces at the APM SDK level.
-- **Complete traces dropped by the tracer rate limiter** (orange): When you choose to manually set the service ingestion rate as a percentage with trace sampling rules, a rate limiter is automatically enabled, set to 100 traces per second by default. See the [rate limiter][8] documentation to manually configure this rate.
+- **Complete traces dropped by the APM SDK rate limiter** (orange): When you choose to manually set the service ingestion rate as a percentage with trace sampling rules, a rate limiter is automatically enabled, set to 100 traces per second by default. See the [rate limiter][8] documentation to manually configure this rate.
- **Traces dropped due to the Agent CPU or RAM limit** (red): This mechanism may drop spans and create incomplete traces. To fix this, increase the CPU and memory allocation for the infrastructure that the Agent runs on.
@@ -118,11 +118,11 @@ If most of your service ingestion volume is due to decisions taken by upstream s
For further investigations, use the [APM Trace - Estimated Usage Dashboard][12], which provides global ingestion information as well as breakdown graphs by `service`, `env` and `ingestion reason`.
-### Agent and tracing library versions
+### Agent and APM SDK versions
-See the **Datadog Agent and tracing library versions** your service is using. Compare the versions in use to the latest released versions to make sure you are running recent and up-to-date Agents and libraries.
+See the **Datadog Agent and APM SDK versions** your service is using. Compare the versions in use to the latest released versions to make sure you are running recent and up-to-date Agents and libraries.
-{{< img src="tracing/trace_indexing_and_ingestion/agent_tracer_version.png" style="width:90%;" alt="Agent and tracing library versions" >}}
+{{< img src="tracing/trace_indexing_and_ingestion/agent_tracer_version.png" style="width:90%;" alt="Agent and APM SDK versions" >}}
**Note**: You need to upgrade the Agent to v6.34 or v7.34 for the version information to be reported.
@@ -134,7 +134,7 @@ Click **Manage Ingestion Rate** to get instructions on how to configure your ser
{{< img src="tracing/trace_indexing_and_ingestion/service_ingestion_rate_config.png" style="width:100%;" alt="Change the Service Ingestion Rate" >}}
-To specify a specific percentage of a service's traffic to be sent, add an environment variable or a generated code snippet to your tracing library configuration for that service.
+To specify a specific percentage of a service's traffic to be sent, add an environment variable or a generated code snippet to your APM SDK configuration for that service.
1. Select the service you want to change the ingested span percent for.
2. Choose the service language.
@@ -154,10 +154,10 @@ To specify a specific percentage of a service's traffic to be sent, add an envir
[5]: /tracing/trace_pipeline/ingestion_mechanisms/#error-traces
[6]: /tracing/trace_pipeline/ingestion_mechanisms/#rare-traces
[7]: /tracing/trace_pipeline/ingestion_mechanisms/#single-spans-app-analytics
-[8]: /tracing/trace_pipeline/ingestion_mechanisms/#in-tracing-libraries-user-defined-rules
+[8]: /tracing/trace_pipeline/ingestion_mechanisms/#in-apm-sdks-user-defined-rules
[9]: /tracing/troubleshooting/agent_rate_limits/#maximum-cpu-percentage
[10]: /tracing/trace_pipeline/metrics
[11]: /tracing/trace_pipeline/ingestion_mechanisms/
[12]: https://app.datadoghq.com/dash/integration/30337/app-analytics-usage
[13]: https://github.com/DataDog/datadog-agent/releases/tag/7.42.0
-[14]: /agent/remote_config/#enabling-remote-configuration
\ No newline at end of file
+[14]: /agent/remote_config/#enabling-remote-configuration
diff --git a/content/en/tracing/trace_pipeline/ingestion_mechanisms.md b/content/en/tracing/trace_pipeline/ingestion_mechanisms.md
index 31e24582f1156..384227a61ca65 100644
--- a/content/en/tracing/trace_pipeline/ingestion_mechanisms.md
+++ b/content/en/tracing/trace_pipeline/ingestion_mechanisms.md
@@ -1,6 +1,6 @@
---
title: Ingestion Mechanisms
-description: "Overview of the mechanisms in the tracer and the Agent that control trace ingestion."
+description: "Overview of the mechanisms in the APM SDK and the Agent that control trace ingestion."
aliases:
- /tracing/trace_ingestion/mechanisms
further_reading:
@@ -18,7 +18,7 @@ further_reading:
{{< img src="tracing/apm_lifecycle/ingestion_sampling_rules.png" style="width:100%; background:none; border:none; box-shadow:none;" alt="Ingestion Sampling Rules" >}}
-Multiple mechanisms are responsible for choosing if spans generated by your applications are sent to Datadog (_ingested_). The logic behind these mechanisms lie in the [tracing libraries][1] and in the Datadog Agent. Depending on the configuration, all or some the traffic generated by instrumented services is ingested.
+Multiple mechanisms are responsible for choosing if spans generated by your applications are sent to Datadog (_ingested_). The logic behind these mechanisms lie in the [APM SDKs][1] and in the Datadog Agent. Depending on the configuration, all or some the traffic generated by instrumented services is ingested.
To each span ingested, there is attached a unique **ingestion reason** referring to one of the mechanisms described in this page. [Usage metrics][2] `datadog.estimated_usage.apm.ingested_bytes` and `datadog.estimated_usage.apm.ingested_spans` are tagged by `ingestion_reason`.
@@ -34,12 +34,12 @@ Because the decision is made at the beginning of the trace and then conveyed to
You can set sampling rates for head-based sampling in two places:
- At the **[Agent](#in-the-agent)** level (default)
-- At the **[Tracing Library](#in-tracing-libraries-user-defined-rules)** level: any tracing library mechanism overrides the Agent setup.
+- At the **[APM SDK](#in-apm-sdks-user-defined-rules)** level: any APM SDK mechanism overrides the Agent setup.
### In the Agent
`ingestion_reason: auto`
-The Datadog Agent continuously sends sampling rates to tracing libraries to apply at the root of traces. The Agent adjusts rates to achieve a target of overall ten traces per second, distributed to services depending on the traffic.
+The Datadog Agent continuously sends sampling rates to APM SDKs to apply at the root of traces. The Agent adjusts rates to achieve a target of overall ten traces per second, distributed to services depending on the traffic.
For instance, if service `A` has more traffic than service `B`, the Agent might vary the sampling rate for `A` such that `A` keeps no more than seven traces per second, and similarly adjust the sampling rate for `B` such that `B` keeps no more than three traces per second, for a total of 10 traces per second.
@@ -56,15 +56,15 @@ Set Agent's target traces-per-second in its main configuration file (`datadog.ya
```
**Notes**:
-- The traces-per-second sampling rate set in the Agent only applies to Datadog tracing libraries. It has no effect on other tracing libraries such as OpenTelemetry SDKs.
+- The traces-per-second sampling rate set in the Agent only applies to Datadog APM SDKs. It has no effect on other APM SDKs such as OpenTelemetry SDKs.
- The maximum traces per second is a target, not a fixed value. In reality, it fluctuates depending on traffic spikes and other factors.
All the spans from a trace sampled using the Datadog Agent [automatically computed sampling rates](#in-the-agent) are tagged with the ingestion reason `auto`. The `ingestion_reason` tag is also set on [usage metrics][2]. Services using the Datadog Agent default mechanism are labeled as `Automatic` in the [Ingestion Control Page][5] Configuration column.
-### In tracing libraries: user-defined rules
+### In APM SDKs: user-defined rules
`ingestion_reason: rule`
-For more granular control, use tracing library sampling configuration options:
+For more granular control, use APM SDK sampling configuration options:
- Set a specific **sampling rate to apply to the root of the trace**, by service, and/or resource name, overriding the Agent's [default mechanism](#in-the-agent).
- Set a **rate limit** on the number of ingested traces per second. The default rate limit is 100 traces per second per service instance (when using the Agent [default mechanism](#in-the-agent), the rate limiter is ignored).
@@ -102,7 +102,7 @@ Configure a rate limit by setting the environment variable `DD_TRACE_RATE_LIMIT`
**Note**: The use of `DD_TRACE_SAMPLE_RATE` is deprecated. Use `DD_TRACE_SAMPLING_RULES` instead. For instance, if you already set `DD_TRACE_SAMPLE_RATE` to `0.1`, set `DD_TRACE_SAMPLING_RULES` to `[{"sample_rate":0.1}]` instead.
-Read more about sampling controls in the [Java tracing library documentation][2].
+Read more about sampling controls in the [Java APM SDK documentation][2].
[1]: /tracing/guide/resource_based_sampling
[2]: /tracing/trace_collection/dd_libraries/java
@@ -121,7 +121,7 @@ Configure a rate limit by setting the environment variable `DD_TRACE_RATE_LIMIT`
**Note**: The use of `DD_TRACE_SAMPLE_RATE` is deprecated. Use `DD_TRACE_SAMPLING_RULES` instead. For instance, if you already set `DD_TRACE_SAMPLE_RATE` to `0.1`, set `DD_TRACE_SAMPLING_RULES` to `[{"sample_rate":0.1}]` instead.
-Read more about sampling controls in the [Python tracing library documentation][2].
+Read more about sampling controls in the [Python APM SDK documentation][2].
[1]: https://github.com/DataDog/dd-trace-py/releases/tag/v2.8.0
[2]: /tracing/trace_collection/dd_libraries/python
@@ -138,7 +138,7 @@ export DD_TRACE_SAMPLING_RULES='[{"service": "my-service", "sample_rate": 0.5}]'
Configure a rate limit by setting the environment variable `DD_TRACE_RATE_LIMIT` to a number of traces per second per service instance. If no `DD_TRACE_RATE_LIMIT` value is set, a limit of 100 traces per second is applied.
-Read more about sampling controls in the [Ruby tracing library documentation][1].
+Read more about sampling controls in the [Ruby APM SDK documentation][1].
[1]: /tracing/trace_collection/dd_libraries/ruby#sampling
{{% /tab %}}
@@ -165,7 +165,7 @@ Configure a rate limit by setting the environment variable `DD_TRACE_RATE_LIMIT`
**Note**: The use of `DD_TRACE_SAMPLE_RATE` is deprecated. Use `DD_TRACE_SAMPLING_RULES` instead. For instance, if you already set `DD_TRACE_SAMPLE_RATE` to `0.1`, set `DD_TRACE_SAMPLING_RULES` to `[{"sample_rate":0.1}]` instead.
-Read more about sampling controls in the [Go tracing library documentation][1].
+Read more about sampling controls in the [Go APM SDK documentation][1].
[1]: /tracing/trace_collection/dd_libraries/go
[2]: https://github.com/DataDog/dd-trace-go/releases/tag/v1.60.0
@@ -191,7 +191,7 @@ tracer.init({
Configure a rate limit by setting the environment variable `DD_TRACE_RATE_LIMIT` to a number of traces per second per service instance. If no `DD_TRACE_RATE_LIMIT` value is set, a limit of 100 traces per second is applied.
-Read more about sampling controls in the [Node.js tracing library documentation][1].
+Read more about sampling controls in the [Node.js APM SDK documentation][1].
[1]: /tracing/trace_collection/dd_libraries/nodejs
{{% /tab %}}
@@ -205,7 +205,7 @@ export DD_TRACE_SAMPLE_RATE=0.1
export DD_TRACE_SAMPLING_RULES='[{"service": "my-service", "sample_rate": 0.5}]'
```
-Read more about sampling controls in the [PHP tracing library documentation][1].
+Read more about sampling controls in the [PHP APM SDK documentation][1].
[1]: /tracing/trace_collection/dd_libraries/php
{{% /tab %}}
@@ -241,7 +241,7 @@ export DD_TRACE_SAMPLING_RULES='[{"service": "my-service", "sample_rate": 0.5}]'
Configure a rate limit by setting the environment variable `DD_TRACE_RATE_LIMIT` to a number of traces per second per service instance. If no `DD_TRACE_RATE_LIMIT` value is set, a limit of 100 traces per second is applied.
-Read more about sampling controls in the [.NET tracing library documentation][1].\
+Read more about sampling controls in the [.NET APM SDK documentation][1].\
Read more about [configuring environment variables for .NET][2].
[1]: /tracing/trace_collection/automatic_instrumentation/dd_libraries/dotnet-core
@@ -249,7 +249,7 @@ Read more about [configuring environment variables for .NET][2].
{{% /tab %}}
{{< /tabs >}}
-**Note**: All the spans from a trace sampled using a tracing library configuration are tagged with the ingestion reason `rule`. Services configured with user-defined sampling rules are marked as `Configured` in the [Ingestion Control Page][5] Configuration column.
+**Note**: All the spans from a trace sampled using a APM SDK configuration are tagged with the ingestion reason `rule`. Services configured with user-defined sampling rules are marked as `Configured` in the [Ingestion Control Page][5] Configuration column.
## Error and rare traces
@@ -258,7 +258,7 @@ For traces not caught by the head-based sampling, two additional Datadog Agent s
- **Error traces**: Sampling errors is important for providing visibility on potential system failures.
- **Rare traces**: Sampling rare traces allows you to keep visibility on your system as a whole, by making sure that low-traffic services and resources are still monitored.
-**Note**: Error and rare samplers are ignored for services for which you set [library sampling rules](#in-tracing-libraries-user-defined-rules).
+**Note**: Error and rare samplers are ignored for services for which you set [library sampling rules](#in-apm-sdks-user-defined-rules).
### Error traces
`ingestion_reason: error`
@@ -276,7 +276,7 @@ With Agent version 7.33 and forward, you can configure the error sampler in the
**Notes**:
1. Set the parameter to `0` to disable the error sampler.
2. The error sampler captures local traces with error spans at the Agent level. If the trace is distributed, there is no guarantee that the complete trace is sent to Datadog.
-3. By default, spans dropped by tracing library rules or custom logic such as `manual.drop` are **excluded** under the error sampler.
+3. By default, spans dropped by APM SDK rules or custom logic such as `manual.drop` are **excluded** under the error sampler.
#### Datadog Agent 7.42.0 and higher
@@ -286,7 +286,7 @@ The error sampling is remotely configurable if you're using the Agent version [7
#### Datadog Agent 6/7.41.0 and higher
-To override the default behavior so that spans dropped by the tracing library rules or custom logic such as `manual.drop` are **included** by the error sampler, enable the feature with: `DD_APM_FEATURES=error_rare_sample_tracer_drop` in the Datadog Agent (or the dedicated Trace Agent container within the Datadog Agent pod in Kubernetes).
+To override the default behavior so that spans dropped by the APM SDK rules or custom logic such as `manual.drop` are **included** by the error sampler, enable the feature with: `DD_APM_FEATURES=error_rare_sample_tracer_drop` in the Datadog Agent (or the dedicated Trace Agent container within the Datadog Agent pod in Kubernetes).
#### Datadog Agent 6/7.33 to 6/7.40.x
@@ -311,7 +311,7 @@ The rare sampling rate is remotely configurable if you're using the Agent versio
By default, the rare sampler is **not enabled**.
-**Note**: When **enabled**, spans dropped by tracing library rules or custom logic such as `manual.drop` are **excluded** under this sampler.
+**Note**: When **enabled**, spans dropped by APM SDK rules or custom logic such as `manual.drop` are **excluded** under this sampler.
To configure the rare sampler, update the `apm_config.enable_rare_sampler` setting in the Agent main configuration file (`datadog.yaml`) or with the environment variable `DD_APM_ENABLE_RARE_SAMPLER`:
@@ -320,7 +320,7 @@ To configure the rare sampler, update the `apm_config.enable_rare_sampler` setti
@env DD_APM_ENABLE_RARE_SAMPLER - boolean - optional - default: false
```
-To evaluate spans dropped by tracing library rules or custom logic such as `manual.drop`,
+To evaluate spans dropped by APM SDK rules or custom logic such as `manual.drop`,
enable the feature with: `DD_APM_FEATURES=error_rare_sample_tracer_drop` in the Trace Agent.
@@ -328,7 +328,7 @@ To evaluate spans dropped by tracing library rules or custom logic such as `manu
By default, the rare sampler is enabled.
-**Note**: When **enabled**, spans dropped by tracing library rules or custom logic such as `manual.drop` **are excluded** under this sampler. To include these spans in this logic, upgrade to Datadog Agent 6.41.0/7.41.0 or higher.
+**Note**: When **enabled**, spans dropped by APM SDK rules or custom logic such as `manual.drop` **are excluded** under this sampler. To include these spans in this logic, upgrade to Datadog Agent 6.41.0/7.41.0 or higher.
To change the default rare sampler settings, update the `apm_config.disable_rare_sampler` setting in the Agent main configuration file (`datadog.yaml`) or with the environment variable `DD_APM_DISABLE_RARE_SAMPLER`:
@@ -340,7 +340,7 @@ To change the default rare sampler settings, update the `apm_config.disable_rare
## Force keep and drop
`ingestion_reason: manual`
-The head-based sampling mechanism can be overridden at the tracing library level. For example, if you need to monitor a critical transaction, you can force the associated trace to be kept. On the other hand, for unnecessary or repetitive information like health checks, you can force the trace to be dropped.
+The head-based sampling mechanism can be overridden at the APM SDK level. For example, if you need to monitor a critical transaction, you can force the associated trace to be kept. On the other hand, for unnecessary or repetitive information like health checks, you can force the trace to be dropped.
- Set Manual Keep on a span to indicate that it and all child spans should be ingested. The resulting trace might appear incomplete in the UI if the span in question is not the root span of the trace.
@@ -638,7 +638,7 @@ Manual trace keeping should happen before context propagation. If it is kept aft
## Single spans
`ingestion_reason: single_span`
-If you need to sample a specific span, but don't need the full trace to be available, tracing libraries allow you to set a sampling rate to be configured for a single span.
+If you need to sample a specific span, but don't need the full trace to be available, APM SDKs allow you to set a sampling rate to be configured for a single span.
For example, if you are building [metrics from spans][6] to monitor specific services, you can configure span sampling rules to ensure that these metrics are based on 100% of the application traffic, without having to ingest 100% of traces for all the requests flowing through the service.
@@ -648,7 +648,7 @@ This feature is available for Datadog Agent v[7.40.0][19]+.
{{< tabs >}}
{{% tab "Java" %}}
-Starting in tracing library [version 1.7.0][1], for Java applications, set by-service and by-operation name **span** sampling rules with the `DD_SPAN_SAMPLING_RULES` environment variable.
+Starting in APM SDK [version 1.7.0][1], for Java applications, set by-service and by-operation name **span** sampling rules with the `DD_SPAN_SAMPLING_RULES` environment variable.
For example, to collect 100% of the spans from the service named `my-service`, for the operation `http.request`, up to 50 spans per second:
@@ -656,7 +656,7 @@ For example, to collect 100% of the spans from the service named `my-service`, f
@env DD_SPAN_SAMPLING_RULES=[{"service": "my-service", "name": "http.request", "sample_rate":1.0, "max_per_second": 50}]
```
-Read more about sampling controls in the [Java tracing library documentation][2].
+Read more about sampling controls in the [Java APM SDK documentation][2].
[1]: https://github.com/DataDog/dd-trace-java/releases/tag/v1.7.0
[2]: /tracing/trace_collection/dd_libraries/java
@@ -671,7 +671,7 @@ For example, to collect `100%` of the spans from the service named `my-service`,
```
-Read more about sampling controls in the [Python tracing library documentation][2].
+Read more about sampling controls in the [Python APM SDK documentation][2].
[1]: https://github.com/DataDog/dd-trace-py/releases/tag/v1.4.0
[2]: /tracing/trace_collection/dd_libraries/python
@@ -685,7 +685,7 @@ For example, to collect `100%` of the spans from the service named `my-service`,
@env DD_SPAN_SAMPLING_RULES=[{"service": "my-service", "name": "http.request", "sample_rate":1.0, "max_per_second": 50}]
```
-Read more about sampling controls in the [Ruby tracing library documentation][2].
+Read more about sampling controls in the [Ruby APM SDK documentation][2].
[1]: https://github.com/DataDog/dd-trace-rb/releases/tag/v1.5.0
[2]: /tracing/trace_collection/dd_libraries/ruby#sampling
@@ -706,7 +706,7 @@ For example, to collect `100%` of the spans from the service for the resource `P
@env DD_SPAN_SAMPLING_RULES=[{"resource": "POST /api/create_issue", "tags": { "priority":"high" }, "sample_rate":1.0}]
```
-Read more about sampling controls in the [Go tracing library documentation][2].
+Read more about sampling controls in the [Go APM SDK documentation][2].
[1]: https://github.com/DataDog/dd-trace-go/releases/tag/v1.41.0
[2]: /tracing/trace_collection/dd_libraries/go
@@ -721,7 +721,7 @@ For example, to collect `100%` of the spans from the service named `my-service`,
@env DD_SPAN_SAMPLING_RULES=[{"service": "my-service", "name": "http.request", "sample_rate":1.0, "max_per_second": 50}]
```
-Read more about sampling controls in the [Node.js tracing library documentation][1].
+Read more about sampling controls in the [Node.js APM SDK documentation][1].
[1]: /tracing/trace_collection/dd_libraries/nodejs
{{% /tab %}}
@@ -734,7 +734,7 @@ For example, to collect `100%` of the spans from the service named `my-service`,
@env DD_SPAN_SAMPLING_RULES=[{"service": "my-service", "name": "http.request", "sample_rate":1.0, "max_per_second": 50}]
```
-Read more about sampling controls in the [PHP tracing library documentation][2].
+Read more about sampling controls in the [PHP APM SDK documentation][2].
[1]: https://github.com/DataDog/dd-trace-php/releases/tag/0.77.0
[2]: /tracing/trace_collection/dd_libraries/php
@@ -759,7 +759,7 @@ For example, to collect `100%` of the spans from the service named `my-service`,
@env DD_SPAN_SAMPLING_RULES='[{"service": "my-service", "name": "http.request", "sample_rate":1.0, "max_per_second": 50}]'
```
-Read more about sampling controls in the [.NET tracing library documentation][2].
+Read more about sampling controls in the [.NET APM SDK documentation][2].
[1]: https://github.com/DataDog/dd-trace-dotnet/releases/tag/v2.18.0
[2]: /tracing/trace_collection/dd_libraries/dotnet-core
@@ -801,9 +801,9 @@ Some additional ingestion reasons are attributed to spans that are generated by
| Product | Ingestion Reason | Ingestion Mechanism Description |
|------------|-------------------------------------|---------------------------------|
-| Serverless | `lambda` and `xray` | Your traces received from the [Serverless applications][14] traced with Datadog Tracing Libraries or the AWS X-Ray integration. |
-| Application Security Management | `appsec` | Traces ingested from Datadog tracing libraries and flagged by [ASM][15] as a threat. |
-| Data Jobs Monitoring | `data_jobs` | Traces ingested from the Datadog Java Tracer Spark integration or the Databricks integration. |
+| Serverless | `lambda` and `xray` | Your traces received from the [Serverless applications][14] traced with Datadog APM SDKs or the AWS X-Ray integration. |
+| Application Security Management | `appsec` | Traces ingested from Datadog APM SDKs and flagged by [ASM][15] as a threat. |
+| Data Jobs Monitoring | `data_jobs` | Traces ingested from the Datadog Java APM SDK Spark integration or the Databricks integration. |
## Ingestion mechanisms in OpenTelemetry
`ingestion_reason:otel`
diff --git a/content/en/tracing/trace_pipeline/metrics.md b/content/en/tracing/trace_pipeline/metrics.md
index 21fc762d36993..e07edb38e2d8d 100644
--- a/content/en/tracing/trace_pipeline/metrics.md
+++ b/content/en/tracing/trace_pipeline/metrics.md
@@ -45,7 +45,7 @@ The following metrics are associated with ingested spans usage:
Control the usage with `datadog.estimated_usage.apm.ingested_bytes`. Ingestion is metered as a volume, not as a number of spans or traces. This metric is tagged by `env` and `service` so you can spot which environments and services are contributing to the ingestion volume.
-This metric is also tagged by `ingestion_reason`, reflecting which [ingestion mechanisms][5] are responsible for sending spans to Datadog. These mechanisms are nested in the tracing libraries of the Datadog Agent. For more information about this dimension, see the [Ingestion Reasons dashboard][6].
+This metric is also tagged by `ingestion_reason`, reflecting which [ingestion mechanisms][5] are responsible for sending spans to Datadog. These mechanisms are nested in the APM SDKs of the Datadog Agent. For more information about this dimension, see the [Ingestion Reasons dashboard][6].
The `datadog.estimated_usage.apm.ingested_traces` metric measures the number of requests sampled per second, and only counts traces sampled by [head-based sampling][7]. This metric is also tagged by `env` and `service` so you can spot which services are starting the most traces.
@@ -70,7 +70,7 @@ In this dashboard, you can find information about:
## APM Ingestion Reasons dashboard
-The [APM Ingestion Reasons dashboard][6] provides insights on each source of ingestion volume. Each ingestion usage metric is tagged with an `ingestion_reason` dimension, so you can see which configuration options (Datadog Agent configuration or tracing library configuration) and products (such as RUM or Synthetic Testing) are generating the most APM data.
+The [APM Ingestion Reasons dashboard][6] provides insights on each source of ingestion volume. Each ingestion usage metric is tagged with an `ingestion_reason` dimension, so you can see which configuration options (Datadog Agent configuration or APM SDK configuration) and products (such as RUM or Synthetic Testing) are generating the most APM data.
{{< img src="tracing/trace_indexing_and_ingestion/usage_metrics/dashboard_ingestion_reasons.png" style="width:100%;" alt="APM Ingestion Reasons Dashboard" >}}
diff --git a/content/en/tracing/troubleshooting/_index.md b/content/en/tracing/troubleshooting/_index.md
index a41df0c1b4c2b..b1e4c1c077ab0 100644
--- a/content/en/tracing/troubleshooting/_index.md
+++ b/content/en/tracing/troubleshooting/_index.md
@@ -8,16 +8,16 @@ further_reading:
text: "Connection Errors"
- link: "/tracing/troubleshooting/tracer_startup_logs/"
tag: "Documentation"
- text: "Datadog tracer startup logs"
+ text: "Datadog APM SDK startup logs"
- link: "/tracing/troubleshooting/tracer_debug_logs/"
tag: "Documentation"
- text: "Datadog tracer debug logs"
+ text: "Datadog APM SDK debug logs"
- link: "/tracing/troubleshooting/agent_apm_metrics/"
tag: "Documentation"
text: "APM metrics sent by the Datadog Agent"
---
-If you experience unexpected behavior with Datadog APM, there are a few common issues you can investigate and this guide may help resolve issues quickly. If you continue to have trouble, reach out to [Datadog support][1] for further assistance. Datadog recommends regularly updating to the latest version of the Datadog tracing libraries you use, as each release contains improvements and fixes.
+If you experience unexpected behavior with Datadog APM, there are a few common issues you can investigate and this guide may help resolve issues quickly. If you continue to have trouble, reach out to [Datadog support][1] for further assistance. Datadog recommends regularly updating to the latest version of the Datadog APM SDKs you use, as each release contains improvements and fixes.
## Troubleshooting pipeline
@@ -25,19 +25,19 @@ The following components are involved in sending APM data to Datadog:
{{< img src="tracing/troubleshooting/troubleshooting_pipeline_info_1.png" alt="APM Troubleshooting Pipeline">}}
-Traces (JSON data type) and [Tracing Application Metrics][2] are generated from the application and sent to the Datadog Agent before traveling to the backend. Different troubleshooting information can be collected at each section of the pipeline. Importantly, the Tracer debug logs are written to your application's logs, which is a separate component from the Datadog Agent flare. More information about these items can be seen below in [Troubleshooting data requested by Datadog Support](#troubleshooting-data-requested-by-datadog-support).
+Traces (JSON data type) and [Tracing Application Metrics][2] are generated from the application and sent to the Datadog Agent before traveling to the backend. Different troubleshooting information can be collected at each section of the pipeline. Importantly, the APM SDK debug logs are written to your application's logs, which is a separate component from the Datadog Agent flare. More information about these items can be seen below in [Troubleshooting data requested by Datadog Support](#troubleshooting-data-requested-by-datadog-support).
## Confirm APM setup and Agent status
-During startup, Datadog tracing libraries emit logs that reflect the configurations applied in a JSON object, as well as any errors encountered, including if the Agent can be reached in languages where this is possible. Some languages require these startup logs to be enabled with the environment variable `DD_TRACE_STARTUP_LOGS=true`. For more information on startup logs, see the [dedicated page][3] for troubleshooting.
+During startup, Datadog APM SDKs emit logs that reflect the configurations applied in a JSON object, as well as any errors encountered, including if the Agent can be reached in languages where this is possible. Some languages require these startup logs to be enabled with the environment variable `DD_TRACE_STARTUP_LOGS=true`. For more information on startup logs, see the [dedicated page][3] for troubleshooting.
## Connection errors
A common source of trouble is the inability of the instrumented application to communicate with the Datadog Agent. Read about how to find and fix these problems in [Connection Errors][4].
-## Tracer debug logs
+## APM SDK debug logs
-To capture full details on the Datadog tracer, enable debug mode on your tracer by using the `DD_TRACE_DEBUG` environment variable. You might enable it for your own investigation or because Datadog support recommended it for triage purposes. However, don't leave debug mode always enabled because of the logging overhead it introduces.
+To capture full details on the Datadog APM SDK, enable debug mode on your APM SDK by using the `DD_TRACE_DEBUG` environment variable. You might enable it for your own investigation or because Datadog support recommended it for triage purposes. However, don't leave debug mode always enabled because of the logging overhead it introduces.
These logs can surface instrumentation errors or integration-specific errors. For details on enabling and capturing these debug logs, see the [debug mode troubleshooting page][5].
@@ -126,13 +126,13 @@ When you open a [support ticket][1], our support team may ask for some combinati
This allows Support to confirm errors and attempt to reproduce your issues within Datadog's testing environments.
-2. **[Tracer startup logs](#confirm-apm-setup-and-agent-status)**
+2. **[APM SDK startup logs](#confirm-apm-setup-and-agent-status)**
- Startup logs are a great way to spot misconfiguration of the tracer, or the inability for the tracer to communicate with the Datadog Agent. By comparing the configuration that the tracer sees to the one set within the application or container, Support can identify areas where a setting is not being properly applied.
+ Startup logs are a great way to spot misconfiguration of the APM SDK, or the inability for the APM SDK to communicate with the Datadog Agent. By comparing the configuration that the APM SDK sees to the one set within the application or container, Support can identify areas where a setting is not being properly applied.
-3. **[Tracer debug logs](#tracer-debug-logs)**
+3. **[APM SDK debug logs](#tracer-debug-logs)**
- Tracer debug logs go one step deeper than startup logs, and help to identify if integrations are instrumenting properly in a manner that can't necessarily be checked until traffic flows through the application. Debug logs can be extremely useful for viewing the contents of spans created by the tracer and can surface an error if there is a connection issue when attempting to send spans to the agent. Tracer debug logs are typically the most informative and reliable tool for confirming nuanced behavior of the tracer.
+ APM SDK debug logs go one step deeper than startup logs, and help to identify if integrations are instrumenting properly in a manner that can't necessarily be checked until traffic flows through the application. Debug logs can be extremely useful for viewing the contents of spans created by the APM SDK and can surface an error if there is a connection issue when attempting to send spans to the agent. APM SDK debug logs are typically the most informative and reliable tool for confirming nuanced behavior of the tracer.
4. **A [Datadog Agent flare][12] (snapshot of logs and configs) that captures a representative log sample of a time period when traces are sent to your Datadog Agent while in [debug or trace mode][13] depending on what information you are looking for in these logs.**
@@ -150,18 +150,18 @@ kubectl exec -it
-c trace-agent -- agent flare --loca
Knowing how your application is deployed helps the Support team identify likely issues for tracer-agent communication problems or misconfigurations. For difficult issues, Support may ask to a see a Kubernetes manifest or an ECS task definition, for example.
-6. **Custom code written using the tracing libraries, such as tracer configuration, [custom instrumentation][14], and adding span tags**
+6. **Custom code written using the APM SDK, such as APM SDK configuration, [custom instrumentation][14], and adding span tags**
Custom instrumentation can be a powerful tool, but also can have unintentional side effects on your trace visualizations within Datadog, so support may ask about this to rule it out as a suspect.
- Additionally, asking for your automatic instrumentation and configuration allows Datadog to confirm if this matches what it is seeing in both tracer startup and debug logs.
+ Additionally, asking for your automatic instrumentation and configuration allows Datadog to confirm if this matches what it is seeing in both APM SDK startup and debug logs.
7. **Versions of the:**
* **programming language, frameworks, and dependencies used to build the instrumented application**
* **Datadog Tracer**
* **Datadog Agent**
- Knowing what versions are being used allows us to ensure integrations are supported in our [Compatiblity Requirements][15] section, check for known issues, or to recommend a tracer or language version upgrade if it will address the problem.
+ Knowing what versions are being used allows us to ensure integrations are supported in our [Compatiblity Requirements][15] section, check for known issues, or to recommend a APM SDK or language version upgrade if it will address the problem.
## Further Reading
diff --git a/content/en/tracing/troubleshooting/connection_errors.md b/content/en/tracing/troubleshooting/connection_errors.md
index 8f07c2796ff7c..d63d3c84757e0 100644
--- a/content/en/tracing/troubleshooting/connection_errors.md
+++ b/content/en/tracing/troubleshooting/connection_errors.md
@@ -4,20 +4,20 @@ aliases:
- /tracing/faq/why-am-i-getting-errno-111-connection-refused-errors-in-my-application-logs/
---
-If the application with the tracing library cannot reach the Datadog Agent, look for connection errors in the [tracer startup logs][1] or [tracer debug logs][2], which can be found with your application logs.
+If the application with the APM SDK cannot reach the Datadog Agent, look for connection errors in the [APM SDK startup logs][1] or [APM SDK debug logs][2], which can be found with your application logs.
## Errors that indicate an APM Connection problem
If you see these messages, it means your traces are not being submitted to the Datadog Agent.
-### Tracing library errors
+### APM SDK errors
{{< programming-lang-wrapper langs="java,python,ruby,go,nodejs,.NET,php,cpp" >}}
{{< programming-lang lang="java" >}}
#### Java diagnostic CLI
-Starting with 0.82.0+ of the Java tracer, you can use a diagnostic command where the Java tracer is installed to detect potential connection issues. From where `dd-java-agent.jar` is installed (inside the application container), run:
+Starting with 0.82.0+ of the Java APM SDK, you can use a diagnostic command where the Java APM SDK is installed to detect potential connection issues. From where `dd-java-agent.jar` is installed (inside the application container), run:
```bash
java -jar /path/to/dd-java-agent.jar sampleTrace -c 1
@@ -31,13 +31,13 @@ Example output:
```
-#### Tracer startup logs
+#### APM SDK startup logs
```text
[dd.trace 2021-08-17 17:59:29:234 +0000] [dd-trace-processor] WARN datadog.trace.agent.common.writer.ddagent.DDAgentApi - Error while sending 9 (size=5KB) traces to the DD agent. Total: 9, Received: 9, Sent: 0, Failed: 9. java.net.ConnectException: Failed to connect to localhost/127.0.0.1:8126 (Will not log errors for 5 minutes)
```
-#### Tracer debug logs
+#### APM SDK debug logs
```text
[dd.trace 2021-08-17 18:04:50:282 +0000] [dd-trace-processor] DEBUG datadog.communication.ddagent.DDAgentFeaturesDiscovery - Error querying info at http://localhost:8126/
@@ -49,13 +49,13 @@ java.net.ConnectException: Failed to connect to localhost/127.0.0.1:8126
{{< programming-lang lang="python" >}}
-#### Tracer startup logs
+#### APM SDK startup logs
```text
-2021-08-17 19:10:06,169 WARNING [ddtrace.tracer] [tracer.py:655] [dd.service= dd.env= dd.version= dd.trace_id=0 dd.span_id=0] - - DATADOG TRACER DIAGNOSTIC - Agent not reachable at http://localhost:8126. Exception raised: [Errno 99] Cannot assign requested address
+2021-08-17 19:10:06,169 WARNING [ddtrace.tracer] [tracer.py:655] [dd.service= dd.env= dd.version= dd.trace_id=0 dd.span_id=0] - - DATADOG APM SDK DIAGNOSTIC - Agent not reachable at http://localhost:8126. Exception raised: [Errno 99] Cannot assign requested address
```
-#### Tracer debug logs
+#### APM SDK debug logs
```text
2021-08-17 14:04:12,982 ERROR [ddtrace.internal.writer] [writer.py:466] [dd.service= dd.env= dd.version= dd.trace_id=0 dd.span_id=0] - failed to send traces to Datadog Agent at http://localhost:8126
@@ -68,13 +68,13 @@ Traceback (most recent call last):
{{< programming-lang lang="ruby" >}}
-#### Tracer startup logs
+#### APM SDK startup logs
```text
-W, [2021-08-17T18:37:51.542245 #24] WARN -- ddtrace: [ddtrace] DATADOG TRACER DIAGNOSTIC - Agent Error: Datadog::Transport::InternalErrorResponse ok?: unsupported?:, not_found?:, client_error?:, server_error?:, internal_error?:true, payload:, error_type:Errno::ECONNREFUSED error:Failed to open TCP connection to 127.0.0.1:8126 (Connection refused - connect(2) for "127.0.0.1" port 8126)
+W, [2021-08-17T18:37:51.542245 #24] WARN -- ddtrace: [ddtrace] DATADOG APM SDK DIAGNOSTIC - Agent Error: Datadog::Transport::InternalErrorResponse ok?: unsupported?:, not_found?:, client_error?:, server_error?:, internal_error?:true, payload:, error_type:Errno::ECONNREFUSED error:Failed to open TCP connection to 127.0.0.1:8126 (Connection refused - connect(2) for "127.0.0.1" port 8126)
```
-#### Tracer debug logs
+#### APM SDK debug logs
```text
D, [2021-08-17T18:51:28.962389 #24] DEBUG -- ddtrace: [ddtrace] (/usr/local/bundle/gems/ddtrace-0.48.0/lib/ddtrace/transport/http/client.rb:33:in `rescue in send_request') Internal error during HTTP transport request. Cause: Failed to open TCP connection to 127.0.0.1:8126 (Connection refused - connect(2) for "127.0.0.1" port 8126) Location: /usr/local/lib/ruby/2.5.0/net/http.rb:939:in `rescue in block in connect'
@@ -84,30 +84,30 @@ D, [2021-08-17T18:51:28.962389 #24] DEBUG -- ddtrace: [ddtrace] (/usr/local/bund
{{< programming-lang lang="go" >}}
-#### Tracer startup logs
+#### APM SDK startup logs
```text
-2021/08/17 17:46:22 Datadog Tracer v1.32.0 WARN: DIAGNOSTICS Unable to reach agent intake: Post http://localhost:8126/v0.4/traces: dial tcp 127.0.0.1:8126: connect: connection refused
+2021/08/17 17:46:22 Datadog APM SDK v1.32.0 WARN: DIAGNOSTICS Unable to reach agent intake: Post http://localhost:8126/v0.4/traces: dial tcp 127.0.0.1:8126: connect: connection refused
```
-#### Tracer debug logs
+#### APM SDK debug logs
```text
-2021/08/17 17:47:42 Datadog Tracer v1.32.0 ERROR: lost 1 traces: Post http://localhost:8126/v0.4/traces: dial tcp 127.0.0.1:8126: connect: connection refused (occurred: 17 Aug 21 17:46 UTC)
+2021/08/17 17:47:42 Datadog APM SDK v1.32.0 ERROR: lost 1 traces: Post http://localhost:8126/v0.4/traces: dial tcp 127.0.0.1:8126: connect: connection refused (occurred: 17 Aug 21 17:46 UTC)
```
{{< /programming-lang >}}
{{< programming-lang lang="nodejs" >}}
-#### Tracer startup logs
+#### APM SDK startup logs
```text
-DATADOG TRACER DIAGNOSTIC - Agent Error: Network error trying to reach the agent: connect ECONNREFUSED 127.0.0.1:8126
+DATADOG APM SDK DIAGNOSTIC - Agent Error: Network error trying to reach the agent: connect ECONNREFUSED 127.0.0.1:8126
Error: Network error trying to reach the agent: connect ECONNREFUSED 127.0.0.1:8126
```
-#### Tracer debug logs
+#### APM SDK debug logs
```text
Error: Network error trying to reach the agent: connect ECONNREFUSED 127.0.0.1:8126
@@ -136,7 +136,7 @@ System.Net.Http.HttpRequestException: Connection refused
{{< programming-lang lang="php" >}}
-#### Tracer startup logs
+#### APM SDK startup logs
```
Failed to connect to localhost port 8126: Connection refused
@@ -171,11 +171,11 @@ APM Agent
```
## Troubleshooting the connection problem
-Whether it's the tracing library or the Datadog Agent displaying the error, there are a few ways to troubleshoot.
+Whether it's the APM SDK or the Datadog Agent displaying the error, there are a few ways to troubleshoot.
### Host-based setups
-If your application and the Datadog Agent are not containerized, the application with the tracing library should be trying to send traces to `localhost:8126` or `127.0.0.1:8126`, because that is where the Datadog Agent is listening.
+If your application and the Datadog Agent are not containerized, the application with the APM SDK should be trying to send traces to `localhost:8126` or `127.0.0.1:8126`, because that is where the Datadog Agent is listening.
If the Datadog Agent shows that APM is not listening, check for port conflicts with port 8126, which is what the APM component of the Datadog Agent uses by default.
@@ -204,7 +204,7 @@ If this command fails, your container cannot access the Agent. Refer to the foll
A great place to get started is the [APM in-app setup documentation][6].
-#### Review where your tracing library is trying to send traces
+#### Review where your APM SDK is trying to send traces
Using the error logs listed above for each language, check to see where your traces are being directed.
@@ -222,9 +222,9 @@ See the table below for example setups. Some require setting up additional netwo
| [Datadog Agent and Application Docker Containers][17] | Datadog Agent container |
-**Note about web servers**: If the `agent_url` section in the [tracer startup logs][1] has a mismatch against the `DD_AGENT_HOST` environment variable that was passed in, review how environment variables are cascaded for that specific server. For example, in PHP, there's an additional setting to ensure that [Apache][18] or [Nginx][19] pick up the `DD_AGENT_HOST` environment variable correctly.
+**Note about web servers**: If the `agent_url` section in the [APM SDK startup logs][1] has a mismatch against the `DD_AGENT_HOST` environment variable that was passed in, review how environment variables are cascaded for that specific server. For example, in PHP, there's an additional setting to ensure that [Apache][18] or [Nginx][19] pick up the `DD_AGENT_HOST` environment variable correctly.
-If your tracing library is sending traces correctly based on your setup, then proceed to the next step.
+If your APM SDK is sending traces correctly based on your setup, then proceed to the next step.
#### Review your Datadog Agent status and configuration
@@ -257,7 +257,7 @@ If the configuration is correct, but you're still seeing connection errors, [con
- Information about the environment in which you're deploying the application and Datadog Agent.
- If you're using proxies, information about how they've been configured.
- Any configuration files used to set up the application and the Datadog Agent.
-- Startup logs or tracer debug logs outlining the connection error.
+- Startup logs or APM SDK debug logs outlining the connection error.
- A Datadog [Agent flare][5]. For dedicated containers, send the flare from the [dedicated Trace Agent container][20].
@@ -281,4 +281,4 @@ If the configuration is correct, but you're still seeing connection errors, [con
[18]: /tracing/trace_collection/dd_libraries/php/?tab=containers#apache
[19]: /tracing/trace_collection/dd_libraries/php/?tab=containers#nginx
[20]: /agent/troubleshooting/send_a_flare/?tab=agentv6v7#trace-agent
-[21]: https://kubernetes.io/docs/concepts/services-networking/network-policies/
\ No newline at end of file
+[21]: https://kubernetes.io/docs/concepts/services-networking/network-policies/
diff --git a/content/en/tracing/troubleshooting/correlated-logs-not-showing-up-in-the-trace-id-panel.md b/content/en/tracing/troubleshooting/correlated-logs-not-showing-up-in-the-trace-id-panel.md
index b3d8d35280df0..da5acadbbf13a 100644
--- a/content/en/tracing/troubleshooting/correlated-logs-not-showing-up-in-the-trace-id-panel.md
+++ b/content/en/tracing/troubleshooting/correlated-logs-not-showing-up-in-the-trace-id-panel.md
@@ -14,7 +14,7 @@ further_reading:
## Overview
-The [trace][1] panel contains information about the trace, host, and correlated logs.
+The [trace][1] panel contains information about the trace, host, and correlated logs.
{{< img src="tracing/troubleshooting/tracing_no_logs_in_trace.png" alt="A trace page showing an empty log section" style="width:90%;">}}
@@ -47,7 +47,7 @@ If the **Log** section is empty for the `trace_id` option, ensure you have a sta
{{< tabs >}}
{{% tab "JSON logs" %}}
- For JSON logs, Step 1 and 2 are automatic. The tracer injects the [trace][1] and [span][2] IDs into the logs, which are automatically remapped by the [reserved attribute remappers][3].
+ For JSON logs, Step 1 and 2 are automatic. The APM SDK injects the [trace][1] and [span][2] IDs into the logs, which are automatically remapped by the [reserved attribute remappers][3].
If this process is not working as expected, ensure the logs attribute's name containing the trace ID is `dd.trace_id` and verify that the attribute is correctly set in the [reserved attributes'][4] Trace ID section.
diff --git a/content/en/tracing/troubleshooting/dotnet_diagnostic_tool.md b/content/en/tracing/troubleshooting/dotnet_diagnostic_tool.md
index 39633e878ba44..1d84b3a73d951 100644
--- a/content/en/tracing/troubleshooting/dotnet_diagnostic_tool.md
+++ b/content/en/tracing/troubleshooting/dotnet_diagnostic_tool.md
@@ -2,15 +2,15 @@
title: Using the .NET diagnostic tool for troubleshooting
---
-If your application does not produce traces as expected after installing the .NET tracer, run the diagnostic tool `dd-dotnet` described on this page for basic troubleshooting. It can help you determine issues with your setup, such as missing environment variables, incomplete installation, or an unreachable Agent.
+If your application does not produce traces as expected after installing the .NET APM SDK, run the diagnostic tool `dd-dotnet` described on this page for basic troubleshooting. It can help you determine issues with your setup, such as missing environment variables, incomplete installation, or an unreachable Agent.
-The diagnostic tool `dd-dotnet` is bundled with the tracing library starting with version 2.42.0. It is located in the tracing library's installation folder, and automatically added to the system `PATH` to be invoked from anywhere.
+The diagnostic tool `dd-dotnet` is bundled with the APM SDK starting with version 2.42.0. It is located in the APM SDK's installation folder, and automatically added to the system `PATH` to be invoked from anywhere.
## Installing `dd-trace`
-**This section is for versions of the tracer older than 2.42.0.**
+**This section is for versions of the APM SDK older than 2.42.0.**
-Older versions of the tracer did not include the `dd-dotnet` tool. You can install the `dd-trace` tool instead. Its features and syntax are similar to `dd-dotnet`.
+Older versions of the APM SDK did not include the `dd-dotnet` tool. You can install the `dd-trace` tool instead. Its features and syntax are similar to `dd-dotnet`.
You can install `dd-trace` in one of the following ways:
@@ -22,16 +22,16 @@ You can install `dd-trace` in one of the following ways:
* Win-x64: [https://dtdg.co/dd-trace-dotnet-win-x64][1]
* Linux-x64: [https://dtdg.co/dd-trace-dotnet-linux-x64][2]
* Linux-musl-x64 (Alpine): [https://dtdg.co/dd-trace-dotnet-linux-musl-x64][3]
-
+
- Or by downloading [from the github release page][4].
When invoking the commands in the next sections, make sure to replace `dd-dotnet` with `dd-trace`.
-## Process diagnostics
+## Process diagnostics
-For most applications, use the process diagnostics to find the problem.
+For most applications, use the process diagnostics to find the problem.
-1. Ensure the application is running, and get the process ID (pid).
+1. Ensure the application is running, and get the process ID (pid).
To get the pid of a Windows process, open Task Manager, open the **Details** tab, and look for the PID column. You can also run the command `tasklist /FI "IMAGENAME eq target.exe"`where `target.exe` is the name of the process.
diff --git a/content/en/tracing/troubleshooting/php_5_deep_call_stacks.md b/content/en/tracing/troubleshooting/php_5_deep_call_stacks.md
index 65ce0d38d93e6..0fd8a0d4e1b1a 100644
--- a/content/en/tracing/troubleshooting/php_5_deep_call_stacks.md
+++ b/content/en/tracing/troubleshooting/php_5_deep_call_stacks.md
@@ -3,7 +3,7 @@ title: Deep call stacks on PHP 5
---
PHP supports a virtually infinite call stack. However, the function call hook provided by the Zend Engine, `zend_execute_ex` (named `zend_execute` on PHP 5.4), calls PHP methods and functions using the native C stack. This in turn can cause a stack overflow when the call stack in PHP becomes extra deep.
-Starting with ddtrace version `0.48.0`, the PHP tracer uses the `zend_execute_ex` hook on PHP 5. The PHP tracer emits a warning when the call stack reaches `512` frames deep. You can disable this warning by setting the environment variable `DD_TRACE_WARN_CALL_STACK_DEPTH=0`.
+Starting with ddtrace version `0.48.0`, the PHP APM SDK uses the `zend_execute_ex` hook on PHP 5. The PHP APM SDK emits a warning when the call stack reaches `512` frames deep. You can disable this warning by setting the environment variable `DD_TRACE_WARN_CALL_STACK_DEPTH=0`.
To accommodate PHP applications with deep call stacks, adjust the stack size limit on the host machine. To see the existing stack size, run:
diff --git a/content/en/tracing/troubleshooting/quantization.md b/content/en/tracing/troubleshooting/quantization.md
index 8a27edf139152..c79241fd200d3 100644
--- a/content/en/tracing/troubleshooting/quantization.md
+++ b/content/en/tracing/troubleshooting/quantization.md
@@ -9,7 +9,7 @@ further_reading:
text: Replace tags in spans
- link: /tracing/trace_collection/library_config/
tag: Documentation
- text: Tracing Library Configuration
+ text: APM SDK Configuration
---
## Overview
@@ -47,7 +47,7 @@ To search for these spans in trace search, the query is `resource_name:"SELECT ?
### In-code instrumentation
-If your application runs in an agentless setup or if you prefer to make instrumentation changes more directly in your code, see [the tracer documentation of your application's runtime][3] for information on how to create custom configuration for span names and resource names.
+If your application runs in an agentless setup or if you prefer to make instrumentation changes more directly in your code, see [the APM SDK documentation of your application's runtime][3] for information on how to create custom configuration for span names and resource names.
### Agent configuration
diff --git a/content/en/tracing/troubleshooting/tracer_debug_logs.md b/content/en/tracing/troubleshooting/tracer_debug_logs.md
index 21cae4e38fa8b..a385b37983fa2 100644
--- a/content/en/tracing/troubleshooting/tracer_debug_logs.md
+++ b/content/en/tracing/troubleshooting/tracer_debug_logs.md
@@ -1,5 +1,5 @@
---
-title: Tracer Debug Logs
+title: APM SDK Debug Logs
further_reading:
- link: "/tracing/troubleshooting/connection_errors/"
tag: "Documentation"
@@ -10,15 +10,15 @@ further_reading:
Use Datadog debug settings to diagnose issues or audit trace data. Datadog does not recommend that you enable debug mode in production systems because it increases the number of events that are sent to your loggers. Use debug mode for debugging purposes only.
-Debug mode is disabled by default. To enable it, follow the corresponding language tracer instructions:
+Debug mode is disabled by default. To enable it, follow the corresponding language APM SDK instructions:
{{< programming-lang-wrapper langs="java,python,ruby,go,nodejs,.NET,php,cpp" >}}
{{< programming-lang lang="java" >}}
-To enable debug mode for the Datadog Java Tracer, set the flag `-Ddd.trace.debug=true` when starting the JVM or add `DD_TRACE_DEBUG=true` as environment variable.
+To enable debug mode for the Datadog Java APM SDK, set the flag `-Ddd.trace.debug=true` when starting the JVM or add `DD_TRACE_DEBUG=true` as environment variable.
-**Note**: Datadog Java Tracer implements SL4J SimpleLogger, so [all of its settings can be applied][1], for example, logging to a dedicated log file:
+**Note**: Datadog Java APM SDK implements SL4J SimpleLogger, so [all of its settings can be applied][1], for example, logging to a dedicated log file:
```
-Ddatadog.slf4j.simpleLogger.logFile=
```
@@ -29,7 +29,7 @@ To enable debug mode for the Datadog Java Tracer, set the flag `-Ddd.trace.debug
{{< programming-lang lang="python" >}}
-The steps for enabling debug mode in the Datadog Python Tracer depends on the version of the tracer your application is using. Choose the scenario that applies:
+The steps for enabling debug mode in the Datadog Python APM SDK depends on the version of the APM SDK your application is using. Choose the scenario that applies:
### Scenario 1: ddtrace version 2.x and higher
@@ -38,7 +38,7 @@ The steps for enabling debug mode in the Datadog Python Tracer depends on the ve
2. To route debug logs to a log file, set `DD_TRACE_LOG_FILE` to the filename of that log file, relative to the current working directory. For example, `DD_TRACE_LOG_FILE=ddtrace_logs.log`.
By default, the file size is 15728640 bytes (about 15MB), and one backup log file is created. To increase the default log file size, specify the size in bytes with the `DD_TRACE_LOG_FILE_SIZE_BYTES` setting.
-**Note:** If the application uses the root logger and changes log level to `DEBUG`, debug tracer logs are enabled. If you want to override this behavior, override the `ddtrace` logger as follows:
+**Note:** If the application uses the root logger and changes log level to `DEBUG`, debug APM SDK logs are enabled. If you want to override this behavior, override the `ddtrace` logger as follows:
```
import logging
@@ -56,7 +56,7 @@ logging.getLogger("ddtrace").setLevel(logging.WARNING)
1. To enable debug mode: `DD_TRACE_DEBUG=true`
-2. To route debug logs to a log file, set `DD_TRACE_LOG_FILE` with a filename that tracer logs should be written to, relative to the current working directory. For example, `DD_TRACE_LOG_FILE=ddtrace_logs.log`.
+2. To route debug logs to a log file, set `DD_TRACE_LOG_FILE` with a filename that APM SDK logs should be written to, relative to the current working directory. For example, `DD_TRACE_LOG_FILE=ddtrace_logs.log`.
By default, the file size is 15728640 bytes (about 15MB) and one backup log file is created. To increase the default log file size, specify the size in bytes with the `DD_TRACE_LOG_FILE_SIZE_BYTES` setting.
3. To route logs to the console, for **Python 2** applications, configure `logging.basicConfig()` or similar. Logs are automatically sent to the console for **Python 3** applications.
@@ -76,7 +76,7 @@ logging.getLogger("ddtrace").setLevel(logging.WARNING)
### Scenario 5: Configuring debug logging in the application code with the standard logging library
-For any version of ddtrace, rather than setting the `DD_TRACE_DEBUG` tracer environment variable, you can enable debug logging in the application code by using the `logging` standard library directly:
+For any version of ddtrace, rather than setting the `DD_TRACE_DEBUG` APM SDK environment variable, you can enable debug logging in the application code by using the `logging` standard library directly:
```
log = logging.getLogger("ddtrace.tracer")
@@ -87,7 +87,7 @@ log.setLevel(logging.DEBUG)
{{< programming-lang lang="ruby" >}}
-To enable debug mode for the Datadog Ruby Tracer, set the environment variable `DD_TRACE_DEBUG=true`.
+To enable debug mode for the Datadog Ruby APM SDK, set the environment variable `DD_TRACE_DEBUG=true`.
**Application Logs**
@@ -114,7 +114,7 @@ See [the API documentation][1] for more details.
{{< programming-lang lang="go" >}}
-To enable debug mode for the Datadog Go Tracer, set the environment variable `DD_TRACE_DEBUG=true`,
+To enable debug mode for the Datadog Go APM SDK, set the environment variable `DD_TRACE_DEBUG=true`,
or enable the debug mode during the `Start` config:
```go
@@ -130,7 +130,7 @@ func main() {
#### Abandoned span logs
-The Datadog Go Tracer also supports logging for potentially abandoned spans. To enable this debug mode in Go, set the environment variable `DD_TRACE_DEBUG_ABANDONED_SPANS=true`. To change the duration after which spans are considered abandoned (default=`10m`), set the environment variable `DD_TRACE_ABANDONED_SPAN_TIMEOUT` to the desired time duration. Abandoned span logs appear at the Info level.
+The Datadog Go APM SDK also supports logging for potentially abandoned spans. To enable this debug mode in Go, set the environment variable `DD_TRACE_DEBUG_ABANDONED_SPANS=true`. To change the duration after which spans are considered abandoned (default=`10m`), set the environment variable `DD_TRACE_ABANDONED_SPAN_TIMEOUT` to the desired time duration. Abandoned span logs appear at the Info level.
You can also enable debugging abandoned spans during the `Start` config:
@@ -153,13 +153,13 @@ func main() {
{{< programming-lang lang="nodejs" >}}
-To enable debug mode for the Datadog Node.js Tracer, use the environment variable `DD_TRACE_DEBUG=true`.
+To enable debug mode for the Datadog Node.js APM SDK, use the environment variable `DD_TRACE_DEBUG=true`.
-**Note:** For versions below 2.X, debug mode could be enabled programmatically inside the tracer initialization but this is no longer supported.
+**Note:** For versions below 2.X, debug mode could be enabled programmatically inside the APM SDK initialization but this is no longer supported.
**Application Logs**
-In debug mode the tracer will log debug information to `console.log()` and errors to `console.error()`. You can change this behavior by passing a custom logger to the tracer. The logger should contain `debug()` and `error()` methods that can handle messages and errors, respectively.
+In debug mode the APM SDK will log debug information to `console.log()` and errors to `console.error()`. You can change this behavior by passing a custom logger to the tracer. The logger should contain `debug()` and `error()` methods that can handle messages and errors, respectively.
For example:
@@ -180,13 +180,13 @@ const tracer = require('dd-trace').init({
Then check the Agent logs to see if there is more info about your issue:
-* If the trace was sent to the Agent properly, you should see `Response from the Agent: OK` log entries. This indicates that the tracer is working properly, so the problem may be with the Agent itself. Refer to the [Agent troubleshooting guide][1] for more information.
+* If the trace was sent to the Agent properly, you should see `Response from the Agent: OK` log entries. This indicates that the APM SDK is working properly, so the problem may be with the Agent itself. Refer to the [Agent troubleshooting guide][1] for more information.
* If an error was reported by the Agent (or the Agent could not be reached), you will see `Error from the Agent` log entries. In this case, validate your network configuration to ensure the Agent can be reached. If you are confident the network is functional and that the error is coming from the Agent, refer to the [Agent troubleshooting guide][1].
-If neither of these log entries is present, then no request was sent to the Agent, which means that the tracer is not instrumenting your application. In this case, [contact Datadog support][2] and provide the relevant log entries with [a flare][3].
+If neither of these log entries is present, then no request was sent to the Agent, which means that the APM SDK is not instrumenting your application. In this case, [contact Datadog support][2] and provide the relevant log entries with [a flare][3].
-For more tracer settings, check out the [API documentation][4].
+For more APM SDK settings, check out the [API documentation][4].
[1]: /agent/troubleshooting/
@@ -197,7 +197,7 @@ For more tracer settings, check out the [API documentation][4].
{{< programming-lang lang=".NET" >}}
-To enable debug mode for the Datadog .NET Tracer, set the `DD_TRACE_DEBUG` configuration setting to `true`. This setting can be set as an environment variable, in the `web.config` or `app.config` file (.NET Framework only), or in a `datadog.json` file. Alternatively, you can enable debug mode by calling `GlobalSettings.SetDebugEnabled(true)`:
+To enable debug mode for the Datadog .NET APM SDK, set the `DD_TRACE_DEBUG` configuration setting to `true`. This setting can be set as an environment variable, in the `web.config` or `app.config` file (.NET Framework only), or in a `datadog.json` file. Alternatively, you can enable debug mode by calling `GlobalSettings.SetDebugEnabled(true)`:
```csharp
using Datadog.Trace;
@@ -218,9 +218,9 @@ Logs files are saved in the following directories by default. Use the `DD_TRACE_
**Note:**: On Linux, you must create the logs directory before you enabled debug mode.
-Since version `2.19.0`, you can use the `DD_TRACE_LOGFILE_RETENTION_DAYS` setting to configure the tracer to delete log files from the current logging directory on startup. The tracer deletes log files the same age and older than the given number of days, with a default value of `31`.
+Since version `2.19.0`, you can use the `DD_TRACE_LOGFILE_RETENTION_DAYS` setting to configure the APM SDK to delete log files from the current logging directory on startup. The APM SDK deletes log files the same age and older than the given number of days, with a default value of `31`.
-For more details on how to configure the .NET Tracer, see the [Configuration][2] section.
+For more details on how to configure the .NET APM SDK, see the [Configuration][2] section.
There are two types of logs that are created in these paths:
1. **Logs from native code:** In 1.26.0 and higher, these logs are saved as `dotnet-tracer-native--.log`. From version 1.21.0 to 1.25.x, these logs were saved as `dotnet-tracer-native.log`. In 1.20.x and older versions, this was stored as `dotnet-profiler.log`.
@@ -233,20 +233,20 @@ There are two types of logs that are created in these paths:
{{< programming-lang lang="php" >}}
-To enable debug mode for the Datadog PHP Tracer, set the environment variable `DD_TRACE_DEBUG=true`. See the PHP [configuration docs][1] for details about how and when this environment variable value should be set in order to be properly handled by the tracer.
+To enable debug mode for the Datadog PHP APM SDK, set the environment variable `DD_TRACE_DEBUG=true`. See the PHP [configuration docs][1] for details about how and when this environment variable value should be set in order to be properly handled by the tracer.
-There are two options to route debug tracer logs to a file.
+There are two options to route debug APM SDK logs to a file.
**Option 1:**
-With dd-trace-php 0.98.0+, you can specify a path to a log file for certain debug tracer logs:
+With dd-trace-php 0.98.0+, you can specify a path to a log file for certain debug APM SDK logs:
- **Environment variable**: `DD_TRACE_LOG_FILE`
- **INI**: `datadog.trace.log_file`
**Notes**:
- - For details about where to set `DD_TRACE_LOG_FILE`, review [Configuring the PHP Tracing Library][2].
+ - For details about where to set `DD_TRACE_LOG_FILE`, review [Configuring the PHP APM SDK][2].
- If `DD_TRACE_LOG_FILE` is not specified, logs go to the default PHP error location (See **Option 2** for more details).
**Option 2:**
@@ -278,7 +278,7 @@ cmake --install .build
## Review debug logs
-When debug mode for your tracer is enabled, tracer-specific log messages report how the tracer was initialized and whether traces were sent to the Agent. **These logs are not sent to the Datadog Agent in the flare and are stored in a separate path depending on your logging configuration**. The following log examples show what might appear in your log file.
+When debug mode for your APM SDK is enabled, tracer-specific log messages report how the APM SDK was initialized and whether traces were sent to the Agent. **These logs are not sent to the Datadog Agent in the flare and are stored in a separate path depending on your logging configuration**. The following log examples show what might appear in your log file.
If there are errors that you don't understand, or if traces are reported as flushed to Datadog but you cannot see them in the Datadog UI, [contact Datadog support][1] and provide the relevant log entries with [a flare][2].
@@ -310,7 +310,7 @@ If there are errors that you don't understand, or if traces are reported as flus
{{< /programming-lang >}}
{{< programming-lang lang="python" >}}
-Logs generated by the Python Tracer have the logging handler name `ddtrace`.
+Logs generated by the Python APM SDK have the logging handler name `ddtrace`.
**Traces were generated:**
diff --git a/content/en/tracing/troubleshooting/tracer_startup_logs.md b/content/en/tracing/troubleshooting/tracer_startup_logs.md
index ab6c6db4492a7..700fd6e40c64b 100644
--- a/content/en/tracing/troubleshooting/tracer_startup_logs.md
+++ b/content/en/tracing/troubleshooting/tracer_startup_logs.md
@@ -1,5 +1,5 @@
---
-title: Tracer Startup Logs
+title: APM SDK Startup Logs
further_reading:
- link: "/tracing/troubleshooting/connection_errors/"
tag: "Documentation"
@@ -7,13 +7,13 @@ further_reading:
---
## Startup logs
-Tracer startup logs capture all obtainable information at startup and log it as `DATADOG TRACER CONFIGURATION`, `DATADOG TRACER DIAGNOSTICS`, `DATADOG ERROR`, or `DATADOG CONFIGURATION` to simplify searching within your logs.
+APM SDK startup logs capture all obtainable information at startup and log it as `DATADOG TRACER CONFIGURATION`, `DATADOG TRACER DIAGNOSTICS`, `DATADOG ERROR`, or `DATADOG CONFIGURATION` to simplify searching within your logs.
Some languages log to a separate file depending on language conventions and the safety of accessing `Stdout` or equivalent. In those cases, the location of logs are noted in the language tab below. Some languages don't log diagnostics entries, also noted below.
`CONFIGURATION` logs are a JSON formatted representation of settings applied to your tracer. In languages where an Agent connectivity check is performed, the configuration JSON will also include an `agent_error` key, which indicates whether the Agent is reachable.
-`DIAGNOSTICS` or `ERROR` log entries, in the languages that produce them, happen when the tracer encounters an error during application startup. If you see `DIAGNOSTICS` or `ERROR` log lines, confirm from the indicated log that settings and configurations are applied correctly.
+`DIAGNOSTICS` or `ERROR` log entries, in the languages that produce them, happen when the APM SDK encounters an error during application startup. If you see `DIAGNOSTICS` or `ERROR` log lines, confirm from the indicated log that settings and configurations are applied correctly.
If you do not see logs at all, ensure that your application logs are not silenced and that your log level is at least `INFO` where applicable.
@@ -28,7 +28,7 @@ If you do not see logs at all, ensure that your application logs are not silence
**Diagnostics:**
-The Java tracer does not output Diagnostics logs. For this check, run the tracer in [debug mode][1].
+The Java APM SDK does not output Diagnostics logs. For this check, run the APM SDK in [debug mode][1].
[1]: /tracing/troubleshooting/tracer_debug_logs/
@@ -48,7 +48,7 @@ Log files are saved in the following directories by default. Use the `DD_TRACE_L
**Note:** On Linux, you must create the logs directory before you enable debug mode.
-Since version `2.19.0`, you can use the `DD_TRACE_LOGFILE_RETENTION_DAYS` setting to configure the tracer to delete log files from the current logging directory on startup. The tracer deletes log files the same age and older than the given number of days, with a default value of `31`.
+Since version `2.19.0`, you can use the `DD_TRACE_LOGFILE_RETENTION_DAYS` setting to configure the APM SDK to delete log files from the current logging directory on startup. The APM SDK deletes log files the same age and older than the given number of days, with a default value of `31`.
- `dotnet-tracer-managed-{processName}-{timestamp}.log` contains the configuration logs.
@@ -70,7 +70,7 @@ Since version `2.19.0`, you can use the `DD_TRACE_LOGFILE_RETENTION_DAYS` settin
**Diagnostics:**
-The .NET tracer prints the following diagnostic lines:
+The .NET APM SDK prints the following diagnostic lines:
```text
DATADOG TRACER DIAGNOSTICS - Profiler disabled in DD_TRACE_ENABLED
@@ -134,7 +134,7 @@ DATADOG TRACER CONFIGURATION - {"agent_error":"Couldn't connect to server","ddtr
**Diagnostics:**
-Failed diagnostics for the PHP tracer print in the `error_log` if the tracer is in [DEBUG mode][1].
+Failed diagnostics for the PHP APM SDK print in the `error_log` if the tracer is in [DEBUG mode][1].
```text
DATADOG TRACER DIAGNOSTICS - agent_error: Couldn't connect to server
@@ -161,7 +161,7 @@ echo \DDTrace\startup_logs() . PHP_EOL;
**Diagnostics:**
-The Go Tracer prints one of two possible diagnostic lines, one for when the Agent cannot be reached, and the other for trace sampling errors.
+The Go APM SDK prints one of two possible diagnostic lines, one for when the Agent cannot be reached, and the other for trace sampling errors.
```text
2020/07/09 15:57:07 Datadog Tracer v1.26.0 WARN: DIAGNOSTICS Unable to reach agent: [Reason for error]
@@ -189,7 +189,7 @@ DATADOG TRACER CONFIGURATION - {"date":"2020-07-02T18:51:18.294Z","os_name":"Dar
**Diagnostics:**
-The Node.js Tracer prints a diagnostic line when the Agent cannot be reached.
+The Node.js APM SDK prints a diagnostic line when the Agent cannot be reached.
```text
DATADOG TRACER DIAGNOSTIC - Agent Error: Network error trying to reach the agent: connect ECONNREFUSED 127.0.0.1:8126
@@ -200,13 +200,13 @@ DATADOG TRACER DIAGNOSTIC - Agent Error: Network error trying to reach the agent
**Log location:**
-The Python tracer logs configuration information as INFO-level. It logs diagnostics information, if found, as ERROR.
+The Python APM SDK logs configuration information as INFO-level. It logs diagnostics information, if found, as ERROR.
If there is no logging configuration, only Diagnostics will be output to `Stderr`.
-To see tracer startup logs, either add a logger, or set `DD_TRACE_DEBUG=true` in your configuration and run your application with `ddtrace-run`. This adds a logger, and exposes both debug and startup tracer logs.
+To see APM SDK startup logs, either add a logger, or set `DD_TRACE_DEBUG=true` in your configuration and run your application with `ddtrace-run`. This adds a logger, and exposes both debug and startup APM SDK logs.
-To see options for logging to a file with `DD_TRACE_LOG_FILE`, read [Tracer Debug Logs][1].
+To see options for logging to a file with `DD_TRACE_LOG_FILE`, read [APM SDK Debug Logs][1].
**Configuration:**
@@ -216,7 +216,7 @@ To see options for logging to a file with `DD_TRACE_LOG_FILE`, read [Tracer Debu
**Diagnostics:**
-The Python tracer prints a diagnostic line when the Agent cannot be reached.
+The Python APM SDK prints a diagnostic line when the Agent cannot be reached.
```text
DATADOG TRACER DIAGNOSTIC - Agent not reachable. Exception raised: [Errno 61] Connection refused
@@ -249,7 +249,7 @@ export DD_TRACE_STARTUP_LOGS=true
### Output
-When startup logs are enabled, the tracer outputs configuration and diagnostic information.
+When startup logs are enabled, the APM SDK outputs configuration and diagnostic information.
**Configuration:**
@@ -259,7 +259,7 @@ W, [2020-07-08T21:14:25.281615 #137] WARN -- ddtrace: [ddtrace] DATADOG TRACER
**Diagnostics:**
-The Ruby tracer prints an error line when the Agent cannot be reached.
+The Ruby APM SDK prints an error line when the Agent cannot be reached.
```text
W, [2020-07-08T21:19:05.765994 #143] WARN -- ddtrace: [ddtrace] DATADOG ERROR - TRACER - Agent Error: Datadog::Transport::InternalErrorResponse ok?: unsupported?:, not_found?:, client_error?:, server_error?:, internal_error?:true, payload:, error_type:Errno::ECONNREFUSED error:Failed to open TCP connection to ddagent:9127 (Connection refused - connect(2) for "ddagent" port 9127)
@@ -270,7 +270,7 @@ W, [2020-07-08T21:19:05.765994 #143] WARN -- ddtrace: [ddtrace] DATADOG ERROR -
**Configuration:**
-The Ruby tracer prints a configuration line for each product (i.e. Profiling, Core, and Tracing).
+The Ruby APM SDK prints a configuration line for each product (i.e. Profiling, Core, and Tracing).
```text
I, [2023-08-16T18:09:01.972265 #35] INFO -- ddtrace: [ddtrace] DATADOG CONFIGURATION - PROFILING - {"profiling_enabled":false}
@@ -282,22 +282,22 @@ I, [2023-08-16T18:09:27.223143 #35] INFO -- ddtrace: [ddtrace] DATADOG CONFIGUR
**Diagnostics:**
-For C++, there are no `DATADOG TRACER DIAGNOSTICS` lines output to the tracer logs. However, if the Agent is not reachable, errors appear in your application logs. In Envoy there is an increase in the metrics `tracing.datadog.reports_failed` and `tracing.datadog.reports_dropped`.
+For C++, there are no `DATADOG TRACER DIAGNOSTICS` lines output to the APM SDK logs. However, if the Agent is not reachable, errors appear in your application logs. In Envoy there is an increase in the metrics `tracing.datadog.reports_failed` and `tracing.datadog.reports_dropped`.
{{< /programming-lang >}}
{{< /programming-lang-wrapper >}}
## Connection errors
-If your application or startup logs contain `DIAGNOSTICS` errors or messages that the Agent cannot be reached or connected to (varying depending on your language), it means the tracer is unable to send traces to the Datadog Agent.
+If your application or startup logs contain `DIAGNOSTICS` errors or messages that the Agent cannot be reached or connected to (varying depending on your language), it means the APM SDK is unable to send traces to the Datadog Agent.
-If you have these errors, check that your Agent is set up to receive traces for [ECS][1], [Kubernetes][2], [Docker][3] or [any other option][4], or [contact support][5] to review your tracer and Agent configuration.
+If you have these errors, check that your Agent is set up to receive traces for [ECS][1], [Kubernetes][2], [Docker][3] or [any other option][4], or [contact support][5] to review your APM SDK and Agent configuration.
See [Connection Errors][6] for information about errors indicating that your instrumented application cannot communicate with the Datadog Agent.
## Configuration settings
-If your logs contain only `CONFIGURATION` lines, a useful troubleshooting step is to confirm that the settings output by the tracer match the settings from your deployment and configuration of the Datadog Tracer. Additionally, if you are not seeing specific traces in Datadog, review the [Compatibility Requirements][7] section of the documentation to confirm these integrations are supported.
+If your logs contain only `CONFIGURATION` lines, a useful troubleshooting step is to confirm that the settings output by the APM SDK match the settings from your deployment and configuration of the Datadog Tracer. Additionally, if you are not seeing specific traces in Datadog, review the [Compatibility Requirements][7] section of the documentation to confirm these integrations are supported.
If an integration you are using is not supported, or you want a fresh pair of eyes on your configuration output to understand why traces are not appearing as expected in Datadog, [contact support][5] who can help you diagnose and create a Feature Request for a new integration.