feat: logging for json unmarshaling errors in Go SDK #79
+62
−2
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
MegaportPhilipBrowne
force-pushed
the
feat/json-marshal-logging
branch
2 times, most recently
from
8403d6a
to
67786f9
Compare
MegaportPhilipBrowne
force-pushed
the
feat/json-marshal-logging
branch
from
67786f9
to
0957909
Compare
mega-alex
reviewed
Oct 1, 2024
Comment on lines
+313
to
+322
| func (c *Client) LogJSONUnmarshalError(ctx context.Context, responseBody string, responseType string, respSchema interface{}, err error) { | ||
| expectedJSON, _ := json.Marshal(respSchema) | ||
| c.Logger.DebugContext(ctx, "error unmarshaling response body", | ||
| slog.String("response_body", responseBody), | ||
| slog.String("response_type", responseType), | ||
| slog.String("expected_json_schema", fmt.Sprintf("%+v", expectedJSON)), | ||
| slog.String("error", err.Error()), | ||
| ) | ||
| } | ||
|
|
There was a problem hiding this comment.
I think a better way to approach this would be to add a config option to the logger that would enable logging of all request JSON optionally.
in client.go we have a Do() method that logs every request already, I think what would be good is to add some extra client config to log the response body as part of the existing request logs. I've added the section that does that logging here.
c.Logger.DebugContext(ctx, "completed API request",
slog.Duration("duration", reqTime),
slog.Int("status_code", resp.StatusCode),
slog.String("path", req.URL.EscapedPath()),
slog.String("api_host", c.BaseURL.Host),
slog.String("method", req.Method),
slog.String("trace_id", resp.Header.Get(headerTraceId)),
)
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.
Contributions
Please read the (Contribution Guidelines)[https://github.com/megaport/megaportgo/wiki/Contributing.md]
prior to lodging Pull Requests (PR).
Description
Please include a summary of the change and which issue is fixed. Please also include any relevant motivation and context.
List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
Contributor Agreement
Lodging this Pull Request (PR) indicates agreement with the project's
(Contributor License Agreement)[https://github.com/megaport/megaportgo/wiki/Megaport_Contributor_Licence_Agreement.md].
Please read the Contributor Licence Agreement (CLA) and affirm your acceptance here:
[I have read an accept the CLA]
NOTE If multiple authors have commited to this PR, each one will need to comment on this PR and
agree to the CLA before this PR can be accepted.