You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "stankiewicz (via GitHub)" <gi...@apache.org> on 2026/06/08 12:57:45 UTC
[PR] [OpenTelemetry] Add turning off to gcpauth extension [beam]
stankiewicz opened a new pull request, #38846:
URL: https://github.com/apache/beam/pull/38846
OpenTelemetry gcp auth extension didn't have turn off capability.
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [OpenTelemetry] Add turning off to gcpauth extension [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on code in PR #38846:
URL: https://github.com/apache/beam/pull/38846#discussion_r3373382536
##########
sdks/java/extensions/opentelemetry-gcp-auth-extension/src/main/java/org/apache/beam/sdk/extensions/opentelemetry/gcp/auth/GcpAuthAutoConfigurationCustomizerProvider.java:
##########
@@ -96,150 +108,132 @@ public class GcpAuthAutoConfigurationCustomizerProvider
* enable GCP integration.
*
* @param autoConfiguration the AutoConfigurationCustomizer to customize.
+ * @throws GoogleAuthException if there's an error retrieving Google Application Default
+ * Credentials.
+ * @throws io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException if required options are
+ * not configured through environment variables or system properties.
*/
@Override
public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
+ GoogleCredentials credentials;
+ try {
+ credentials = GoogleCredentials.getApplicationDefault();
+ } catch (IOException e) {
+ throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
+ }
autoConfiguration
- .addSpanExporterCustomizer(this::customizeSpanExporter)
- .addMetricExporterCustomizer(this::customizeMetricExporter)
- .addResourceCustomizer(this::customizeResource);
+ .addSpanExporterCustomizer(
+ (spanExporter, configProperties) ->
+ customizeSpanExporter(spanExporter, credentials, configProperties))
+ .addMetricExporterCustomizer(
+ (metricExporter, configProperties) ->
+ customizeMetricExporter(metricExporter, credentials, configProperties))
+ .addResourceCustomizer(
+ (resource, configProperties) ->
+ customizeResource(resource, credentials, configProperties));
}
Review Comment:
Eagerly loading `GoogleCredentials.getApplicationDefault()` inside the `customize` method will throw a `GoogleAuthException` during OpenTelemetry SDK initialization if GCP Application Default Credentials are not configured. This happens even if the user has explicitly disabled GCP authentication (e.g., by setting the signal type to `none`) or is not targeting GCP endpoints, because this customizer is loaded via SPI on startup.
To fix this, we should defer the loading of credentials using a lazy `Supplier` so that they are only retrieved when a GCP-targeted signal is actually processed.
```java
@Override
public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
java.util.function.Supplier<GoogleCredentials> credentialsSupplier =
new java.util.function.Supplier<>() {
private GoogleCredentials credentials;
@Override
public synchronized GoogleCredentials get() {
if (credentials == null) {
try {
credentials = GoogleCredentials.getApplicationDefault();
} catch (IOException e) {
throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
}
}
return credentials;
}
};
autoConfiguration
.addSpanExporterCustomizer(
(spanExporter, configProperties) ->
customizeSpanExporter(spanExporter, credentialsSupplier, configProperties))
.addMetricExporterCustomizer(
(metricExporter, configProperties) ->
customizeMetricExporter(metricExporter, credentialsSupplier, configProperties))
.addResourceCustomizer(
(resource, configProperties) ->
customizeResource(resource, credentialsSupplier, configProperties));
}
```
##########
sdks/java/extensions/opentelemetry-gcp-auth-extension/src/main/java/org/apache/beam/sdk/extensions/opentelemetry/gcp/auth/GcpAuthAutoConfigurationCustomizerProvider.java:
##########
@@ -96,150 +108,132 @@ public class GcpAuthAutoConfigurationCustomizerProvider
* enable GCP integration.
*
* @param autoConfiguration the AutoConfigurationCustomizer to customize.
+ * @throws GoogleAuthException if there's an error retrieving Google Application Default
+ * Credentials.
+ * @throws io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException if required options are
+ * not configured through environment variables or system properties.
*/
@Override
public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
+ GoogleCredentials credentials;
+ try {
+ credentials = GoogleCredentials.getApplicationDefault();
+ } catch (IOException e) {
+ throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
+ }
autoConfiguration
- .addSpanExporterCustomizer(this::customizeSpanExporter)
- .addMetricExporterCustomizer(this::customizeMetricExporter)
- .addResourceCustomizer(this::customizeResource);
+ .addSpanExporterCustomizer(
+ (spanExporter, configProperties) ->
+ customizeSpanExporter(spanExporter, credentials, configProperties))
+ .addMetricExporterCustomizer(
+ (metricExporter, configProperties) ->
+ customizeMetricExporter(metricExporter, credentials, configProperties))
+ .addResourceCustomizer(
+ (resource, configProperties) ->
+ customizeResource(resource, credentials, configProperties));
}
@Override
public int order() {
return Integer.MAX_VALUE - 1;
}
- private synchronized GoogleCredentials getCredentials() {
- if (credentials == null) {
- try {
- credentials = GoogleCredentials.getApplicationDefault();
- } catch (IOException e) {
- throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
- }
- }
- return credentials;
- }
-
- private SpanExporter customizeSpanExporter(
- SpanExporter exporter, ConfigProperties configProperties) {
+ private static SpanExporter customizeSpanExporter(
+ SpanExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
if (isSignalTargeted(SIGNAL_TYPE_TRACES, configProperties)) {
- return addAuthorizationHeaders(exporter, configProperties);
+ return addAuthorizationHeaders(exporter, credentials, configProperties);
+ } else if (!hasSignal(SIGNAL_TYPE_NONE, configProperties)) {
+ String[] params = {SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_FIX_SUGGESTION};
+ logger.log(
+ Level.WARNING,
+ "GCP Authentication Extension is not configured for signal type: {0}. {1}",
+ params);
}
return exporter;
}
Review Comment:
Update `customizeSpanExporter` to accept a lazy `Supplier<GoogleCredentials>` instead of eagerly loaded `GoogleCredentials`.
```java
private static SpanExporter customizeSpanExporter(
SpanExporter exporter,
java.util.function.Supplier<GoogleCredentials> credentialsSupplier,
ConfigProperties configProperties) {
if (isSignalTargeted(SIGNAL_TYPE_TRACES, configProperties)) {
return addAuthorizationHeaders(exporter, credentialsSupplier.get(), configProperties);
} else if (!hasSignal(SIGNAL_TYPE_NONE, configProperties)) {
String[] params = {SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_FIX_SUGGESTION};
logger.log(
Level.WARNING,
"GCP Authentication Extension is not configured for signal type: {0}. {1}",
params);
}
return exporter;
}
```
##########
sdks/java/extensions/opentelemetry-gcp-auth-extension/src/main/java/org/apache/beam/sdk/extensions/opentelemetry/gcp/auth/GcpAuthAutoConfigurationCustomizerProvider.java:
##########
@@ -262,16 +256,13 @@ private Map<String, String> getRequiredHeaderMap(ConfigProperties configProperti
}
// Updates the current resource with the attributes required for ingesting OTLP data on GCP.
- private Resource customizeResource(Resource resource, ConfigProperties configProperties) {
- if (!isAnySignalTargeted(configProperties)) {
- return resource;
- }
-
+ private static Resource customizeResource(
+ Resource resource, GoogleCredentials credentials, ConfigProperties configProperties) {
String gcpProjectId;
try {
gcpProjectId = ConfigurableOption.GOOGLE_CLOUD_PROJECT.getConfiguredValue(configProperties);
} catch (ConfigurationException e) {
- gcpProjectId = getCredentials().getProjectId();
+ gcpProjectId = credentials.getProjectId();
if (gcpProjectId == null || gcpProjectId.isEmpty()) {
throw e;
}
Review Comment:
In addition to accepting a lazy `Supplier<GoogleCredentials>`, we must restore the check to verify if any signal is targeted for GCP authentication before attempting to customize the resource. Without this check, `customizeResource` will always run and throw a `ConfigurationException` if the GCP project ID is missing, even if the user has explicitly disabled GCP authentication (e.g., by setting the signal type to `none`).
```java
private static Resource customizeResource(
Resource resource,
java.util.function.Supplier<GoogleCredentials> credentialsSupplier,
ConfigProperties configProperties) {
if (!isSignalTargeted(SIGNAL_TYPE_TRACES, configProperties)
&& !isSignalTargeted(SIGNAL_TYPE_METRICS, configProperties)) {
return resource;
}
String gcpProjectId;
try {
gcpProjectId = ConfigurableOption.GOOGLE_CLOUD_PROJECT.getConfiguredValue(configProperties);
} catch (ConfigurationException e) {
gcpProjectId = credentialsSupplier.get().getProjectId();
if (gcpProjectId == null || gcpProjectId.isEmpty()) {
throw e;
}
```
##########
sdks/java/extensions/opentelemetry-gcp-auth-extension/src/main/java/org/apache/beam/sdk/extensions/opentelemetry/gcp/auth/GcpAuthAutoConfigurationCustomizerProvider.java:
##########
@@ -96,150 +108,132 @@ public class GcpAuthAutoConfigurationCustomizerProvider
* enable GCP integration.
*
* @param autoConfiguration the AutoConfigurationCustomizer to customize.
+ * @throws GoogleAuthException if there's an error retrieving Google Application Default
+ * Credentials.
+ * @throws io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException if required options are
+ * not configured through environment variables or system properties.
*/
@Override
public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
+ GoogleCredentials credentials;
+ try {
+ credentials = GoogleCredentials.getApplicationDefault();
+ } catch (IOException e) {
+ throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
+ }
autoConfiguration
- .addSpanExporterCustomizer(this::customizeSpanExporter)
- .addMetricExporterCustomizer(this::customizeMetricExporter)
- .addResourceCustomizer(this::customizeResource);
+ .addSpanExporterCustomizer(
+ (spanExporter, configProperties) ->
+ customizeSpanExporter(spanExporter, credentials, configProperties))
+ .addMetricExporterCustomizer(
+ (metricExporter, configProperties) ->
+ customizeMetricExporter(metricExporter, credentials, configProperties))
+ .addResourceCustomizer(
+ (resource, configProperties) ->
+ customizeResource(resource, credentials, configProperties));
}
@Override
public int order() {
return Integer.MAX_VALUE - 1;
}
- private synchronized GoogleCredentials getCredentials() {
- if (credentials == null) {
- try {
- credentials = GoogleCredentials.getApplicationDefault();
- } catch (IOException e) {
- throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
- }
- }
- return credentials;
- }
-
- private SpanExporter customizeSpanExporter(
- SpanExporter exporter, ConfigProperties configProperties) {
+ private static SpanExporter customizeSpanExporter(
+ SpanExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
if (isSignalTargeted(SIGNAL_TYPE_TRACES, configProperties)) {
- return addAuthorizationHeaders(exporter, configProperties);
+ return addAuthorizationHeaders(exporter, credentials, configProperties);
+ } else if (!hasSignal(SIGNAL_TYPE_NONE, configProperties)) {
+ String[] params = {SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_FIX_SUGGESTION};
+ logger.log(
+ Level.WARNING,
+ "GCP Authentication Extension is not configured for signal type: {0}. {1}",
+ params);
}
return exporter;
}
- private MetricExporter customizeMetricExporter(
- MetricExporter exporter, ConfigProperties configProperties) {
+ private static MetricExporter customizeMetricExporter(
+ MetricExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
if (isSignalTargeted(SIGNAL_TYPE_METRICS, configProperties)) {
- return addAuthorizationHeaders(exporter, configProperties);
+ return addAuthorizationHeaders(exporter, credentials, configProperties);
+ } else if (!hasSignal(SIGNAL_TYPE_NONE, configProperties)) {
+ String[] params = {SIGNAL_TYPE_METRICS, SIGNAL_TARGET_WARNING_FIX_SUGGESTION};
+ logger.log(
+ Level.WARNING,
+ "GCP Authentication Extension is not configured for signal type: {0}. {1}",
+ params);
}
return exporter;
}
Review Comment:
Update `customizeMetricExporter` to accept a lazy `Supplier<GoogleCredentials>` instead of eagerly loaded `GoogleCredentials`.
```suggestion
private static MetricExporter customizeMetricExporter(
MetricExporter exporter,
java.util.function.Supplier<GoogleCredentials> credentialsSupplier,
ConfigProperties configProperties) {
if (isSignalTargeted(SIGNAL_TYPE_METRICS, configProperties)) {
return addAuthorizationHeaders(exporter, credentialsSupplier.get(), configProperties);
} else if (!hasSignal(SIGNAL_TYPE_NONE, configProperties)) {
String[] params = {SIGNAL_TYPE_METRICS, SIGNAL_TARGET_WARNING_FIX_SUGGESTION};
logger.log(
Level.WARNING,
"GCP Authentication Extension is not configured for signal type: {0}. {1}",
params);
}
return exporter;
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [OpenTelemetry] Add turning off to gcpauth extension [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38846:
URL: https://github.com/apache/beam/pull/38846#issuecomment-4651295413
Assigning reviewers:
R: @chamikaramj for label java.
R: @liferoad for label build.
Note: If you would like to opt out of this review, comment `assign to next reviewer`.
Available commands:
- `stop reviewer notifications` - opt out of the automated review tooling
- `remind me after tests pass` - tag the comment author after tests pass
- `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
The PR bot will only process comments in the main thread (not review comments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [OpenTelemetry] Add turning off to gcpauth extension [beam]
Posted by "kennknowles (via GitHub)" <gi...@apache.org>.
kennknowles merged PR #38846:
URL: https://github.com/apache/beam/pull/38846
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [OpenTelemetry] Add turning off to gcpauth extension [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #38846:
URL: https://github.com/apache/beam/pull/38846#issuecomment-4649231312
## Summary of Changes
Hello, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the OpenTelemetry GCP authentication extension by providing a mechanism to disable authentication entirely via a new 'none' configuration option. It also includes structural improvements to the configuration provider to ensure more robust signal targeting and better feedback through logging when configurations are missing or incorrect.
### Highlights
* **Added 'none' option**: Introduced a 'none' configuration option to the OpenTelemetry GCP authentication extension, allowing users to explicitly disable authentication for all exports.
* **Improved configuration handling**: Refactored the `GcpAuthAutoConfigurationCustomizerProvider` to improve how signals are targeted and validated, including better logging for misconfigurations.
* **Test suite updates**: Updated the test suite to include Mockito JUnit Jupiter support and refactored existing tests for better maintainability and coverage of the new 'none' option.
<details>
<summary><b>New Features</b></summary>
🧠You can now enable **Memory** (public preview) to help **Gemini Code Assist** learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. **Click [here](https://codeassist.google/code-review/login) to enable Memory in your admin console.**
</details>
<details>
<summary><b>Using Gemini Code Assist</b></summary>
<br>
The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
<b>Invoking Gemini</b>
You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page.
Feature | Command | Description
--- | --- | ---
Code Review | `/gemini review` | Performs a code review for the current pull request in its current state.
Pull Request Summary | `/gemini summary` | Provides a summary of the current pull request in its current state.
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help | `/gemini help` | Displays a list of available commands.
<b>Customization</b>
To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a `.gemini/` folder in the base of the repository. Detailed instructions can be found [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
<b>Limitations & Feedback</b>
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
</details>
[^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org