Skip to content

Commit 45ebf74

Browse files
committed
bootstrap FAQ
1 parent 7207104 commit 45ebf74

File tree

1 file changed

+62
-1
lines changed

1 file changed

+62
-1
lines changed

docs/_edot-sdks/java/faq.md

+62-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,65 @@ parent: EDOT Java
77

88
# Frequently Asked Questions on EDOT Java
99

10-
TODO
10+
## Does agent requires access to or modification of application code ?
11+
12+
TODO
13+
14+
## How to disable the agent ?
15+
16+
TODO
17+
18+
- remove `-javaagent:` JVM argument
19+
- use configuration
20+
21+
## How to partially disable the agent
22+
23+
TODO
24+
25+
## How to know if EDOT is attached to a running JVM ?
26+
27+
TODO
28+
- check JVM logs, agent startup log message might be included
29+
- check JVM arguments `ps -ef|grep javaagent`
30+
31+
## How to identify the version of EDOT agent ?
32+
33+
When the agent starts, a log message in the standard error provides the agent version:
34+
```
35+
INFO io.opentelemetry.javaagent.tooling.VersionLogger - opentelemetry-javaagent - version: 1.2.3
36+
```
37+
38+
In addition, the `-javaagent:` JVM argument can provide the path to the agent file name, which _might_ also contain
39+
the agent version, for example `-javaagent:elastic-otel-javaagent-1.2.3.jar`
40+
41+
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,
42+
for example with `unzip -p elastic-otel-javaagent.jar META-INF/MANIFEST.MF|grep 'Implementation-Version'`
43+
44+
## What are the versions of the OpenTelemetry upstream dependencies
45+
46+
TODO
47+
- SDK
48+
- Instrumentation
49+
- Semantic conventions
50+
51+
link to release notes
52+
53+
## Updating EDOT
54+
55+
- general recommendation on updating to latest
56+
- how to update
57+
58+
- updating EDOT does not require to update OpenTelemetry API/SDK in the application
59+
60+
## Is the agent compatible with other instrumentation agents ?
61+
62+
TODO
63+
64+
## How to instrument un-supported libraries/frameworks
65+
66+
TODO
67+
68+
- use configuration (but limited)
69+
- use otel API with code modification
70+
- write an instrumentation extension
71+
- contribute instrumentation to upstream

0 commit comments

Comments
 (0)