Add actionset and phase name to controller logs #287
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
tdmanv
reviewed
Sep 13, 2019
pkg/controller/controller.go
Outdated
| @@ -268,23 +269,25 @@ func (c *Controller) onDeleteBlueprint(bp *crv1alpha1.Blueprint) error { | |||
|
|
|||
| func (c *Controller) initActionSetStatus(as *crv1alpha1.ActionSet) { | |||
| if as.Spec == nil { | |||
| log.Error("Cannot initialize an ActionSet without a spec.") | |||
| log.Error("Cannot initialize an ActionSet %s without a spec.", as.GetName()) | |||
There was a problem hiding this comment.
- Let's not use formatting - we could create the context earlier in the function and add the name there.
- If you had wanted to use formatting, you would need to use
Errof
tdmanv
reviewed
Sep 13, 2019
| func (c *Controller) logAndSuccessEvent(msg, reason string, objects ...runtime.Object) { | ||
| log.Info(msg) | ||
| func (c *Controller) logAndSuccessEvent(ctx context.Context, msg, reason string, objects ...runtime.Object) { | ||
| log.WithContext(ctx).Info(msg) |
There was a problem hiding this comment.
what happens when context is nil?
There was a problem hiding this comment.
func (entry *Entry) WithContext(ctx context.Context) *Entry {
return &Entry{Logger: entry.Logger, Data: entry.Data, Time: entry.Time, err: entry.err, Context: ctx}
}
The Entry.Context will be assigned nil
tdmanv
approved these changes
Sep 13, 2019
julio-lopez
reviewed
Sep 17, 2019
| @@ -4,6 +4,13 @@ import "context" | |||
|
|
|||
| // context.Context support for fields | |||
|
|
|||
| const ( | |||
| ActionsetNameKey = "ActionSet" | |||
There was a problem hiding this comment.
Not sure we discussed this in slack. These constants should be defined outside the field package. Both the interface and the implementation for field and the replacement log and errors packages should not contain kanister specific references or dependencies.
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.
Change Overview
To make the controller logs more descriptive, adding actionset name and phase name to the log context.
Pull request type
Please check the type of change your PR introduces:
Will be testing logs with a small timelog app and will update this section soon.