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

Add instructions for Auth Extension shadow variant (#1764)

This commit is contained in:
Pranav Sharma 2025-03-06 10:19:27 -05:00 committed by GitHub
parent 9f40e41b09
commit eaeaeb95a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
gcp-auth-extension/README.md
View File

@ -48,6 +48,10 @@ Here is a list of configurable options for the extension:
The OpenTelemetry Java Agent Extension can be easily added to any Java application by modifying the startup command to the application.
For more information on Extensions, see the [documentation here](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/examples/extension/README.md).
> [!IMPORTANT]
> Make sure to download the 'shaded' variant of the Authentication Extension for use with OpenTelemetry Java auto-instrumentation agent. The shaded version is available under the classifier name `shadow`.\
> See instructions for [Downloading Shaded JAR](#downloading-shaded-jar) below.
Below is a snippet showing how to add the extension to a Java application using the Gradle build system.
```gradle
@ -80,6 +84,21 @@ application {
}
```
#### Downloading Shaded JAR
You can download the shaded JAR for Google Cloud Authentication Extension from the following link -
```text
https://repo1.maven.org/maven2/io/opentelemetry/contrib/opentelemetry-gcp-auth-extension/<VERSION>/opentelemetry-gcp-auth-extension-<VERSION>-shadow.jar
```
Replace `<VERSION>` with the version you wish to download. For instance, shaded
variant for `v1.44.0-alpha`, will be found at -
`https://repo1.maven.org/maven2/io/opentelemetry/contrib/opentelemetry-gcp-auth-extension/1.44.0-alpha/opentelemetry-gcp-auth-extension-1.44.0-alpha-shadow.jar`
*Note: Typically, you would want to use the most recent version of the extension.*
### Without OpenTelemetry Java agent
This extension can be used without the OpenTelemetry Java agent by leveraging the [OpenTelemetry SDK Autoconfigure](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md) module.\

7
gcp-auth-extension/build.gradle.kts
View File

@ -60,6 +60,13 @@ tasks {
}
shadowJar {
/**
* Shaded version of this extension is required when using it as a OpenTelemetry Java Agent
* extension. Shading bundles the dependencies required by this extension in the resulting JAR,
* ensuring their presence on the classpath at runtime.
*
* See http://gradleup.com/shadow/introduction/#introduction for reference.
*/
archiveClassifier.set("shadow")
}