feat(logging): update write_entry snippet to use Python logging framework#14361
Open
XrossFox wants to merge 3 commits into
Open
feat(logging): update write_entry snippet to use Python logging framework#14361XrossFox wants to merge 3 commits into
XrossFox wants to merge 3 commits into
Conversation
…ework - Update `write_entry` in `snippets.py` to use `google.cloud.logging.setup_logging()` instead of calling the client logger methods directly. - Demonstrate writing a structured JSON log using the standard `logging` library's `extra` parameter. - Update `test_write` in `snippets_test.py` to verify logs written via the default python logging handler. - Remove python version constraint for pytest in `requirements-test.txt`.
product-auto-label
Bot
added
api: logging
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the logging snippets to use the standard Python logging framework integrated with Google Cloud Logging via setup_logging(), replacing the custom logger implementation. It also updates the corresponding tests to verify the written logs. The reviewer identified two issues: an outdated docstring in snippets.py that still references a logger parameter, and potential test flakiness in snippets_test.py due to an incorrect log filter format and direct calls to next() on the entries iterator which can raise an unhandled StopIteration exception.
Contributor
Author
|
This sample has been tested locally: 
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
write_entryinsnippets.pyto usegoogle.cloud.logging.setup_logging()instead of calling the client logger methods directly.logginglibrary'sextraparameter.test_writeinsnippets_test.pyto verify logs written via the default python logging handler.requirements-test.txt.Fixes b/234303347
Checklist
Testing
Compliance & Style
Post-Approval Actions