docs(health): explain why ctx is not used

metal-stack · Jul 26, 2024 · c073d9d · c073d9d
1 parent 4856de9
commit c073d9d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/healthstatus/async-check.go b/healthstatus/async-check.go
@@ -40,6 +40,8 @@ func (c *AsyncHealthCheck) ServiceName() string {
 func (c *AsyncHealthCheck) Check(context.Context) (HealthResult, error) {
 	c.log.Debug("checked async")
 	if c.ticker == nil {
+		// The context coming in is bound to a single request
+		// but the ticker should be started in background
 		c.Start(context.Background()) //nolint:contextcheck
 	}
 	return c.current.Status, c.current.Err