syncstate

Documentation

Index

• Variables
• type Metrics
  • func MetricsProvider() Metrics
• type SyncState
  • func (ss SyncState) Complete() bool
  • func (ss SyncState) WaitForResource() func(context.Context)

Variables

var Cell = cell.Module(
	"sync",
	"ClusterMesh Sync",

	metrics.Metric(MetricsProvider),
	cell.Provide(new),
)

Types

type Metrics

type Metrics struct {
	// BootstrapDuration tracks the duration in seconds until ready to serve requests.
	BootstrapDuration metric.Vec[metric.Gauge]
}

Metrics contains metrics that should only be exported by the clustermesh-apiserver or kvstoremesh.

func MetricsProvider

func MetricsProvider() Metrics

type SyncState

type SyncState struct {
	*lock.StoppableWaitGroup
}

SyncState is a wrapper around lock.StoppableWaitGroup used to keep track of the synchronization of various resources to the kvstore.

func (SyncState) Complete

func (ss SyncState) Complete() bool

Complete returns true if all resources have been synchronized to the kvstore.

func (SyncState) WaitForResource

func (ss SyncState) WaitForResource() func(context.Context)

WaitForResource adds a resource to the SyncState and returns a callback function that should be called when the resource has been synchronized.