[DDO-3268] Improve logging/metrics for Gin responses #338
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
|
No API changes detected |
Codecov Report
@@ Coverage Diff @@
## main #338 +/- ##
==========================================
- Coverage 63.23% 63.21% -0.02%
==========================================
Files 147 147
Lines 8671 8683 +12
==========================================
+ Hits 5483 5489 +6
- Misses 2813 2819 +6
Partials 375 375
|
mikeflinn
approved these changes
Oct 27, 2023
Comment on lines
+89
to
+95
| output.FormatCaller = func(i interface{}) string { | ||
| if i == nil { | ||
| return "" | ||
| } else { | ||
| return fmt.Sprintf("%-50s |", strings.TrimPrefix(fmt.Sprintf("%s", i), "/build/sherlock/internal")) | ||
| } | ||
| } |
There was a problem hiding this comment.
Curious what this is for?
There was a problem hiding this comment.
You can set log.caller: true in the config and then this function formats out the call-site of the log message:
Added a comment to the function to explain that in-line
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds metrics for response latency/count, by Gin's matched route.
Also touches up logging. Normal internal log messages are staying the same, but the Gin ones now take full advantage of Zerolog's JSON fields. Things like the status code, client IP, latency, etc are no longer logged in just a big string, they're logged as fields with Zerolog.
This makes the Gin logging slightly worse locally, but way, way better through GCP. It's a balancing act and I think the Gin logs are primarily useful through GCP anyway, so I think it's okay. This also helps avoid logging things to console that we only need on GCP, like the client IP.
Before:
After:
Testing
Screenshots above; visited /metrics to validate that part.
Risk
Very low, no functionality changing, just logs