feat: Improve GitHub and GitLab Debug Logging #3876
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
github-actions
bot
added
go
jamengual
approved these changes
Oct 20, 2023
GenPage
pushed a commit
that referenced
this pull request
Nov 14, 2023
* Improve GitHub and GitLab Debug Logging * Fix formatting * Fix g.client.Repositories.Get debug message * Update gitlab_client_test with logger --------- Co-authored-by: PePe Amengual <[email protected]>
This was referenced Dec 20, 2023
ijames-gc
pushed a commit
to gocardless/atlantis
that referenced
this pull request
Feb 13, 2024
* Improve GitHub and GitLab Debug Logging * Fix formatting * Fix g.client.Repositories.Get debug message * Update gitlab_client_test with logger --------- Co-authored-by: PePe Amengual <[email protected]>
ijames-gc
pushed a commit
to gocardless/atlantis
that referenced
this pull request
Feb 13, 2024
* Improve GitHub and GitLab Debug Logging * Fix formatting * Fix g.client.Repositories.Get debug message * Update gitlab_client_test with logger --------- Co-authored-by: PePe Amengual <[email protected]>
1 task
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.
what
Improve the GitHub and GitLab client debug logging so that each API call is logged along with the HTTP status response.
The GitLab Client tests also needed updating with a logger property on the Gitlab Client.
why
To help with debugging VCS issues in the future.
Example Logs
GitHub
{"level":"debug","ts":"2023-10-19T20:17:16.087+0100","caller":"vcs/github_client.go:104","msg":"GH User: X-Guardian","json":{}} {"level":"debug","ts":"2023-10-19T20:17:42.631+0100","caller":"vcs/github_client.go:204","msg":"POST /repos/Guardian-Teck/atlantis-test/issues/comments/1771570849/reactions returned: 201","json":{}} {"level":"debug","ts":"2023-10-19T20:17:42.929+0100","caller":"vcs/github_client.go:554","msg":"GET /repos/Guardian-Teck/atlantis-test/pulls/6 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:17:43.186+0100","caller":"vcs/github_client.go:331","msg":"GET /repos/Guardian-Teck/atlantis-test/pulls/6/reviews returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:17:43.539+0100","caller":"vcs/github_client.go:554","msg":"GET /repos/Guardian-Teck/atlantis-test/pulls/6 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:17:43.846+0100","caller":"vcs/github_client.go:586","msg":"POST /repos/Guardian-Teck/atlantis-test/statuses/92ec829ba24d094f96a9c5bb038590abab3c3e98 returned: 201","json":{}} {"level":"debug","ts":"2023-10-19T20:17:44.246+0100","caller":"vcs/github_client.go:144","msg":"[attempt 1] GET /repos/Guardian-Teck/atlantis-test/pulls/6/files returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:17:44.754+0100","caller":"vcs/github_client.go:586","msg":"POST /repos/Guardian-Teck/atlantis-test/statuses/92ec829ba24d094f96a9c5bb038590abab3c3e98 returned: 201","json":{}} {"level":"debug","ts":"2023-10-19T20:17:47.096+0100","caller":"vcs/github_client.go:586","msg":"POST /repos/Guardian-Teck/atlantis-test/statuses/92ec829ba24d094f96a9c5bb038590abab3c3e98 returned: 201","json":{}} {"level":"debug","ts":"2023-10-19T20:17:47.525+0100","caller":"vcs/github_client.go:217","msg":"GET /repos/Guardian-Teck/atlantis-test/issues/6/comments returned: 200","json":{}}GitLab
{"level":"debug","ts":"2023-10-19T20:09:05.527+0100","caller":"vcs/gitlab_client.go:463","msg":"GET /version returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:18.177+0100","caller":"vcs/gitlab_client.go:193","msg":"POST /projects/sheather/test/merge_requests/15/notes/389/award_emoji returned: 201","json":{}} {"level":"debug","ts":"2023-10-19T20:09:19.410+0100","caller":"vcs/gitlab_client.go:393","msg":"GET /projects/sheather/test/merge_requests/15 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:20.229+0100","caller":"vcs/gitlab_client.go:393","msg":"GET /projects/sheather/test/merge_requests/15 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:20.449+0100","caller":"vcs/gitlab_client.go:387","msg":"POST /projects/sheather/test/statuses/2b55ac78b1c87c208bd87723293c752a2e619470 returned: 201","json":{}} {"level":"debug","ts":"2023-10-19T20:09:50.684+0100","caller":"vcs/gitlab_client.go:393","msg":"GET /projects/sheather/test/merge_requests/15 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:50.946+0100","caller":"vcs/gitlab_client.go:387","msg":"POST /projects/sheather/test/statuses/2b55ac78b1c87c208bd87723293c752a2e619470 returned: 201","json":{}} {"level":"debug","ts":"2023-10-19T20:09:51.326+0100","caller":"vcs/gitlab_client.go:261","msg":"GET /projects/sheather/test/merge_requests/15/approvals returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:52.173+0100","caller":"vcs/gitlab_client.go:286","msg":"GET /projects/sheather/test/merge_requests/15 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:52.311+0100","caller":"vcs/gitlab_client.go:302","msg":"GET /projects/2 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:52.480+0100","caller":"vcs/gitlab_client.go:309","msg":"GET /projects/2/commits/2b55ac78b1c87c208bd87723293c752a2e619470/statuses returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:52.557+0100","caller":"vcs/gitlab_client.go:463","msg":"GET /version returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:52.891+0100","caller":"vcs/gitlab_client.go:393","msg":"GET /projects/sheather/test/merge_requests/15 returned: 200","json":{}} {"level":"debug","ts":"2023-10-19T20:09:53.193+0100","caller":"vcs/gitlab_client.go:387","msg":"POST /projects/sheather/test/statuses/2b55ac78b1c87c208bd87723293c752a2e619470 returned: 201","json":{}}