Skip to content

Commit

Permalink
doc(webserver/healthz): comment for URL query: verbose and exclude
Browse files Browse the repository at this point in the history
  • Loading branch information
searKing committed Jun 19, 2024
1 parent 2488ec4 commit 1594ba9
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions pkg/webserver/healthz/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ type Muxer interface {
}

// handleRootHealth returns an http.HandlerFunc that serves the provided checks.
//
// URL query:
//
// verbose responds with detailed check output.
// exclude=foo&exclude=bar&exclude=baz will bypass checking "foo", "bar" and "baz".
func handleRootHealth(name string, firstTimeHealthy func(), checks ...HealthChecker) http.HandlerFunc {
var notifyOnce sync.Once
return func(w http.ResponseWriter, r *http.Request) {
Expand Down

0 comments on commit 1594ba9

Please sign in to comment.