jsonclient: log client URI when logging errors #617
Merged
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
added 2 commits
November 19, 2019 13:58
When dependent software manages submission to several logs by creating multiple LogClient instances the error messages logged by the underlying JSONClient need to identify the URI at fault. Otherwise messages like the following are written to the logger: ``` Request failed, backing-off for 8.032332341s: got HTTP status 503 Service Temporarily Unavailable ``` Without more context it's difficult to determine _which_ log returned a 503. Prior to this commit `JSONClient.PostAndParseWithRetry` logged the underlying URI in one error logging site but not two others, including the bad status code case shared above.
cpu
changed the title
Codecov Report
@@ Coverage Diff @@
## master #617 +/- ##
=======================================
Coverage 71.77% 71.77%
=======================================
Files 90 90
Lines 9801 9801
=======================================
Hits 7035 7035
Misses 2273 2273
Partials 493 493
Continue to review full report at Codecov.
|
Martin2112
approved these changes
Nov 20, 2019
|
Thanks @Martin2112! |
zorawar87
pushed a commit
to n-ct/certificate-transparency-go
that referenced
this pull request
Mar 1, 2020
* jsonclient: log client URI when logging errors. When dependent software manages submission to several logs by creating multiple LogClient instances the error messages logged by the underlying JSONClient need to identify the URI at fault. Otherwise messages like the following are written to the logger: ``` Request failed, backing-off for 8.032332341s: got HTTP status 503 Service Temporarily Unavailable ``` Without more context it's difficult to determine _which_ log returned a 503. Prior to this commit `JSONClient.PostAndParseWithRetry` logged the underlying URI in one error logging site but not two others, including the bad status code case shared above. * CHANGELOG: add JSONClient logging diff
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.
When dependent software manages submission to several logs by creating multiple
LogClientinstances the error messages logged by the underlyingJSONClientneed to identify theURIat fault or they don't have enough context to stand-alone. E.g. If aLogClientfails an initial submission to a log but will retry after a period a line like the following is logged:Without more context it's difficult to determine which log returned a 503 prompting a backed-off retry.
Prior to this PR
JSONClient.PostAndParseWithRetrylogged the underlying URI in one error logging site but not two others, including the bad status code case shared above. This PR adds the URI to the other two sites and adjusts the wording of the existing site to be consistent.Checklist