Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore reconcile errors that occur because a pod is being terminated #1233

Merged
merged 14 commits into from
Dec 1, 2022
Merged

Ignore reconcile errors that occur because a pod is being terminated #1233

Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
aa9ab2d
Ignore reconcile errors that occur because a pod is being terminated
kevinearls Nov 8, 2022
77fc4a9
Appease the all powerfull linter
kevinearls Nov 8, 2022
0896ae9
Change behavior to end reconcile loop if pod has been terminated
kevinearls Nov 14, 2022
7b0267e
Print a log message if we exit the reconciler loop
kevinearls Nov 14, 2022
189dcd6
Merge branch 'main' into ignore-being-terminated-errors
kevinearls Nov 15, 2022
c43dd28
Merge branch 'main' into ignore-being-terminated-errors
frzifus Nov 15, 2022
ff5b12c
Merge branch 'main' into ignore-being-terminated-errors
kevinearls Nov 22, 2022
0af9e90
Look for NamespaceTerminatingCause
kevinearls Nov 22, 2022
cd7d18e
Appease the almighty linter
kevinearls Nov 22, 2022
cd56efd
Merge branch 'main' into ignore-being-terminated-errors
kevinearls Nov 30, 2022
81c2657
Merge branch 'main' into ignore-being-terminated-errors
kevinearls Nov 30, 2022
e9743b6
Fix log message
kevinearls Nov 30, 2022
1213f7b
Skip flaky test
kevinearls Nov 30, 2022
63f0ecf
Merge branch 'main' into ignore-being-terminated-errors
kevinearls Nov 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions controllers/opentelemetrycollector_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package controllers
import (
"context"
"fmt"
"strings"

"github.com/go-logr/logr"
appsv1 "k8s.io/api/apps/v1"
Expand Down Expand Up @@ -168,6 +169,11 @@ func (r *OpenTelemetryCollectorReconciler) Reconcile(ctx context.Context, req ct
func (r *OpenTelemetryCollectorReconciler) RunTasks(ctx context.Context, params reconcile.Params) error {
for _, task := range r.tasks {
if err := task.Do(ctx, params); err != nil {
// If we get an error that occur because a pod is being terminated then exit this loop
if apierrors.IsForbidden(err) && strings.Contains(err.Error(), "because it is being terminated") {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one last thing, should we print the termination logline before? And maybe an extra hint, that we cancel the reconciliation?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@frzifus what log level should I print that at?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i thought maybe:

r.log.Error(err, fmt.Sprintf("failed to reconcile %s", task.Name))

And maybe an additional line that says that the reconciliation will be canceled?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a bit skeptical about checking the string because it is being terminated". This could easily change in the future

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might be able to check for v1.NamespaceTerminatingCause in the error: https://github.com/kubernetes/apiserver/blob/v0.26.0-rc.0/pkg/admission/plugin/namespace/lifecycle/admission.go#L177

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@damemi Thanks!

r.log.V(2).Info("Exiting reconcile loop because namespace", params.Instance.Namespace, "is being terminated")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
r.log.V(2).Info("Exiting reconcile loop because namespace", params.Instance.Namespace, "is being terminated")
r.log.V(2).Info("Exiting reconcile loop because namespace is being terminated", "namespace", params.Instance.Namespace)

(see https://pkg.go.dev/github.com/go-logr/logr#Logger.Info)

return nil
}
r.log.Error(err, fmt.Sprintf("failed to reconcile %s", task.Name))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How often does this logline occur when a pod is terminated?

Copy link
Member Author

@kevinearls kevinearls Nov 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many. :-). Like for everything the reconciler touches. To be honest, it's not that big a deal, and probably something that will only be seen when running kuttl tests. But I found it very annoying, so I submitted the PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to end the reconciling with by returing nil if the reason is a terminating pod? That way the user gets informed that something did not work and we would get rid of all the unnecessary log lines?

if task.BailOnError {
return err
Expand Down