open-telemetry
/
opentelemetry-java-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-java-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document naming convention for common modules (#13506)

This commit is contained in:
Jay DeLuca 2025-03-13 10:14:18 -04:00 committed by GitHub
parent 3c14532d3f
commit 35a3dc6e7c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/contributing/writing-instrumentation.md
View File

@ -402,6 +402,26 @@ All classes from the newly added bootstrap module will be loaded by the bootstra
globally available within the JVM. **IMPORTANT: Note that you _cannot_ use any third-party libraries
here, including the instrumented library - you can only use JDK and OpenTelemetry API classes.**
### Common Modules
When creating a common module shared among different instrumentations, the naming convention should
include a version suffix that matches the major/minor version of the instrumented library specified
in the common module's `build.gradle.kts`.
For example, if the common module's Gradle file contains the following dependency:
```kotlin
dependencies {
compileOnly("org.yarpc.client:rest:5.0.0")
}
```
Then the module should be named using the suffix `yarp-common-5.0`.
If the common module does not have a direct dependency on the instrumented library, no version
suffix is required. Examples of such cases include modules named `lettuce-common` and
`netty-common`.
## Writing Java agent unit tests
As mentioned before, tests in the `javaagent` module cannot access the javaagent instrumentation