FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: troubleshooting guide for logging by suztomo · Pull Request #9315 · googleapis/google-cloud-java · GitHub

/ google-cloud-java Public

docs: troubleshooting guide for logging - #9315

Merged
gcf-merge-on-green[bot] merged 2 commits into
googleapis:mainfrom
suztomo:logging
Apr 5, 2023
ConversationCommits (2)ChecksFiles changed
Merged

docs: troubleshooting guide for logging#9315
gcf-merge-on-green[bot] merged 2 commits into
googleapis:mainfrom
suztomo:logging

Conversation

suztomo commented Apr 5, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Document to explain how to change logging level for our libraries and underlying libraries.

Credit: I used @BenWhitehead 's snippet in bits benwhitehead/6166544285433856.

suztomo changed the title docs: troubleshooting with logging docs: troubleshooting guilde for logging Apr 5, 2023

rajatbhatta commented Apr 5, 2023

Copy link
Copy Markdown
Contributor

very minor nit: guilde -> guide in PR title

blakeli0 reviewed Apr 5, 2023
View reviewed changes
Comment thread TROUBLESHOOTING.md
.level=INFO

# Specify logging level for certain packages
com.google.api.level=ALL

blakeli0 Apr 5, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Can we add notes to indicate that this is only needed for REST APIs and io.groc.level below is only needed for gRPC APIs?

suztomo Apr 5, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Added comments.

Note that even when you use gRPC library, some authentication happens in HTTP 1.1.

blakeli0 Apr 5, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Note that even when you use gRPC library, some authentication happens in HTTP 1.1.

Thanks, that's good to know. I guess it would be mostly covered by the com.google.auth.level=FINE below?

suztomo Apr 5, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

That does not show HTTP headers.

suztomo changed the title docs: troubleshooting guilde for logging docs: troubleshooting guide for logging Apr 5, 2023
blakeli0 reviewed Apr 5, 2023
View reviewed changes
Comment thread TROUBLESHOOTING.md
io.grpc.level=FINE

# Example when we want to specify storge library's level
com.google.cloud.storage.level=INFO

blakeli0 Apr 5, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'm afraid this is only useful for handwritten libraries, for pure generated ones, we have very little logs, which is something we are planning to improve as part of the observability project. Can we add something to indicate it as well or maybe remove this section?

suztomo Apr 5, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Added that.

blakeli0 commented Apr 5, 2023

Copy link
Copy Markdown
Contributor

Thanks Tomo, this is very helpful! FYI, we are planning to improve the whole logging experience as part of the Observability project, so a lot of things could change, but this guide is pretty accurate as of now.

lqiu96 commented Apr 5, 2023

Copy link
Copy Markdown
Member

Looks good! IIRC, I have used this page previously for logging some of the HTTP requests for REGAPIC: http://googleapis.github.io/google-http-java-client/http-transport.html

I think your guide should cover the cases. Just FYI if you wanted to add anything else.

suztomo commented Apr 5, 2023
View reviewed changes

suztomo left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@blakeli0 PTAL.

Observability project,

Looking forward.

blakeli0 commented Apr 5, 2023

Copy link
Copy Markdown
Contributor

Looks good! IIRC, I have used this page previously for logging some of the HTTP requests for REGAPIC: http://googleapis.github.io/google-http-java-client/http-transport.html

I think your guide should cover the cases. Just FYI if you wanted to add anything else.

Thanks for then note Lawrence! I think it should be already covered by com.google.api.level=ALL as com.google.api.client.http is a sub-package of com.google.api.

suztomo added automerge Merge the pull request once unit tests and other checks pass. owlbot:run Add this label to trigger the Owlbot post processor. labels Apr 5, 2023
gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 5, 2023
gcf-merge-on-green Bot merged commit 971eb78 into googleapis:main Apr 5, 2023
gcf-merge-on-green Bot removed the automerge Merge the pull request once unit tests and other checks pass. label Apr 5, 2023
release-please Bot mentioned this pull request Apr 5, 2023
Merged
ddixit14 added the release-please:force-run To run release-please label Apr 6, 2023
release-please Bot removed the release-please:force-run To run release-please label Apr 6, 2023
ddixit14 added the release-please:force-run To run release-please label Apr 10, 2023
release-please Bot removed the release-please:force-run To run release-please label Apr 10, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

blakeli0 blakeli0 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL