-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java. #26770
Conversation
* Prepend "(GPN:Beam)" to the application name, which is then used in constructing the user agent string by GCS client APIs. * Add a unit test.
Assigning reviewers. If you would like to opt out of this review, comment R: @Abacn for label java. Available commands:
The PR bot will only process comments in the main thread (not review comments). |
...gle-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/Transport.java
Outdated
Show resolved
Hide resolved
Run Java_Examples_Dataflow PreCommit |
Run Java PreCommit |
Run Java_GCP_IO_Direct PreCommit |
Storage.Objects.Get getObject = storageClient.objects().get("testbucket", "testobject"); | ||
// An example of user agent string will be like | ||
// "TransportTest (GPN:Beam) Google-API-Java-Client/2.0.0" | ||
assertThat(getObject.getRequestHeaders().getUserAgent(), containsString("(GPN:Beam)")); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we discovered the possible problem in code review, how about also checking that the userAgent string is valid. Or at least that if you split it on space that the GPN:Beam is not the first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
…a. (apache#26770) * Include "(GPN:Beam)" in the user agent of GCS HTTP request header. * Prepend "(GPN:Beam)" to the application name, which is then used in constructing the user agent string by GCS client APIs. * Add a unit test. * Run spotlessApply for format. * Add '(GPN:Beam)' after the origin application name * Check and ensure the user agent string meets the minimum requirement.
This PR should fix #26644 for Java SDKs.
For more details, please see the comment here.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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, commentfixes #<ISSUE NUMBER>
instead.CHANGES.md
with noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI.