package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Packages

# Functions

AddressResolver is a thin wrapper around gossip's GetNodeIDAddress that allows it to be used as a nodedialer.AddressResolver.
DecodeNodeDescKey attempts to extract a NodeID from the provided key after stripping the provided prefix.
DecodeStoreDescKey attempts to extract a StoreID from the provided key after stripping the provided prefix.
IsNodeDescKey returns true iff the provided key is a valid node ID key.
MakeDistSQLDrainingKey returns the gossip key for the given node's distsql draining state.
MakeKey creates a canonical key under which to gossip a piece of information.
MakeNodeHealthAlertKey returns the gossip key under which the given node can gossip health alerts.
MakeNodeIDKey returns the gossip key for node ID info.
MakeNodeLivenessKey returns the gossip key for node liveness info.
MakeOptionalGossip initializes an OptionalGossip instance wrapping a (possibly nil) *Gossip.
MakePrefixPattern returns a regular expression pattern that matches precisely the Gossip keys created by invocations of MakeKey with multiple arguments for which the first argument is equal to the given prefix.
MakeStoreDescKey returns the gossip key for the given store.
MakeSystemConfigDeltaFilter creates a new SystemConfigDeltaFilter.
New creates an instance of a gossip node.
NewKeyNotPresentError creates a new KeyNotPresentError.
NewTest is a simplified wrapper around New that creates the ClusterIDContainer and NodeIDContainer internally.
NewTestWithLocality calls NewTest with an explicit locality value.

# Constants

KeyClusterID is the unique UUID for this Cockroach cluster.
KeyDeprecatedSystemConfig is the gossip key for the system DB span.
KeyDistSQLDrainingPrefix is the key prefix for each node's DistSQL draining state.
KeyFirstRangeDescriptor is the descriptor for the "first" range.
KeyNodeDescPrefix is the key prefix for gossiping node id addresses.
KeyHealthAlertPrefix is the key prefix for gossiping health alerts.
KeyNodeLivenessPrefix is the key prefix for gossiping node liveness info.
KeySentinel is a key for gossip which must not expire or else the node considers itself partitioned and will retry with bootstrap hosts.
KeyStoreDescPrefix is the key prefix for gossiping stores in the network.
NodeDescriptorInterval is the interval for gossiping the node descriptor.
NodeDescriptorTTL is time-to-live for node ID -> descriptor.
StoresInterval is the default interval for gossiping store descriptors.
StoreTTL is time-to-live for store-related info.

# Variables

Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Gossip metrics counter names.
Redundant is a callback option that specifies that the callback should be invoked even if the gossip value has not changed.

# Structs

Gossip is an instance of a gossip node.
InfoToAdd contains a single Gossip info to be added to the network.
KeyNotPresentError is returned by gossip when queried for a key that doesn't exist or has expired.
Metrics contains gossip metrics used per node and server.
OptionalGossip is a Gossip instance in a SQL tenant server.
SystemConfigDeltaFilter keeps track of SystemConfig values so that unmodified values can be filtered out from a SystemConfig update.

# Interfaces

CallbackOption is a marker interface that callback options must implement.
Storage is an interface which allows the gossip instance to read and write bootstrapping data to persistent storage between instantiations.

# Type aliases

Callback is a callback method to be invoked on gossip update of info denoted by key.