consul: correctly interpret missing consul checks as unhealthy #15822
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
This PR fixes a bug where Nomad assumed any registered Checks would exist in the service registration coming back from Consul. In some cases, the Consul may be slow in processing the check registration, and the response object would not contain checks. Nomad would then scan the empty response looking for Checks with failing health status, finding none, and then marking a task/alloc as healthy. In reality, we must always use Nomad's view of what checks should exist as the source of truth, and compare that with the response Consul gives us, making sure they match, before scanning the Consul response for failing check statuses. Fixes #15536
shoenig
force-pushed
the
health-deployment
branch
from
50ec1f9
to
dcc19d4
Compare
shoenig
changed the title
shoenig
changed the title
lgfa29
approved these changes
Jan 19, 2023
client/allochealth/tracker.go
Outdated
Comment on lines
531
to
554
| expChecks := set.New[string](10) | ||
| expCount := 0 | ||
| regChecks := set.New[string](10) | ||
| regCount := 0 | ||
| for _, service := range services { | ||
| for _, check := range service.Checks { | ||
| expChecks.Insert(check.Name) | ||
| expCount++ | ||
| } | ||
| } | ||
| for _, task := range registrations.Tasks { | ||
| for _, service := range task.Services { | ||
| for _, check := range service.Checks { | ||
| regChecks.Insert(check.Name) | ||
| regCount++ | ||
| } | ||
| } | ||
| } | ||
| if expCount != regCount { | ||
| return false | ||
| } | ||
| if !expChecks.Equal(regChecks) { | ||
| return false | ||
| } |
There was a problem hiding this comment.
Minor nit-picking, but do we need a set and counter here? I think using a map[service name]: count would be enough and maybe easier to read?
gulducat
reviewed
Jan 19, 2023
| } | ||
| // scan for missing or unhealthy consul checks | ||
| if !evaluateConsulChecks(t.tg, allocReg) { | ||
| passed = false |
There was a problem hiding this comment.
Is it meaningful that t.setCheckHealth(false) is no longer called alongside this bool being set? I see that it is called elsewhere, but haven't chased down the potential implications of its removal here.
There was a problem hiding this comment.
Ah good catch, and I believe this is important in the edge case where
- checks become healthy
- tasks become healthy
- start minimum healthy time
- checks become unhealthy
- minimum healthy time ends <- we never updated check status to unhealthy, so we'll incorrectly report they are healthy
There was a problem hiding this comment.
Added this back in, and also added TestTracker_ConsulChecks_HealthToUnhealthy to cover the case where health checks transition from healthy to unhealthy during the minimum health period.
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.
This PR fixes a bug where Nomad assumed any registered Checks would exist
in the service registration coming back from Consul. In some cases, the
Consul may be slow in processing the check registration, and the response
object would not contain checks. Nomad would then scan the empty response
looking for Checks with failing health status, finding none, and then
marking a task/alloc as healthy.
In reality, we must always use Nomad's view of what checks should exist as
the source of truth, and compare that with the response Consul gives us,
making sure they match, before scanning the Consul response for failing
check statuses.
Fixes #15536