-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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.
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
feat(controller): Add liveness probe #5875
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
package controller | ||
|
||
import ( | ||
"fmt" | ||
"net/http" | ||
"time" | ||
|
||
log "github.com/sirupsen/logrus" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
|
||
"github.com/argoproj/argo-workflows/v3/util/env" | ||
"github.com/argoproj/argo-workflows/v3/workflow/common" | ||
) | ||
|
||
var ( | ||
age = env.LookupEnvDurationOr("HEALTHZ_AGE", 5*time.Minute) | ||
) | ||
|
||
// https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request | ||
// If we are in a state where there are any workflows that have not been reconciled in the last 2m, we've gone wrong. | ||
func (wfc *WorkflowController) Healthz(w http.ResponseWriter, r *http.Request) { | ||
ctx := r.Context() | ||
instanceID := wfc.Config.InstanceID | ||
instanceIDSelector := func() string { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @whynowy added instance ID, I had to make this a receiver func on |
||
if instanceID != "" { | ||
return common.LabelKeyControllerInstanceID + "=" + instanceID | ||
} | ||
return "!" + common.LabelKeyControllerInstanceID | ||
}() | ||
labelSelector := "!" + common.LabelKeyPhase + "," + instanceIDSelector | ||
err := func() error { | ||
// avoid problems with informers, but directly querying the API | ||
list, err := wfc.wfclientset.ArgoprojV1alpha1().Workflows(wfc.managedNamespace).List(ctx, metav1.ListOptions{LabelSelector: labelSelector}) | ||
if err != nil { | ||
return err | ||
} | ||
for _, wf := range list.Items { | ||
if time.Since(wf.GetCreationTimestamp().Time) > age { | ||
return fmt.Errorf("workflow never reconciled: %s", wf.Name) | ||
} | ||
} | ||
return nil | ||
}() | ||
log.WithField("err", err). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I now log diagnostics time it is requested, this will help deal with problems. |
||
WithField("managedNamespace", wfc.managedNamespace). | ||
WithField("instanceID", instanceID). | ||
WithField("labelSelector", labelSelector). | ||
WithField("age", age). | ||
Info("healthz") | ||
if err != nil { | ||
w.WriteHeader(500) | ||
_, _ = w.Write([]byte(err.Error())) | ||
} else { | ||
w.WriteHeader(200) | ||
_, _ = w.Write([]byte("ok")) | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this port also exposes pprof endpoints, but these are already accessible