Skip to content
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

chore: comment about how to instantiate logger variable in Cloud Run #9340

Merged
merged 1 commit into from
May 22, 2024

Conversation

suztomo
Copy link
Contributor

@suztomo suztomo commented May 22, 2024

This App.java is referenced in https://cloud.google.com/run/docs/samples/cloudrun-manual-logging#cloudrun_manual_logging-java. But the document does not explain how to instantiate and configure the logger variable.

https://cloud.google.com/run/docs/logging#run_manual_logging-java has the answer. So let's add the explanation in the source code comment.

Description

Fixes #

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

  • I have followed Sample Format Guide
  • pom.xml parent set to latest shared-configuration
  • Appropriate changes to README are included in PR
  • These samples need a new API enabled in testing projects to pass (let us know which ones)
  • These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
  • Tests pass: mvn clean verify required
  • Lint passes: mvn -P lint checkstyle:check required
  • Static Analysis: mvn -P lint clean compile pmd:cpd-check spotbugs:check advisory only
  • This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
  • This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
  • Please merge this PR for me once it is approved

This App.java is referenced in https://cloud.google.com/run/docs/samples/cloudrun-manual-logging#cloudrun_manual_logging-java. But the document does not explain how to instantiate and configure the logger variable.

https://cloud.google.com/run/docs/logging#run_manual_logging-java has the answer. So let's add the explanation in the source code comment.
@suztomo suztomo requested review from yoshi-approver and a team as code owners May 22, 2024 17:58
@product-auto-label product-auto-label bot added samples Issues that are directly related to samples. api: run Issues related to the Cloud Run API. labels May 22, 2024
Copy link
Contributor

@iennae iennae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM;

Thank you! This is a fantastic catch and appreciate you adding context for folks to be able to understand what to do here.

@suztomo suztomo merged commit 21733b8 into main May 22, 2024
11 checks passed
@suztomo suztomo deleted the suztomo-patch-1 branch May 22, 2024 19:17
@suztomo
Copy link
Contributor Author

suztomo commented May 23, 2024

@iennae Thank you for quick response. Now I see https://cloud.google.com/run/docs/samples/cloudrun-manual-logging#cloudrun_manual_logging-java has been updated. Good.

rafaelMurata pushed a commit to rafaelMurata/java-docs-samples that referenced this pull request May 27, 2024
…oogleCloudPlatform#9340)

This App.java is referenced in https://cloud.google.com/run/docs/samples/cloudrun-manual-logging#cloudrun_manual_logging-java. But the document does not explain how to instantiate and configure the logger variable.

https://cloud.google.com/run/docs/logging#run_manual_logging-java has the answer. So let's add the explanation in the source code comment.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: run Issues related to the Cloud Run API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants