Add a healthcheck endpoint on the ingesters that distributors can use #741
There are no files selected for viewing
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| io "io" | ||
| "sync" | ||
|
|
||
| "github.com/go-kit/kit/log/level" | ||
| "github.com/weaveworks/cortex/pkg/util" | ||
| ) | ||
|
|
||
| // Factory defines the signature for an ingester client factory | ||
| type Factory func(addr string, cfg Config) (IngesterClient, error) | ||
|
|
||
| // IngesterClientCache holds a cache of ingester clients | ||
| type IngesterClientCache struct { | ||
|
There was a problem hiding this comment. Is "cache" the right word? Elsewhere I've seen this called a "connection pool", except we have max one connection per endpoint. Maybe just some more explanation of the intended uses would help. There was a problem hiding this comment. I like IngesterPool, I will change it to that, and add some more explanations. |
||
| sync.RWMutex | ||
| clients map[string]IngesterClient | ||
|
|
||
| ingesterClientFactory Factory | ||
| ingesterClientConfig Config | ||
| } | ||
|
|
||
| // NewIngesterClientCache creates a new cache | ||
| func NewIngesterClientCache(factory Factory, config Config) *IngesterClientCache { | ||
| return &IngesterClientCache{ | ||
| clients: map[string]IngesterClient{}, | ||
| ingesterClientFactory: factory, | ||
| ingesterClientConfig: config, | ||
| } | ||
| } | ||
|
|
||
| // GetClientFor gets the client for the specified address. If it does not exist it will make a new client | ||
| // at that address | ||
| func (cache *IngesterClientCache) GetClientFor(addr string) (IngesterClient, error) { | ||
| cache.RLock() | ||
| client, ok := cache.clients[addr] | ||
| cache.RUnlock() | ||
| if ok { | ||
| return client, nil | ||
| } | ||
|
|
||
| cache.Lock() | ||
| defer cache.Unlock() | ||
| client, ok = cache.clients[addr] | ||
| if ok { | ||
| return client, nil | ||
| } | ||
|
|
||
| client, err := cache.ingesterClientFactory(addr, cache.ingesterClientConfig) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| cache.clients[addr] = client | ||
| return client, nil | ||
| } | ||
|
|
||
| // RemoveClientFor removes the client with the specified address | ||
| func (cache *IngesterClientCache) RemoveClientFor(addr string) { | ||
| cache.Lock() | ||
| defer cache.Unlock() | ||
| client, ok := cache.clients[addr] | ||
| if ok { | ||
| delete(cache.clients, addr) | ||
| // Close in the background since this operation may take awhile and we have a mutex | ||
| go func(addr string, closer io.Closer) { | ||
| if err := closer.Close(); err != nil { | ||
| level.Error(util.Logger).Log("msg", "error closing connection to ingester", "ingester", addr, "err", err) | ||
| } | ||
| }(addr, client.(io.Closer)) | ||
| } | ||
| } | ||
|
|
||
| // RegisteredAddresses returns all the addresses that a client is cached for | ||
| func (cache *IngesterClientCache) RegisteredAddresses() []string { | ||
| result := []string{} | ||
| cache.RLock() | ||
| defer cache.RUnlock() | ||
| for addr := range cache.clients { | ||
| result = append(result, addr) | ||
| } | ||
| return result | ||
| } | ||
|
|
||
| // Count returns how many clients are in the cache | ||
| func (cache *IngesterClientCache) Count() int { | ||
| cache.RLock() | ||
| defer cache.RUnlock() | ||
| return len(cache.clients) | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| fmt "fmt" | ||
| "testing" | ||
|
|
||
| "google.golang.org/grpc/health/grpc_health_v1" | ||
| ) | ||
|
|
||
| func (i mockIngester) Close() error { | ||
| return nil | ||
| } | ||
|
|
||
| func TestIngesterCache(t *testing.T) { | ||
| buildCount := 0 | ||
| factory := func(addr string, _ Config) (IngesterClient, error) { | ||
| if addr == "bad" { | ||
| return nil, fmt.Errorf("Fail") | ||
| } | ||
| buildCount++ | ||
| return mockIngester{happy: true, status: grpc_health_v1.HealthCheckResponse_SERVING}, nil | ||
| } | ||
| cache := NewIngesterClientCache(factory, Config{}) | ||
|
|
||
| cache.GetClientFor("1") | ||
| if buildCount != 1 { | ||
| t.Errorf("Did not create client") | ||
| } | ||
|
|
||
| cache.GetClientFor("1") | ||
| if buildCount != 1 { | ||
| t.Errorf("Created client that should have been cached") | ||
| } | ||
|
|
||
| cache.GetClientFor("2") | ||
| if cache.Count() != 2 { | ||
| t.Errorf("Expected Count() = 2, got %d", cache.Count()) | ||
| } | ||
|
|
||
| cache.RemoveClientFor("1") | ||
| if cache.Count() != 1 { | ||
| t.Errorf("Expected Count() = 1, got %d", cache.Count()) | ||
| } | ||
|
|
||
| cache.GetClientFor("1") | ||
| if buildCount != 3 || cache.Count() != 2 { | ||
| t.Errorf("Did not re-create client correctly") | ||
| } | ||
|
|
||
| _, err := cache.GetClientFor("bad") | ||
| if err == nil { | ||
| t.Errorf("Bad create should have thrown an error") | ||
| } | ||
| if cache.Count() != 2 { | ||
| t.Errorf("Bad create should not have been added to cache") | ||
| } | ||
|
|
||
| addrs := cache.RegisteredAddresses() | ||
| if len(addrs) != cache.Count() { | ||
| t.Errorf("Lengths of registered addresses and cache.Count() do not match") | ||
| } | ||
| } |
Oops, something went wrong.
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.
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.
can we say "during periodic cleanup" ? First off I thought "the cleanup period" was maybe a period during shutdown when we clean up.