Allow passing logger into k8s controller | improve logs structure #35
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
taimoorgit
commented
Mar 10, 2024
| @@ -42,25 +44,27 @@ type K8SEvent struct { | |||
| } | |||
|
|
|||
| func (c *K8SController) mainloop(item interface{}) { | |||
| log.Debug().Str("queue_addr", fmt.Sprintf("%p", &c.queue)).Int("queue_len", c.queue.Len()).Msg("mainloop: running from top") | |||
There was a problem hiding this comment.
queue_addr is not really useful since it's ephemeral, I added this a while ago when I was debugging and learning about the repo.
taimoorgit
commented
Mar 10, 2024
| @@ -42,25 +44,27 @@ type K8SEvent struct { | |||
| } | |||
|
|
|||
| func (c *K8SController) mainloop(item interface{}) { | |||
| log.Debug().Str("queue_addr", fmt.Sprintf("%p", &c.queue)).Int("queue_len", c.queue.Len()).Msg("mainloop: running from top") | |||
| log := c.log.With().Str("where", "mainloop").Int("queue_len", c.queue.Len()).Logger() | |||
There was a problem hiding this comment.
Create a local logger here with info that's relevant to the scope of the function.
taimoorgit
commented
Mar 10, 2024
| return | ||
| } | ||
| event := item.(K8SEvent) | ||
| log = log.With().Str("k8s_event_key", event.Key).Str("k8s_event_type", string(event.Type)).Logger() |
There was a problem hiding this comment.
updates scope for the rest of the function here
taimoorgit
commented
Mar 10, 2024
| if !ready { | ||
| runtime.HandleError(fmt.Errorf("[%s] Timed out waiting for caches to sync", c.id)) | ||
| return | ||
| } | ||
| log.Info().Msgf("[%s] Informer is ready and synced", c.id) |
There was a problem hiding this comment.
not really info worthy, lowered this to debug.
taimoorgit
commented
Mar 10, 2024
| - golangci-lint run | ||
| - nilaway -test=false -include-pkgs='github.com/opslevel/opslevel-k8s-controller' ./... |
There was a problem hiding this comment.
I noticed nilaway was missing, so I added it in. no changes are required 👍
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.
Issues
https://github.com/OpsLevel/team-platform/issues/214
Changelog
logas a controller property that can be passed by dependents on instantiationchangieentryTophatting