-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
docs: troubleshooting guide for logging #9315
Conversation
very minor nit: guilde -> guide in PR title |
.level=INFO | ||
|
||
# Specify logging level for certain packages | ||
com.google.api.level=ALL |
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.
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?
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.
Added comments.
Note that even when you use gRPC library, some authentication happens in HTTP 1.1.
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.
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?
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.
That does not show HTTP headers.
io.grpc.level=FINE | ||
|
||
# Example when we want to specify storge library's level | ||
com.google.cloud.storage.level=INFO |
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.
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?
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.
Added that.
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. |
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. |
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.
Thanks for then note Lawrence! I think it should be already covered by |
Document to explain how to change logging level for our libraries and underlying libraries.
Credit: I used @BenWhitehead 's snippet in bits benwhitehead/6166544285433856.