chore: include request id in debug logs and diagnostics #581
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #581 +/- ##
==========================================
- Coverage 75.62% 75.61% -0.01%
==========================================
Files 87 87
Lines 7277 7283 +6
==========================================
+ Hits 5503 5507 +4
- Misses 1423 1425 +2
Partials 351 351 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
cewkrupa
commented
Nov 20, 2024
| @@ -141,7 +141,7 @@ func NewClientWithConfig(config *Config) (*Client, error) { | |||
| // if enabled we log all requests and responses to sterr | |||
| client.httpClient.Logger = log.New(os.Stderr, "", log.LstdFlags) | |||
| client.httpClient.ResponseLogHook = func(l retryablehttp.Logger, resp *http.Response) { | |||
| l.Printf("[DEBUG] Response: %s %s", resp.Request.Method, resp.Request.URL.String()) | |||
There was a problem hiding this comment.
I changed this to say "Request" because we weren't actually logging much about the response, just the request. I added the request ID and the status as well.
| @@ -53,8 +53,8 @@ func AddDiagnosticOnError(diag *diag.Diagnostics, summary string, err error) boo | |||
| } | |||
|
|
|||
| func (d DetailedErrorDiagnostic) Detail() string { | |||
| response := fmt.Sprintf("ID: %s\n", d.e.ID) | |||
There was a problem hiding this comment.
We're doing some confusing things with looping over the Details of the error to generate the message, and it's otherwise not super consistent as far as I can tell. Super open to other ideas of how to format this.
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.
Which problem is this PR solving?
When calls to the Honeycomb API fail in tests and in real operation, we don't get much detail about what's wrong - just an error message if we're lucky. We've recently added a
Request-Idheader to our API responses to aid in debugging.Short description of the changes
This PR pulls the
Request-Idheader of failed requests into the error messages, so they'll show up in test failures, in debug mode, and in regular operation.How to verify that this has the expected result