Use metadata in log messages #720
Merged
Conversation
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
Motivation: I was analyzing some logs produced by grpc-swift but some of the messages lack structure, making it more difficult than it should be to run queries on the logs. SwiftLog supports structured logging and its API allow us to log a message and some metadata associated to it. Keeping the message string constant and logging the variable pieces of information as metadata, the logs produced by grpc-swift are going to be more easily analysed and processed. Modifications: This commit changes the logging calls where we had a variable message to have a constant message. The variable pieces of information are stored as metadata. Result: grpc-swift will produce log messages that can be analyzed and processed more easily.
|
|
glbrntt
requested changes
Feb 10, 2020
Collaborator
glbrntt
left a comment
glbrntt
left a comment
There was a problem hiding this comment.
Thanks @mariosangiorgio -- I left a couple of casing suggestions inline, looks great otherwise.
Co-Authored-By: George Barnett <gbrntt@gmail.com>
Co-Authored-By: George Barnett <gbrntt@gmail.com>
Co-Authored-By: George Barnett <gbrntt@gmail.com>
Contributor
Author
|
@glbrntt thanks for spotting the wrong casing and the suggested fixed! |
glbrntt
approved these changes
Feb 10, 2020
Collaborator
glbrntt
left a comment
glbrntt
left a comment
There was a problem hiding this comment.
LGTM, thanks @mariosangiorgio
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation:
I was analyzing some logs produced by grpc-swift but some of the messages lack structure, making it more difficult than it should be to run queries on the logs.
SwiftLog supports structured logging and its API allow us to log a message and some metadata associated to it.
Keeping the message string constant and logging the variable pieces of information as metadata, the logs produced by grpc-swift are going to be more easily analysed and processed.
Modifications:
This commit changes the logging calls where we had a variable message to have a constant message. The variable pieces of information are stored as metadata.
Result:
grpc-swift will produce log messages that can be analyzed and processed more easily.