types

Jul 30, 2026

Changes in this version

+ type AdaptiveWriteMetrics interface

+ IncWriteDegraded func(cluster ClusterID)

+ IncWriteRecovered func(cluster ClusterID)

+ SetWriteDegraded func(cluster ClusterID, degraded bool)

+ type ClusterEvent struct

+ Cluster ClusterID

+ Count int

+ Err error

+ FromCluster ClusterID

+ Kind ClusterEventKind

+ Reason string

+ Timestamp time.Time

+ ToCluster ClusterID

+ type ClusterEventEmitter interface

+ EmitClusterEvent func(event ClusterEvent)

+ type ClusterEventKind string

+ const EventCircuitBreakerClosed

+ const EventCircuitBreakerOpen

+ const EventDrainEntered

+ const EventDrainExited

+ const EventFailover

+ const EventMirrorReplayDropped

+ const EventReadDivergence

+ const EventReplayDropped

+ const EventSessionRefreshAttempt

+ const EventSessionRefreshError

+ const EventSessionRefreshSuccess

+ const EventWriteDegraded

+ const EventWriteRecovered

+ type ClusterEventMetrics interface

+ AddClusterEventsDropped func(n int)

+ type MirrorReplayMetrics interface

+ IncMirrorReplayDropped func()

May 11, 2026

Changes in this version

+ var ErrRowLimitExceeded = errors.New("helix: row limit exceeded")

+ func IsRowLimitExceeded(err error) bool

May 9, 2026

Changes in this version

+ var ErrClusterDegraded = errors.New("helix: cluster is degraded; strict write skipped")

+ var ErrClusterDraining = errors.New("helix: cluster is draining; strict write skipped")

+ var ErrMirrorModeConflict = errors.New("helix: WithMirror and WithMirrorPublisher are mutually exclusive")

+ var ErrNilMirrorPublisher = errors.New("helix: mirror publisher cannot be nil")

+ var ErrNilMirrorTarget = errors.New("helix: mirror target cannot be nil")

+ var ErrStrictMirrorUnsupported = errors.New("helix: Strict() and Mirror() cannot be combined")

+ var ErrStrictUnsupported = errors.New("helix: configured WriteStrategy does not support Strict() writes")

+ func IsOptionError(err error) bool

+ func IsPartialWrite(err error) bool

+ type MirrorMetrics interface

+ IncMirrorEnqueueDropped func()

+ IncMirrorEnqueueSuccess func()

+ IncMirrorExecError func()

+ IncMirrorExecSuccess func()

+ ObserveMirrorExecDuration func(seconds float64)

+ SetMirrorEnabled func(enabled bool)

+ SetMirrorQueueDepth func(depth int)

+ type OptionError struct

+ Component string

+ Option string

+ Reason string

+ func AsOptionError(err error) (*OptionError, bool)

+ func (e *OptionError) Error() string

type PartialWriteError

+ Acknowledged ClusterID

+ Unacknowledged ClusterID

+ func AsPartialWriteError(err error) (*PartialWriteError, bool)

+ type RecoveryProbeMetrics interface

+ IncRecoveryProbeFailure func(cluster ClusterID)

+ IncRecoveryProbeSuccess func(cluster ClusterID)

+ type StrictMetrics interface

+ IncWriteSkipped func(cluster ClusterID)

May 7, 2026

Changes in this version

+ var ErrInvalidCluster = errors.New("helix: invalid cluster for this client")

+ var ErrNoSessionRefresher = errors.New("helix: no session refresher configured")

+ type SessionRefreshMetrics interface

+ IncSessionRefreshAttempt func(cluster ClusterID)

+ IncSessionRefreshError func(cluster ClusterID)

+ IncSessionRefreshSuccess func(cluster ClusterID)

Apr 15, 2026

Changes in this version

+ var ErrClusterOverridePanic = errors.New("helix: cluster override function panicked")

+ var ErrInvalidClusterOverride = errors.New("helix: invalid cluster override — no recognized clusters in returned list")

+ var ErrNoValidClusters = errors.New("helix: no valid clusters for read — override and drain state conflict")

Apr 12, 2026

Changes in this version

+ var ErrNotFound = errors.New("helix: not found")

+ func IsNotFound(err error) bool

