ring

Nov 10, 2025

Changes in this version

+ func AutoForgetFromRing(ringDesc *Desc, forgetPeriod time.Duration, logger log.Logger)

type CompareResult

+ const EqualButReadOnly

+ type DefaultLifecyclerDelegate struct

+ func (d DefaultLifecyclerDelegate) OnRingInstanceHeartbeat(lifecycler *Lifecycler, ringDesc *Desc)

type Lifecycler

+ func NewLifecyclerWithDelegate(cfg LifecyclerConfig, flushTransferer FlushTransferer, ...) (*Lifecycler, error)

+ type LifecyclerAutoForgetDelegate struct

+ func NewLifecyclerAutoForgetDelegate(forgetPeriod time.Duration, next LifecyclerDelegate, logger log.Logger) *LifecyclerAutoForgetDelegate

+ func (d *LifecyclerAutoForgetDelegate) OnRingInstanceHeartbeat(lifecycler *Lifecycler, ringDesc *Desc)

+ type LifecyclerDelegate interface

+ OnRingInstanceHeartbeat func(lifecycler *Lifecycler, ringDesc *Desc)

+ type RingMock struct

+ func (r *RingMock) CleanupShuffleShardCache(identifier string)

+ func (r *RingMock) Collect(ch chan<- prometheus.Metric)

+ func (r *RingMock) Describe(ch chan<- *prometheus.Desc)

+ func (r *RingMock) Get(key uint32, op Operation, bufDescs []InstanceDesc, bufHosts []string, ...) (ReplicationSet, error)

+ func (r *RingMock) GetAllHealthy(op Operation) (ReplicationSet, error)

+ func (r *RingMock) GetAllInstanceDescs(op Operation) ([]InstanceDesc, []InstanceDesc, error)

+ func (r *RingMock) GetInstanceDescsForOperation(op Operation) (map[string]InstanceDesc, error)

+ func (r *RingMock) GetInstanceIdByAddr(addr string) (string, error)

+ func (r *RingMock) GetInstanceState(instanceID string) (InstanceState, error)

+ func (r *RingMock) GetReplicationSetForOperation(op Operation) (ReplicationSet, error)

+ func (r *RingMock) HasInstance(instanceID string) bool

+ func (r *RingMock) InstancesCount() int

+ func (r *RingMock) ReplicationFactor() int

+ func (r *RingMock) ShuffleShard(identifier string, size int) ReadRing

+ func (r *RingMock) ShuffleShardWithLookback(identifier string, size int, lookbackPeriod time.Duration, now time.Time) ReadRing

+ func (r *RingMock) ShuffleShardWithZoneStability(identifier string, size int) ReadRing

Feb 27, 2025

Changes in this version

type InstanceState

+ const READONLY

+ func (p *InstanceState) UnmarshalJSON(data []byte) error

+ func (p InstanceState) MarshalJSON() ([]byte, error)

+ type TokenFile struct

+ PreviousState InstanceState

+ Tokens Tokens

+ func LoadTokenFile(tokenFilePath string) (*TokenFile, error)

+ func (l TokenFile) StoreToFile(tokenFilePath string) error

Sep 3, 2024

Changes in this version

type Config

+ DetailedMetricsEnabled bool

type Lifecycler

+ func (i *Lifecycler) RenewTokens(ratio float64, ctx context.Context)

+ func (i *Lifecycler) Zones() []string

type ReadRing

+ GetInstanceIdByAddr func(addr string) (string, error)

type Ring

+ func (r *Ring) GetInstanceIdByAddr(addr string) (string, error)

Apr 30, 2024

Changes in this version

type BasicLifecyclerConfig

+ TokensGeneratorStrategy string

type LifecyclerConfig

+ TokensGeneratorStrategy string

+ func (cfg *LifecyclerConfig) Validate() error

+ type MinimizeSpreadTokenGenerator struct

+ func (g *MinimizeSpreadTokenGenerator) GenerateTokens(ring *Desc, id, zone string, numTokens int, force bool) []uint32

+ type RandomTokenGenerator struct

+ func (g *RandomTokenGenerator) GenerateTokens(ring *Desc, _, _ string, numTokens int, _ bool) []uint32

type ReadRing

+ GetAllInstanceDescs func(op Operation) ([]InstanceDesc, []InstanceDesc, error)

type Ring

+ func (r *Ring) GetAllInstanceDescs(op Operation) ([]InstanceDesc, []InstanceDesc, error)

+ type TokenGenerator interface

+ GenerateTokens func(ring *Desc, id, zone string, numTokens int, force bool) []uint32

+ func NewMinimizeSpreadTokenGenerator() TokenGenerator

+ func NewRandomTokenGenerator() TokenGenerator

Nov 19, 2023

Changes in this version

+ const GetZoneSize

+ func HasInstanceDescsChanged(beforeByID, afterByID map[string]InstanceDesc, ...) bool

+ func HasTokensChanged(before, after InstanceDesc) bool

+ func HasZoneChanged(before, after InstanceDesc) bool

type BasicLifecyclerConfig

+ FinalSleep time.Duration

type ReadRing

+ GetInstanceDescsForOperation func(op Operation) (map[string]InstanceDesc, error)

+ ShuffleShardWithZoneStability func(identifier string, size int) ReadRing

type ReplicationSet

+ func (r ReplicationSet) GetNumOfZones() int

type Ring

+ func (r *Ring) GetInstanceDescsForOperation(op Operation) (map[string]InstanceDesc, error)

+ func (r *Ring) ShuffleShardWithZoneStability(identifier string, size int) ReadRing

Apr 19, 2023

Changes in this version

type Desc

+ func (d *Desc) FindDifference(o codec.MultiKey) (interface{}, []string, error)

+ func (d *Desc) GetItemFactory() proto.Message

+ func (d *Desc) JoinIds(in map[string]interface{})

+ func (d *Desc) SplitByID() map[string]interface{}

Dec 2, 2022 GO-2022-1175

  GO-2022-1175: Exposure of local files in github.com/cortexproject/cortex

Changes in this version

type Lifecycler

+ func (i *Lifecycler) Join()

Oct 4, 2022 GO-2022-1175

  GO-2022-1175: Exposure of local files in github.com/cortexproject/cortex

Jul 15, 2022 GO-2022-1175

  GO-2022-1175: Exposure of local files in github.com/cortexproject/cortex

Changes in this version

+ func HasReplicationSetChangedWithoutState(before, after ReplicationSet) bool

+ func WaitRingTokensStability(ctx context.Context, r *Ring, op Operation, ...) error

type BasicLifecyclerConfig

+ KeepInstanceInTheRingOnShutdown bool

type Config

+ ExcludedZones flagext.StringSliceCSV

type Desc

+ func (d *Desc) IsReady(now time.Time, heartbeatTimeout time.Duration) error

type InstanceDesc

+ func (i *InstanceDesc) IsReady(now time.Time, heartbeatTimeout time.Duration) error

type LifecyclerConfig

+ ReadinessCheckRingHealth bool

+ type LifecyclerMetrics struct

+ func NewLifecyclerMetrics(ringName string, reg prometheus.Registerer) *LifecyclerMetrics

Nov 25, 2021

Changes in this version

type Desc

+ func (d *Desc) Clone() memberlist.Mergeable

type InstanceDesc

+ func (i *InstanceDesc) IsHeartbeatHealthy(heartbeatTimeout time.Duration, now time.Time) bool

type ReadRing

+ GetInstanceState func(instanceID string) (InstanceState, error)

May 14, 2021

Changes in this version

+ var InstanceState_name = map[int32]string

+ var InstanceState_value = map[string]int32

+ type InstanceState int32

+ func (InstanceState) EnumDescriptor() ([]byte, []int)

+ func (x InstanceState) String() string

type ReplicationSet

+ Instances []InstanceDesc

+ func (r ReplicationSet) GetAddressesWithout(exclude string) []string

Mar 25, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ var ErrTooManyUnhealthyInstances = errors.New("too many unhealthy instances in the ring")

+ type InstanceDesc struct

+ Addr string

+ RegisteredTimestamp int64

+ State IngesterState

+ Timestamp int64

+ Tokens []uint32

+ Zone string

+ func (*InstanceDesc) Descriptor() ([]byte, []int)

+ func (*InstanceDesc) ProtoMessage()

+ func (i *InstanceDesc) GetRegisteredAt() time.Time

+ func (i *InstanceDesc) IsHealthy(op Operation, heartbeatTimeout time.Duration, now time.Time) bool

+ func (m *InstanceDesc) GetAddr() string

+ func (m *InstanceDesc) GetRegisteredTimestamp() int64

+ func (m *InstanceDesc) GetState() IngesterState

+ func (m *InstanceDesc) GetTimestamp() int64

+ func (m *InstanceDesc) GetTokens() []uint32

+ func (m *InstanceDesc) GetZone() string

+ func (m *InstanceDesc) Marshal() (dAtA []byte, err error)

+ func (m *InstanceDesc) MarshalTo(dAtA []byte) (int, error)

+ func (m *InstanceDesc) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *InstanceDesc) Reset()

+ func (m *InstanceDesc) Size() (n int)

+ func (m *InstanceDesc) Unmarshal(dAtA []byte) error

+ func (m *InstanceDesc) XXX_DiscardUnknown()

+ func (m *InstanceDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *InstanceDesc) XXX_Merge(src proto.Message)

+ func (m *InstanceDesc) XXX_Size() int

+ func (m *InstanceDesc) XXX_Unmarshal(b []byte) error

+ func (this *InstanceDesc) Equal(that interface{}) bool

+ func (this *InstanceDesc) GoString() string

+ func (this *InstanceDesc) String() string

type ReadRing

+ CleanupShuffleShardCache func(identifier string)

+ InstancesCount func() int

type Ring

+ func (r *Ring) CleanupShuffleShardCache(identifier string)

+ func (r *Ring) InstancesCount() int

Mar 15, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Mar 8, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Apr 19, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Feb 23, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ const GetBufferSize

+ var ErrInconsistentTokensInfo = errors.New("inconsistent ring tokens information")

+ var WriteNoExtend = NewOp([]IngesterState{ ... }, nil)

+ func MergeTokens(instances [][]uint32) []uint32

+ func MergeTokensByZone(zones map[string][][]uint32) map[string][]uint32

type Config

+ SubringCacheDisabled bool

type IngesterDesc

+ func MakeBuffersForGet() (bufDescs []IngesterDesc, bufHosts, bufZones []string)

type Operation

+ func NewOp(healthyStates []IngesterState, ...) Operation

+ func (op Operation) IsInstanceInStateHealthy(s IngesterState) bool

+ func (op Operation) ShouldExtendReplicaSetOnState(s IngesterState) bool

type ReplicationStrategy

+ func NewIgnoreUnhealthyInstancesReplicationStrategy() ReplicationStrategy

+ type TokensHeap [][]uint32

+ func (h *TokensHeap) Pop() interface{}

+ func (h *TokensHeap) Push(x interface{})

+ func (h TokensHeap) Len() int

+ func (h TokensHeap) Less(i, j int) bool

+ func (h TokensHeap) Swap(i, j int)

Feb 19, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Feb 14, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Jan 21, 2021 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Dec 29, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ var ErrTooManyFailedIngesters = errors.New("too many failed ingesters")

+ func WaitRingStability(ctx context.Context, r *Ring, op Operation, ...) error

type Config

+ ExtendWrites bool

type Lifecycler

+ func (i *Lifecycler) SetUnregisterOnShutdown(enabled bool)

+ func (i *Lifecycler) ShouldUnregisterOnShutdown() bool

type LifecyclerConfig

+ UnregisterOnShutdown bool

type ReadRing

+ GetAllHealthy func(op Operation) (ReplicationSet, error)

+ GetReplicationSetForOperation func(op Operation) (ReplicationSet, error)

type ReplicationSet

+ MaxUnavailableZones int

type ReplicationStrategy

+ func NewDefaultReplicationStrategy(extendWrites bool) ReplicationStrategy

type Ring

+ func (r *Ring) GetAllHealthy(op Operation) (ReplicationSet, error)

+ func (r *Ring) GetReplicationSetForOperation(op Operation) (ReplicationSet, error)

Dec 19, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Dec 9, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Nov 9, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ func HasReplicationSetChanged(before, after ReplicationSet) bool

type BasicLifecycler

+ func (l *BasicLifecycler) GetRegisteredAt() time.Time

+ type CompareResult int

+ const Different

+ const Equal

+ const EqualButStatesAndTimestamps

type Config

+ ZoneAwarenessEnabled bool

type Desc

+ func (d *Desc) RingCompare(o *Desc) CompareResult

type IngesterDesc

+ RegisteredTimestamp int64

+ func (i *IngesterDesc) GetRegisteredAt() time.Time

+ func (m *IngesterDesc) GetRegisteredTimestamp() int64

type Lifecycler

+ func (i *Lifecycler) ZonesCount() int

type Operation

+ const Compactor

+ const Ruler

type ReadRing

+ ShuffleShard func(identifier string, size int) ReadRing

+ ShuffleShardWithLookback func(identifier string, size int, lookbackPeriod time.Duration, now time.Time) ReadRing

type ReplicationSet

+ func (r ReplicationSet) GetAddresses() []string

type Ring

+ func (r *Ring) ShuffleShard(identifier string, size int) ReadRing

+ func (r *Ring) ShuffleShardWithLookback(identifier string, size int, lookbackPeriod time.Duration, now time.Time) ReadRing

Oct 29, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Nov 3, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Oct 29, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Oct 2, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

type ReadRing

+ HasInstance func(instanceID string) bool

type Ring

+ func (r *Ring) HasInstance(instanceID string) bool

Sep 22, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Sep 16, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Aug 21, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Aug 17, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Aug 10, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Aug 5, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Jul 1, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Jun 26, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Jun 24, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

May 21, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ var ErrInstanceNotFound = errors.New("instance not found in the ring")

+ func GetInstanceAddr(configAddr string, netInterfaces []string) (string, error)

+ func GetInstancePort(configPort, listenPort int) int

+ func WaitInstanceState(ctx context.Context, r *Ring, instanceID string, state IngesterState) error

+ type AutoForgetDelegate struct

+ func NewAutoForgetDelegate(forgetPeriod time.Duration, next BasicLifecyclerDelegate, logger log.Logger) *AutoForgetDelegate

+ func (d *AutoForgetDelegate) OnRingInstanceHeartbeat(lifecycler *BasicLifecycler, ringDesc *Desc, instanceDesc *IngesterDesc)

+ func (d *AutoForgetDelegate) OnRingInstanceRegister(lifecycler *BasicLifecycler, ringDesc Desc, instanceExists bool, ...) (IngesterState, Tokens)

+ func (d *AutoForgetDelegate) OnRingInstanceStopping(lifecycler *BasicLifecycler)

+ func (d *AutoForgetDelegate) OnRingInstanceTokens(lifecycler *BasicLifecycler, tokens Tokens)

+ type BasicLifecycler struct

+ func NewBasicLifecycler(cfg BasicLifecyclerConfig, ringName, ringKey string, store kv.Client, ...) (*BasicLifecycler, error)

+ func (l *BasicLifecycler) ChangeState(ctx context.Context, state IngesterState) error

+ func (l *BasicLifecycler) GetInstanceAddr() string

+ func (l *BasicLifecycler) GetInstanceID() string

+ func (l *BasicLifecycler) GetInstanceZone() string

+ func (l *BasicLifecycler) GetState() IngesterState

+ func (l *BasicLifecycler) GetTokens() Tokens

+ func (l *BasicLifecycler) IsRegistered() bool

+ type BasicLifecyclerConfig struct

+ Addr string

+ HeartbeatPeriod time.Duration

+ ID string

+ NumTokens int

+ TokensObservePeriod time.Duration

+ Zone string

+ type BasicLifecyclerDelegate interface

+ OnRingInstanceHeartbeat func(lifecycler *BasicLifecycler, ringDesc *Desc, instanceDesc *IngesterDesc)

+ OnRingInstanceRegister func(lifecycler *BasicLifecycler, ringDesc Desc, instanceExists bool, ...) (IngesterState, Tokens)

+ OnRingInstanceStopping func(lifecycler *BasicLifecycler)

+ OnRingInstanceTokens func(lifecycler *BasicLifecycler, tokens Tokens)

+ type BasicLifecyclerMetrics struct

+ func NewBasicLifecyclerMetrics(ringName string, reg prometheus.Registerer) *BasicLifecyclerMetrics

+ type ByAddr []IngesterDesc

+ func (ts ByAddr) Len() int

+ func (ts ByAddr) Less(i, j int) bool

+ func (ts ByAddr) Swap(i, j int)

+ type DefaultReplicationStrategy struct

+ func (s *DefaultReplicationStrategy) Filter(ingesters []IngesterDesc, op Operation, replicationFactor int, ...) ([]IngesterDesc, int, error)

+ func (s *DefaultReplicationStrategy) ShouldExtendReplicaSet(ingester IngesterDesc, op Operation) bool

type Desc

+ func GetOrCreateRingDesc(d interface{}) *Desc

+ type LeaveOnStoppingDelegate struct

+ func NewLeaveOnStoppingDelegate(next BasicLifecyclerDelegate, logger log.Logger) *LeaveOnStoppingDelegate

+ func (d *LeaveOnStoppingDelegate) OnRingInstanceHeartbeat(lifecycler *BasicLifecycler, ringDesc *Desc, instanceDesc *IngesterDesc)

+ func (d *LeaveOnStoppingDelegate) OnRingInstanceRegister(lifecycler *BasicLifecycler, ringDesc Desc, instanceExists bool, ...) (IngesterState, Tokens)

+ func (d *LeaveOnStoppingDelegate) OnRingInstanceStopping(lifecycler *BasicLifecycler)

+ func (d *LeaveOnStoppingDelegate) OnRingInstanceTokens(lifecycler *BasicLifecycler, tokens Tokens)

type Operation

+ const BlocksRead

+ const BlocksSync

type ReplicationSet

+ func (r ReplicationSet) Includes(addr string) bool

+ type ReplicationStrategy interface

+ Filter func(instances []IngesterDesc, op Operation, replicationFactor int, ...) (healthy []IngesterDesc, maxFailures int, err error)

+ ShouldExtendReplicaSet func(instance IngesterDesc, op Operation) bool

type Ring

+ func NewWithStoreClientAndStrategy(cfg Config, name, key string, store kv.Client, strategy ReplicationStrategy) (*Ring, error)

+ func (r *Ring) GetInstanceState(instanceID string) (IngesterState, error)

type Tokens

+ func (t Tokens) Equals(other Tokens) bool

+ type TokensPersistencyDelegate struct

+ func NewTokensPersistencyDelegate(path string, state IngesterState, next BasicLifecyclerDelegate, ...) *TokensPersistencyDelegate

+ func (d *TokensPersistencyDelegate) OnRingInstanceHeartbeat(lifecycler *BasicLifecycler, ringDesc *Desc, instanceDesc *IngesterDesc)

+ func (d *TokensPersistencyDelegate) OnRingInstanceRegister(lifecycler *BasicLifecycler, ringDesc Desc, instanceExists bool, ...) (IngesterState, Tokens)

+ func (d *TokensPersistencyDelegate) OnRingInstanceStopping(lifecycler *BasicLifecycler)

+ func (d *TokensPersistencyDelegate) OnRingInstanceTokens(lifecycler *BasicLifecycler, tokens Tokens)

May 13, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Apr 23, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Apr 2, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ const StoreGatewayRingKey

type IngesterDesc

+ Zone string

+ func (m *IngesterDesc) GetZone() string

type Lifecycler

+ Zone string

type LifecyclerConfig

+ Zone string

type TokenDesc

+ Zone string

Mar 31, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Mar 16, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ const CompactorRingKey

type Desc

+ func (m *Desc) MarshalToSizedBuffer(dAtA []byte) (int, error)

type IngesterDesc

+ func (m *IngesterDesc) MarshalToSizedBuffer(dAtA []byte) (int, error)

type ReadRing

+ Subring func(key uint32, n int) (ReadRing, error)

type Ring

+ func (r *Ring) Subring(key uint32, n int) (ReadRing, error)

Mar 9, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Feb 5, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Jan 28, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ const DistributorRingKey

+ const IngesterRingKey

+ const RulerRingKey

+ var ErrTransferDisabled = errors.New("transfers disabled")

type Lifecycler

+ RingKey string

+ func (i *Lifecycler) FlushOnShutdown() bool

+ func (i *Lifecycler) SetFlushOnShutdown(flushOnShutdown bool)

type LifecyclerConfig

+ TokensFilePath string

+ UnusedFlag2 bool

+ type NoopFlushTransferer struct

+ func NewNoopFlushTransferer() *NoopFlushTransferer

+ func (t *NoopFlushTransferer) Flush()

+ func (t *NoopFlushTransferer) StopIncomingRequests()

+ func (t *NoopFlushTransferer) TransferOut(ctx context.Context) error

+ type Tokens []uint32

+ func LoadTokensFromFile(tokenFilePath string) (Tokens, error)

+ func (t *Tokens) Unmarshal(b []byte) error

+ func (t Tokens) Len() int

+ func (t Tokens) Less(i, j int) bool

+ func (t Tokens) Marshal() ([]byte, error)

+ func (t Tokens) StoreToFile(tokenFilePath string) error

+ func (t Tokens) Swap(i, j int)

Jan 22, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Jan 15, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Jan 8, 2020 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Dec 2, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

type Desc

+ func (d *Desc) Merge(mergeable memberlist.Mergeable, localCAS bool) (memberlist.Mergeable, error)

+ func (d *Desc) MergeContent() []string

+ func (d *Desc) RemoveTombstones(limit time.Time)

type IngesterDesc

+ func (i *IngesterDesc) IsHealthy(op Operation, heartbeatTimeout time.Duration) bool

type IngesterState

+ const LEFT

type Lifecycler

+ func (i *Lifecycler) HealthyInstancesCount() int

+ func (i *Lifecycler) Start()

type LifecyclerConfig

+ ObservePeriod time.Duration

Nov 17, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Oct 11, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

type ReadRing

+ IngesterCount func() int

type Ring

+ func (r *Ring) IngesterCount() int

Oct 3, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Sep 5, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

type LifecyclerConfig

+ UnusedFlag bool

Aug 30, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Aug 7, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex

Changes in this version

+ const ConsulKey

+ var ErrEmptyRing = errors.New("empty ring")

+ var ErrIntOverflowRing = fmt.Errorf("proto: integer overflow")

+ var ErrInvalidLengthRing = fmt.Errorf("proto: negative length found during unmarshaling")

+ var IngesterState_name = map[int32]string

+ var IngesterState_value = map[string]int32

+ func DoBatch(ctx context.Context, r ReadRing, keys []uint32, ...) error

+ func GenerateTokens(numTokens int, takenTokens []uint32) []uint32

+ func GetCodec() codec.Codec

+ func ProtoDescFactory() proto.Message

+ type ByToken []TokenDesc

+ func (ts ByToken) Len() int

+ func (ts ByToken) Less(i, j int) bool

+ func (ts ByToken) Swap(i, j int)

+ type Config struct

+ HeartbeatTimeout time.Duration

+ KVStore kv.Config

+ ReplicationFactor int

+ func (cfg *Config) RegisterFlags(f *flag.FlagSet)

+ func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

+ type Desc struct

+ Ingesters map[string]IngesterDesc

+ Tokens []TokenDesc

+ func NewDesc() *Desc

+ func (*Desc) Descriptor() ([]byte, []int)

+ func (*Desc) ProtoMessage()

+ func (d *Desc) AddIngester(id, addr string, tokens []uint32, state IngesterState, normaliseTokens bool)

+ func (d *Desc) ClaimTokens(from, to string, normaliseTokens bool) []uint32

+ func (d *Desc) FindIngestersByState(state IngesterState) []IngesterDesc

+ func (d *Desc) Ready(heartbeatTimeout time.Duration) error

+ func (d *Desc) RemoveIngester(id string)

+ func (d *Desc) TokensFor(id string) (tokens, other []uint32)

+ func (m *Desc) GetIngesters() map[string]IngesterDesc

+ func (m *Desc) GetTokens() []TokenDesc

+ func (m *Desc) Marshal() (dAtA []byte, err error)

+ func (m *Desc) MarshalTo(dAtA []byte) (int, error)

+ func (m *Desc) Reset()

+ func (m *Desc) Size() (n int)

+ func (m *Desc) Unmarshal(dAtA []byte) error

+ func (m *Desc) XXX_DiscardUnknown()

+ func (m *Desc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *Desc) XXX_Merge(src proto.Message)

+ func (m *Desc) XXX_Size() int

+ func (m *Desc) XXX_Unmarshal(b []byte) error

+ func (this *Desc) Equal(that interface{}) bool

+ func (this *Desc) GoString() string

+ func (this *Desc) String() string

+ type FlushTransferer interface

+ Flush func()

+ StopIncomingRequests func()

+ TransferOut func(ctx context.Context) error

+ type IngesterDesc struct

+ Addr string

+ State IngesterState

+ Timestamp int64

+ Tokens []uint32

+ func (*IngesterDesc) Descriptor() ([]byte, []int)

+ func (*IngesterDesc) ProtoMessage()

+ func (m *IngesterDesc) GetAddr() string

+ func (m *IngesterDesc) GetState() IngesterState

+ func (m *IngesterDesc) GetTimestamp() int64

+ func (m *IngesterDesc) GetTokens() []uint32

+ func (m *IngesterDesc) Marshal() (dAtA []byte, err error)

+ func (m *IngesterDesc) MarshalTo(dAtA []byte) (int, error)

+ func (m *IngesterDesc) Reset()

+ func (m *IngesterDesc) Size() (n int)

+ func (m *IngesterDesc) Unmarshal(dAtA []byte) error

+ func (m *IngesterDesc) XXX_DiscardUnknown()

+ func (m *IngesterDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *IngesterDesc) XXX_Merge(src proto.Message)

+ func (m *IngesterDesc) XXX_Size() int

+ func (m *IngesterDesc) XXX_Unmarshal(b []byte) error

+ func (this *IngesterDesc) Equal(that interface{}) bool

+ func (this *IngesterDesc) GoString() string

+ func (this *IngesterDesc) String() string

+ type IngesterState int32

+ const ACTIVE

+ const JOINING

