feat: Enable config to log diff on objects when updating #583
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
Use the experimental features flag to enable additional logging when
updating objects on the cluster. If experimental features are enabled
and a spec object is found to be different from the cluster one, log a
diff between the two. This can potentially be useful for diagnosing
reconcile loops.
Due to json-structured logging, the formatted message is escaped into a
string, and so must be parsed for reading (e.g. by piping through sed:
make run 2>&1 | sed -e 's|\\n|\n|g; s|\\t| |g'
for quick checking, the .msg can be copy-pasted as the argument the
printf to interpret \t and \n
Signed-off-by: Angel Misevski <amisevsk@redhat.com>
sleshchenko
approved these changes
Sep 8, 2021
| @@ -55,6 +55,10 @@ func (r *DevWorkspaceRoutingReconciler) syncRoutes(routing *controllerv1alpha1.D | |||
| if contains, idx := listContainsRouteByName(specRoute, clusterRoutes); contains { | |||
| clusterRoute := clusterRoutes[idx] | |||
| if !cmp.Equal(specRoute, clusterRoute, routeDiffOpts) { | |||
| r.Log.Info("Updating route") | |||
There was a problem hiding this comment.
Route name is not in log context only workspace id and probably name/namespace.
So, maybe adding object name makes sense as well.
JPinkney
approved these changes
Sep 8, 2021
amisevsk
changed the title
Signed-off-by: Angel Misevski <amisevsk@redhat.com>
amisevsk
force-pushed
the
diff-context-on-update
branch
from
0eecdb5
to
a6c4e32
Compare
|
/test v8-devworkspace-operator-e2e, v8-che-happy-path |
sleshchenko
reviewed
Sep 9, 2021
| @@ -121,7 +121,7 @@ func SyncDeploymentToCluster( | |||
| } | |||
|
|
|||
| if clusterDeployment == nil { | |||
| clusterAPI.Logger.Info("Creating deployment...") | |||
| clusterAPI.Logger.Info("Creating deployment") | |||
There was a problem hiding this comment.
deployment name can be useful here as well, but since ATM we have only one and one deployment, that's OK
sleshchenko
approved these changes
Sep 9, 2021
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: amisevsk, JPinkney, sleshchenko The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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 does this PR do?
Use the experimental features flag to enable additional logging when updating objects on the cluster. If experimental features are enabled and a spec object is found to be different from the cluster one, log a
diff between the two.
What issues does this PR fix or reference?
Fixes #581
Is it tested? How?
Note that since the controller uses json-structured logging, newlines and tabs are escaped in log messages. An easy way to work around this is to pipe to
sed -e 's|\\n|\n|g; s|\\t| |g'-- though, note if usingmake runit's also necessary to pipe stderr to stdout, i.e.make run 2>&1 | sed -e 's|\\n|\n|g; s|\\t| |g'. Another option is to copy paste amsgand feed it toprintf.PR Checklist
/test v8-devworkspace-operator-e2e, v8-che-happy-pathto trigger)v8-devworkspace-operator-e2e: DevWorkspace e2e testv8-che-happy-path: Happy path for verification integration with Che