type MetricsCollector

+ IncReadDivergence func(cluster ClusterID)

Apr 9, 2026

Changes in this version

type MetricsCollector

+ IncWriteAsync func(cluster ClusterID)

+ IncWriteDropped func(cluster ClusterID)

Dec 7, 2025

Changes in this version

+ var ErrBothClustersDraining = errors.New("helix: both clusters are draining")

+ var ErrBothClustersFailed = errors.New("helix: write failed on both clusters")

+ var ErrInvalidBatchType = errors.New("helix: invalid batch type")

+ var ErrNilSession = errors.New("helix: session cannot be nil")

+ var ErrNoAvailableCluster = errors.New("helix: no cluster available for read")

+ var ErrReplayQueueFull = errors.New("helix: replay queue is full")

+ var ErrSessionClosed = errors.New("helix: session is closed")

+ var ErrWriteAsync = errors.New("helix: write sent asynchronously to degraded cluster")

+ var ErrWriteDropped = errors.New("helix: write dropped due to fire-and-forget concurrency limit")

+ type BatchStatement struct

+ Args []any

+ Query string

+ type BatchType byte

+ const CounterBatch

+ const LoggedBatch

+ const UnloggedBatch

+ type ClusterError struct

+ Cause error

+ Cluster string

+ Operation string

+ func (e *ClusterError) Error() string

+ func (e *ClusterError) Unwrap() error

+ type ClusterID string

+ const ClusterA

+ const ClusterB

+ func (c ClusterID) String() string

+ type ClusterNamer interface

+ SetClusterNames func(names ClusterNames)

+ type ClusterNames struct

+ A string

+ B string

+ func DefaultClusterNames() ClusterNames

+ func (n ClusterNames) Name(cluster ClusterID) string

+ func (n ClusterNames) Validate() error

+ type Consistency uint16

+ const All

+ const Any

+ const EachQuorum

+ const LocalOne

+ const LocalQuorum

+ const LocalSerial

+ const One

+ const Quorum

+ const Serial

+ const Three

+ const Two

+ type DualClusterError struct

+ ErrorA error

+ ErrorB error

+ func (e *DualClusterError) Error() string

+ func (e *DualClusterError) Unwrap() []error

+ type Logger interface

+ Debug func(msg string, keysAndValues ...any)

+ Error func(msg string, keysAndValues ...any)

+ Fatal func(msg string, keysAndValues ...any)

+ Info func(msg string, keysAndValues ...any)

+ Warn func(msg string, keysAndValues ...any)

+ type MetricsCollector interface

+ IncCircuitBreakerTrip func(cluster ClusterID)

+ IncDrainModeEntered func(cluster ClusterID)

+ IncDrainModeExited func(cluster ClusterID)

+ IncFailoverTotal func(fromCluster, toCluster ClusterID)

+ IncReadError func(cluster ClusterID)

+ IncReadTotal func(cluster ClusterID)

+ IncReplayDropped func(cluster ClusterID)

+ IncReplayEnqueued func(cluster ClusterID)

+ IncReplayError func(cluster ClusterID)

+ IncReplaySuccess func(cluster ClusterID)

+ IncWriteError func(cluster ClusterID)

+ IncWriteTotal func(cluster ClusterID)

+ ObserveReadDuration func(cluster ClusterID, seconds float64)

+ ObserveReplayDuration func(cluster ClusterID, seconds float64)

+ ObserveWriteDuration func(cluster ClusterID, seconds float64)

+ SetCircuitBreakerState func(cluster ClusterID, state int)

+ SetClusterDraining func(cluster ClusterID, draining bool)

+ SetReplayQueueDepth func(cluster ClusterID, depth int)

+ type PartialWriteError struct

+ Cause error

+ FailedCluster string

+ SucceededCluster string

+ func (e *PartialWriteError) Error() string

+ func (e *PartialWriteError) Unwrap() error

+ type PriorityLevel int

+ const PriorityHigh

+ const PriorityLow

+ type ReplayPayload struct

+ Args []any

+ BatchStatements []BatchStatement

+ BatchType BatchType

+ IsBatch bool

+ Priority PriorityLevel

+ Query string

+ TargetCluster ClusterID

+ Timestamp int64