+ const LEAVING

+ const PENDING

+ func (IngesterState) EnumDescriptor() ([]byte, []int)

+ func (x IngesterState) String() string

+ type Lifecycler struct

+ Addr string

+ ID string

+ KVStore kv.Client

+ RingName string

+ func NewLifecycler(cfg LifecyclerConfig, flushTransferer FlushTransferer, name string) (*Lifecycler, error)

+ func (i *Lifecycler) ChangeState(ctx context.Context, state IngesterState) error

+ func (i *Lifecycler) CheckReady(ctx context.Context) error

+ func (i *Lifecycler) ClaimTokensFor(ctx context.Context, ingesterID string) error

+ func (i *Lifecycler) GetState() IngesterState

+ func (i *Lifecycler) Shutdown()

+ type LifecyclerConfig struct

+ Addr string

+ ClaimOnRollout bool

+ FinalSleep time.Duration

+ HeartbeatPeriod time.Duration

+ ID string

+ InfNames []string

+ JoinAfter time.Duration

+ ListenPort *int

+ MinReadyDuration time.Duration

+ NormaliseTokens bool

+ NumTokens int

+ Port int

+ RingConfig Config

+ SkipUnregister bool

+ func (cfg *LifecyclerConfig) RegisterFlags(f *flag.FlagSet)

+ func (cfg *LifecyclerConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

+ type Operation int

+ const Read

+ const Reporting

+ const Write

+ type ReadRing interface

+ BatchGet func(keys []uint32, op Operation) ([]ReplicationSet, error)

+ Get func(key uint32, op Operation) (ReplicationSet, error)

+ GetAll func() (ReplicationSet, error)

+ ReplicationFactor func() int

+ type ReplicationSet struct

+ Ingesters []IngesterDesc

+ MaxErrors int

+ func (r ReplicationSet) Do(ctx context.Context, delay time.Duration, ...) ([]interface{}, error)

+ type Ring struct

+ KVClient kv.Client

+ func New(cfg Config, name string) (*Ring, error)

+ func (r *Ring) BatchGet(keys []uint32, op Operation) ([]ReplicationSet, error)

+ func (r *Ring) Collect(ch chan<- prometheus.Metric)

+ func (r *Ring) Describe(ch chan<- *prometheus.Desc)

+ func (r *Ring) Get(key uint32, op Operation) (ReplicationSet, error)

+ func (r *Ring) GetAll() (ReplicationSet, error)

+ func (r *Ring) IsHealthy(ingester *IngesterDesc, op Operation) bool

+ func (r *Ring) ReplicationFactor() int

+ func (r *Ring) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (r *Ring) Stop()

+ type TokenDesc struct

+ Ingester string

+ Token uint32

+ func (*TokenDesc) Descriptor() ([]byte, []int)

+ func (*TokenDesc) ProtoMessage()

+ func (m *TokenDesc) GetIngester() string

+ func (m *TokenDesc) GetToken() uint32

+ func (m *TokenDesc) Marshal() (dAtA []byte, err error)

+ func (m *TokenDesc) MarshalTo(dAtA []byte) (int, error)

+ func (m *TokenDesc) Reset()

+ func (m *TokenDesc) Size() (n int)

+ func (m *TokenDesc) Unmarshal(dAtA []byte) error

+ func (m *TokenDesc) XXX_DiscardUnknown()

+ func (m *TokenDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *TokenDesc) XXX_Merge(src proto.Message)

+ func (m *TokenDesc) XXX_Size() int

+ func (m *TokenDesc) XXX_Unmarshal(b []byte) error

+ func (this *TokenDesc) Equal(that interface{}) bool

+ func (this *TokenDesc) GoString() string

+ func (this *TokenDesc) String() string

Aug 1, 2019 GO-2022-0915

  GO-2022-0915: Improper input validation in CNCF Cortex in github.com/cortexproject/cortex