Skip to content

Commit 1e7a8f1

Browse files
Add notes warning against using EDOT SDKs alongside other APM agents (#352)
* Add note warning against using EDOT SDKs alongside other APM agents
1 parent aa0879a commit 1e7a8f1

File tree

6 files changed

+23
-0
lines changed

6 files changed

+23
-0
lines changed

docs/reference/edot-sdks/dotnet/setup/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ This quickstart guide documents the introductory steps required to set up OpenTe
3030
* [Worker services](/reference/edot-sdks/dotnet/setup/worker-services.md)
3131
* [Zero code](/reference/edot-sdks/dotnet/setup/zero-code.md)
3232

33+
:::{warning}
34+
Avoid using the .NET SDK alongside any other APM agent, including Elastic APM agents. Running multiple agents in the same application process may lead to conflicting instrumentation, duplicate telemetry, or other unexpected behavior.
35+
:::
36+
3337
### Prerequisites
3438

3539
Before getting started:

docs/reference/edot-sdks/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ This table provides an overview of the features available in the {{edot}} (EDOT)
4747

4848
Elastic provides technical support for EDOT Language SDKs according to Elastic's [Support Policy](https://www.elastic.co/support_policy). EDOT SDKs are meant to be used in combination with the [EDOT Collector](/reference/edot-collector/index.md) or the [{{motlp}}](/reference/motlp.md) to ingest data into Elastic solutions from the EDOT SDKs. Other ingestion paths are not officially supported by Elastic.
4949

50+
:::{warning}
51+
Avoid using EDOT SDKs alongside any other APM agent, including Elastic APM agents. Running multiple agents in the same application process may lead to conflicting instrumentation, duplicate telemetry, or other unexpected behavior.
52+
:::
53+
5054
## License
5155

5256
EDOT SDKs are licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

docs/reference/edot-sdks/java/setup/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ products:
1717

1818
Learn how to set up the {{edot}} (EDOT) Java in various environments, including Kubernetes and others.
1919

20+
:::{warning}
21+
Avoid using the Java SDK alongside any other APM agent, including Elastic APM agents. Running multiple agents in the same application process may lead to conflicting instrumentation, duplicate telemetry, or other unexpected behavior.
22+
:::
23+
2024
## Kubernetes
2125

2226
For Kubernetes, use the OTel Kubernetes Operator. The Operator also manages the auto-instrumentation of Java applications. Follow the [quickstart guide](/reference/quickstart/index.md) for Kubernetes or learn more about [instrumentation details on Kubernetes for Java](/reference/edot-sdks/java/setup/k8s.md).

docs/reference/edot-sdks/nodejs/setup/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ export OTEL_SERVICE_NAME="my-app"
3131
# Start it with your application
3232
node --import @elastic/opentelemetry-node my-app.js
3333
```
34+
:::{warning}
35+
Avoid using the Node.js SDK alongside any other APM agent, including Elastic APM agents. Running multiple agents in the same application process may lead to conflicting instrumentation, duplicate telemetry, or other unexpected behavior.
36+
:::
3437

3538
If you are deploying in Kubernetes, see the [Kubernetes setup guide](/reference/edot-sdks/nodejs/setup/k8s.md).
3639

docs/reference/edot-sdks/php/setup/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ To quickly get up and running, follow the [Elastic OpenTelemetry Quickstart guid
2727
- Configuring your OpenTelemetry agent.
2828
- Exploring traces and metrics in {{kib}}.
2929

30+
:::{warning}
31+
Avoid using the PHP SDK alongside any other APM agent, including Elastic APM agents. Running multiple agents in the same application process may lead to conflicting instrumentation, duplicate telemetry, or other unexpected behavior.
32+
:::
33+
3034
### Operating system and PHP version
3135

3236
Refer to [Supported technologies](/reference/edot-sdks/php/supported-technologies.md) for details about currently supported operating systems and PHP versions.

docs/reference/edot-sdks/python/setup/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Learn how to set up the {{edot}} (EDOT) Python in various environments, includin
1919

2020
Follow these steps to get started.
2121

22+
:::{warning}
23+
Avoid using the Python SDK alongside any other APM agent, including Elastic APM agents. Running multiple agents in the same application process may lead to conflicting instrumentation, duplicate telemetry, or other unexpected behavior.
24+
:::
25+
2226
::::::{stepper}
2327

2428
::::{step} Install the distribution

0 commit comments

Comments
 (0)