Skip to content

Commit

Permalink
Merge branch 'main' into fix-declarative-config-breaking-changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-berg authored Mar 6, 2025
2 parents 0b8928c + 96dad3e commit 0d02296
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 2 deletions.
19 changes: 19 additions & 0 deletions gcp-auth-extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.\
Expand Down
7 changes: 7 additions & 0 deletions gcp-auth-extension/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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")
}

Expand Down
3 changes: 1 addition & 2 deletions processors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0d02296

Please sign in to comment.