diff --git a/gcp-auth-extension/README.md b/gcp-auth-extension/README.md index 34cdf4bb6..3a2ddc5ec 100644 --- a/gcp-auth-extension/README.md +++ b/gcp-auth-extension/README.md @@ -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//opentelemetry-gcp-auth-extension--shadow.jar +``` + +Replace `` 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.\ diff --git a/gcp-auth-extension/build.gradle.kts b/gcp-auth-extension/build.gradle.kts index dfee87d49..112113e66 100644 --- a/gcp-auth-extension/build.gradle.kts +++ b/gcp-auth-extension/build.gradle.kts @@ -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") } diff --git a/processors/README.md b/processors/README.md index 866daaae1..3e5df3ca8 100644 --- a/processors/README.md +++ b/processors/README.md @@ -25,8 +25,7 @@ tracer_provider: ... logger_provider: processors: - # TODO(jack-berg): remove "{}" after releasing [opentelemetry-java#6891](https://github.com/open-telemetry/opentelemetry-java/pull/6891/files) - - event_to_span_event_bridge: {} + - event_to_span_event_bridge: ``` ## Component owners