Firestore: Improve debug logging of GrpcConnection and WebChannelConnection #7076
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: b53446c The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (462,003 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
milaGGL
reviewed
Mar 2, 2023
Merged
renkelvin
pushed a commit
that referenced
this pull request
Mar 21, 2023
renkelvin
pushed a commit
that referenced
this pull request
Mar 21, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR improves the debug logs of
GrpcConnectionandWebChannelConnectionto make it easier to make sense out of the logs.First, each log message now contains a unique ID to make it easier to trace the life of an RPC from beginning to end. These "IDs" are 10-digit strings containing a hexadecimal value (e.g. "0x2344821f").
Second, each log message tags itself as "GrpcConnection" or "WebChannelConnection" rather than both using the generic "Connection" tag. This change helps point to the right place in the source code when trying to correlate log messages with its line of code.
Third, each log message now contains the name of its RPC. Previously, both "Listen" and "Write" streams would have their logs intertwined with no way to tell them apart. Now, the log line clearly indicates which RPC is pertains to.