mirror of https://github.com/hashicorp/consul
40336fd353
The observed bug was that a full restart of a consul datacenter (servers
and clients) in conjunction with a restart of a connect-flavored
application with bring-your-own-service-registration logic would very
frequently cause the envoy sidecar service check to never reflect the
aliased service.
Over the course of investigation several bugs and unfortunate
interactions were corrected:
(1)
local.CheckState objects were only shallow copied, but the key piece of
data that gets read and updated is one of the things not copied (the
underlying Check with a Status field). When the stock code was run with
the race detector enabled this highly-relevant-to-the-test-scenario field
was found to be racy.
Changes:
a) update the existing Clone method to include the Check field
b) copy-on-write when those fields need to change rather than
incrementally updating them in place.
This made the observed behavior occur slightly less often.
(2)
If anything about how the runLocal method for node-local alias check
logic was ever flawed, there was no fallback option. Those checks are
purely edge-triggered and failure to properly notice a single edge
transition would leave the alias check incorrect until the next flap of
the aliased check.
The change was to introduce a fallback timer to act as a control loop to
double check the alias check matches the aliased check every minute
(borrowing the duration from the non-local alias check logic body).
This made the observed behavior eventually go away when it did occur.
(3)
Originally I thought there were two main actions involved in the data race:
A. The act of adding the original check (from disk recovery) and its
first health evaluation.
B. The act of the HTTP API requests coming in and resetting the local
state when re-registering the same services and checks.
It took awhile for me to realize that there's a third action at work:
C. The goroutines associated with the original check and the later
checks.
The actual sequence of actions that was causing the bad behavior was
that the API actions result in the original check to be removed and
re-added _without waiting for the original goroutine to terminate_. This
means for brief windows of time during check definition edits there are
two goroutines that can be sending updates for the alias check status.
In extremely unlikely scenarios the original goroutine sees the aliased
check start up in `critical` before being removed but does not get the
notification about the nearly immediate update of that check to
`passing`.
This is interlaced wit the new goroutine coming up, initializing its
base case to `passing` from the current state and then listening for new
notifications of edge triggers.
If the original goroutine "finishes" its update, it then commits one
more write into the local state of `critical` and exits leaving the
alias check no longer reflecting the underlying check.
The correction here is to enforce that the old goroutines must terminate
before spawning the new one for alias checks.
|
||
|---|---|---|
| .. | ||
| acl.go | ||
| acl_cache.go | ||
| acl_cache_test.go | ||
| acl_legacy.go | ||
| acl_legacy_test.go | ||
| acl_test.go | ||
| catalog.go | ||
| check_definition.go | ||
| check_definition_test.go | ||
| check_type.go | ||
| config_entry.go | ||
| config_entry_test.go | ||
| connect.go | ||
| connect_ca.go | ||
| connect_ca_test.go | ||
| connect_proxy_config.go | ||
| connect_proxy_config_test.go | ||
| connect_test.go | ||
| errors.go | ||
| intention.go | ||
| intention_test.go | ||
| operator.go | ||
| prepared_query.go | ||
| prepared_query_test.go | ||
| sanitize_oss.go | ||
| service_definition.go | ||
| service_definition_test.go | ||
| snapshot.go | ||
| structs.go | ||
| structs_filtering_test.go | ||
| structs_test.go | ||
| testing_catalog.go | ||
| testing_connect_proxy_config.go | ||
| testing_intention.go | ||
| testing_service_definition.go | ||
| txn.go | ||