[STRMCMP-558] Event improvements #44
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
mwylde
requested review from
anandswaminathan,
glaksh100 and
kumare3
as code owners
glaksh100
reviewed
Jul 11, 2019
| fmt.Sprintf("Failed to create job managers: %v", err)) | ||
| f.LogEvent(ctx, application, corev1.EventTypeWarning, "CreateClusterFailed", | ||
| fmt.Sprintf("Failed to create job managers for deploy %s: %v", | ||
| HashForApplication(application), err)) |
There was a problem hiding this comment.
Nit: hash := HashForApplication(app), and use hash.
| return err | ||
| } | ||
|
|
||
| if newlyCreatedJm || newlyCreatedTm { | ||
| f.LogEvent(ctx, application, corev1.EventTypeNormal, "Flink cluster created") | ||
| f.LogEvent(ctx, application, corev1.EventTypeNormal, "CreatingCluster", |
There was a problem hiding this comment.
Nit, Move reason to constant variable ?
| @@ -388,7 +391,8 @@ func (f *Controller) DeleteOldResourcesForApp(ctx context.Context, app *v1alpha1 | |||
| } | |||
|
|
|||
| for k := range deletedHashes { | |||
| f.LogEvent(ctx, app, corev1.EventTypeNormal, fmt.Sprintf("Deleted old cluster with hash %s", k)) | |||
| f.LogEvent(ctx, app, corev1.EventTypeNormal, "ToreDownCluster", | |||
There was a problem hiding this comment.
Same. Nit, Move reason to constant variable ?
There was a problem hiding this comment.
I don't really see any reason to. It's only used here and is descriptive of this event.
There was a problem hiding this comment.
Nothing major. Just a nit, so that they can be reused later.
|
+1 |
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.
This PR makes two improvements to the events that the operator emits for FlinkApplication resources.
First, it ensures that all deploy-related events are unique to a particular deploy (generally by including the hash of the resource in the message). This ensures that if two deploys occur in rapid succession, the second one will still produce events (if more than 10 events with the same message are emitted within a 10 minute period, later events are dropped). This prevents a situation where a developer does a deploy, encounters an error that produces several events, tries the deploy again but this time doesn't seen any events because we have already exhausted our limit.
The second change is to fix the reason field of the events we emit. When I originally added events I misunderstood what the reason field was. Re-reading the docs, I now understand it to be basically a machine-readable code for the event, with the message as its human-readable counterpart:
Using unique reasons for each event also prevents distinct events from being improperly combined.