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.

Sign up for GitHub

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

Jump to bottom

Logging: add support for additional 'LogEntry' fields #6229

Merged
merged 17 commits into from
Oct 22, 2018
Merged

Logging: add support for additional 'LogEntry' fields #6229

merged 17 commits into from
Oct 22, 2018

Conversation

tseaver
Copy link
Contributor

@tseaver tseaver commented Oct 16, 2018 •
edited
Loading

/cc @salrashid123.

Note that this PR refactors the log entry implementation pretty heavily: log entry classes are now based on named tuples, and should be a) smaller, b) faster, and c) better documented.

Closes #5601 (includes its commits).

Closes #6094.

@tseaver tseaver added the api: logging Issues related to the Cloud Logging API. label Oct 16, 2018
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 16, 2018
@salrashid123
Copy link
Contributor

@tseaver thanks
I referened google-cloud-logging in flask-gcp-log-groups , and reused background_thread.py there but i don't think this change will impact it;

@tseaver tseaver mentioned this pull request Oct 17, 2018
Closed
@tseaver
Copy link
Contributor Author

tseaver commented Oct 17, 2018

Kokoro did not run the logging unit tests on this last push (see #6231). Merging blocked until that issue is resolved, and the job is re-run.

@tseaver tseaver added do not merge Indicates a pull request not ready for merge, due to either quality or timing. api: bigtable Issues related to the Bigtable API. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Oct 17, 2018
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 17, 2018
@tseaver
Copy link
Contributor Author

tseaver commented Oct 17, 2018

Bigtable test flake (#6245) is unrelated to this change.

@tseaver
Parse 'LogEntry.receiveTimestamp' -> 'received_timestamp' attr.
d47ebc5 
Closes #5601.
@tseaver
Make 'received_timestamp' default to 'None' for all instances.
e24e2f3 
It is set only when parsing a server response.
@tseaver
Normalize long argument lists to argument-per-line.
6d6c2f8 
Eases comparison of delegated arguments.
@tseaver
Add support for 'LogEntry.traceSampled' field.
0827345 
Toward #6094.
@tseaver
Use namedtuple to reduce boilerplate in 'logger.Batch' impl.
1eba5ea
@tseaver
Use namedtuple to reduce boilerplate in 'logger.Logger' impl.
d8ef933
@tseaver
Reduce / coalesce redundant tests.
5b3942d
@tseaver
Use namedtuple for unsent entries.
8021b56
@tseaver
Add support for 'source_location' field of log entries.
543d743 
Toward #6094.
@tseaver
Add docstring for 'logger.OutboundEntry' namedtuple.
9cc5e4f
@tseaver
Add 'log_name' to 'logger.OutboundEntry' namedtuple.
087d085 
Single-entry logger methods pass it.  Batch methods do not, because the
log name for batches is passed as a top-level parameter.
@tseaver
Use nametuples for both received and sent log entries.
bde1f4e
@tseaver
Add support for 'operation' field of log entries.
aefaab4 
Closes #6094.
@tseaver
Rename 'LogEntry._type' -> 'entry_type' to fix Sphinx build.
7eff928
@tseaver
Tweak log entry docstrings to improve Sphinx rendering.
0fb0ed7
@tseaver
Add 'ProtobufEntry.payload_json'.
2bf8477 
Returns 'None' if the payload is a protobuf message.

'ProtobufEntry.payload_pb' now returns 'None' if the payload is *not*
a protobuf message.

Update system tests accordingly.
@tseaver
Refactor:
30baca5 
- Remove 'entry_type' and 'PAYLOAD_KEY' warts, dispatching instead based
on class to load / save payload.

Normalize inheritance hierarchy, removing spurious named tuples.

Drop 'EmptyEntry':  just use 'LogEntry'.
@tseaver tseaver force-pushed the 6094-logging-additional_entry_fields branch from 11f6ef6 to 30baca5 Compare October 17, 2018 20:51
@tseaver
Copy link
Contributor Author

tseaver commented Oct 17, 2018

Rebased to try getting Kokoro to run only for logging.

@tseaver tseaver removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 17, 2018
@tseaver
Copy link
Contributor Author

tseaver commented Oct 17, 2018

@crwilcox, @chrisrossi This branch is finally right with CI, and should be ready to review once the Kokoro - Logging job completes.

@tseaver tseaver removed the api: bigtable Issues related to the Bigtable API. label Oct 17, 2018
@tseaver tseaver mentioned this pull request Oct 18, 2018
Closed
@tseaver tseaver merged commit 06c60ec into master Oct 22, 2018
@tseaver tseaver deleted the 6094-logging-additional_entry_fields branch October 22, 2018 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisrossi chrisrossi chrisrossi approved these changes

@crwilcox crwilcox Awaiting requested review from crwilcox

Assignees
No one assigned
Labels
api: logging Issues related to the Cloud Logging API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@tseaver @salrashid123 @chrisrossi @googlebot @kokoro-team