Skip to content

Commit f2000af

Browse files
committed
document update
1 parent 4239d16 commit f2000af

File tree

1 file changed

+38
-10
lines changed

1 file changed

+38
-10
lines changed

docs/_edot-sdks/java/faq.md

+38-10
Original file line numberDiff line numberDiff line change
@@ -46,21 +46,49 @@ the agent version, for example `-javaagent:elastic-otel-javaagent-1.2.3.jar`
4646
When the original agent jar file has been renamed, it is still possible to inspect the `Implementation-Version` entry in `META-INF/MANIFEST.MF` file of the agent jar,
4747
for example with `unzip -p elastic-otel-javaagent.jar META-INF/MANIFEST.MF|grep 'Implementation-Version'`
4848

49-
## What are the versions of the OpenTelemetry upstream dependencies
49+
## What are the versions of the OpenTelemetry upstream dependencies ?
5050

51-
TODO
52-
- SDK
53-
- Instrumentation
54-
- Semantic conventions
51+
Because EDOT Java is a distribution of [OpenTelemetry Java instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation),
52+
it includes the following dependencies:
53+
54+
- [OpenTelemetry Java Instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation)
55+
- [OpenTelemetry Java SDK](https://github.com/open-telemetry/opentelemetry-java)
56+
- [Semantic Conventions Java mappings](https://github.com/open-telemetry/semantic-conventions-java)
57+
- [OpenTelemetry Java Contrib](https://github.com/open-telemetry/opentelemetry-java-contrib)
58+
59+
The versions of those included in EDOT is usually aligned with the OpenTelemetry Java Instrumentation, for reference we
60+
provide in the [release notes](https://github.com/elastic/elastic-otel-java/releases) details of versions included in each release.
61+
62+
## When and how to update EDOT
63+
64+
The general recommendation is to update EDOT agent to the latest version when possible to benefit from:
65+
- bug fixes and technical improvements
66+
- support of new features and instrumentation
67+
- evolution of semantic conventions
68+
- frequent and regular updates usually makes reviewing and handling changes easier.
69+
70+
Updating to the latest EDOT version involves reviewing changes of the included dependencies:
71+
72+
- [OpenTelemetry Java Instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation)
73+
- [OpenTelemetry Java SDK](https://github.com/open-telemetry/opentelemetry-java)
74+
- [Semantic Conventions Java mappings](https://github.com/open-telemetry/semantic-conventions-java)
75+
- [OpenTelemetry Java Contrib](https://github.com/open-telemetry/opentelemetry-java-contrib)
76+
77+
In order to review each of those individually, you can use the [EDOT release notes](https://github.com/elastic/elastic-otel-java/releases)
78+
for links to the respective versions of each component.
79+
80+
### OpenTelemetry API/SDK update
5581

56-
link to release notes
82+
In order to implement manual instrumentation, some applications use the OpenTelemetry API and/or SDK which allows them
83+
to capture custom spans, metrics or even send data without any instrumentation agent.
5784

58-
## Updating EDOT
85+
Updates of the OpenTelemetry API/SDK in the application and the EDOT Java agent can be done independently.
86+
- EDOT Java is backward-compatible with all previous versions of OpenTelemetry API/SDK
87+
- Using a more recent version of API/SDK than the one in EDOT should usually work without problem, however to ensure maximum compatibility keeping OpenTelemetry API/SDK version ≤ EDOT OpenTelemetry API/SDK version is recommended.
5988

60-
- general recommendation on updating to latest
61-
- how to update
89+
### How to update
6290

63-
- updating EDOT does not require to update OpenTelemetry API/SDK in the application
91+
Updating EDOT Java agent is done by replacing the agent binary `.jar` that has been [added during setup](./setup/).
6492

6593
## Is the agent compatible with other instrumentation agents ?
6694

0 commit comments

Comments
 (0)