feat(logging): update write_entry snippet to use Python logging framework#14361
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}
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.
|
This sample has been tested locally: 
|
amcolin
left a comment
amcolin
left a comment
There was a problem hiding this comment.
It looks great overall, though there are a few suggestions to consider.
2 participants
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