Struct KVConfig

kv/memberlist/memberlist_client.go:141–213

KVConfig is a config for memberlist.KV

// KVConfig is a config for memberlist.KV
type KVConfig struct {
	// Memberlist options.
	NodeName                   string        `yaml:"node_name" category:"advanced"`
	RandomizeNodeName          bool          `yaml:"randomize_node_name" category:"advanced"`
	StreamTimeout              time.Duration `yaml:"stream_timeout" category:"advanced"`
	RetransmitMult             int           `yaml:"retransmit_factor" category:"advanced"`
	PushPullInterval           time.Duration `yaml:"pull_push_interval" category:"advanced"`
	GossipInterval             time.Duration `yaml:"gossip_interval" category:"advanced"`
	GossipNodes                int           `yaml:"gossip_nodes" category:"advanced"`
	GossipToTheDeadTime        time.Duration `yaml:"gossip_to_dead_nodes_time" category:"advanced"`
	DeadNodeReclaimTime        time.Duration `yaml:"dead_node_reclaim_time" category:"advanced"`
	EnableCompression          bool          `yaml:"compression_enabled" category:"advanced"`
	NotifyInterval             time.Duration `yaml:"notify_interval" category:"advanced"`
	ReceivedMessagesQueueSize  int           `yaml:"received_messages_queue_size" category:"advanced"`
	ProcessedMessagesQueueSize int           `yaml:"processed_messages_queue_size" category:"advanced"`

	CompressionAlgorithm string `yaml:"compression_algorithm" category:"advanced"`

	// ip:port to advertise other cluster members. Used for NAT traversal
	AdvertiseAddr string `yaml:"advertise_addr"`
	AdvertisePort int    `yaml:"advertise_port"`

	ClusterLabel                     string `yaml:"cluster_label" category:"advanced"`
	ClusterLabelVerificationDisabled bool   `yaml:"cluster_label_verification_disabled" category:"advanced"`

	// List of members to join
	JoinMembers                  flagext.StringSliceCSVMulti `yaml:"join_members"`
	MinJoinBackoff               time.Duration               `yaml:"min_join_backoff" category:"advanced"`
	MaxJoinBackoff               time.Duration               `yaml:"max_join_backoff" category:"advanced"`
	MaxJoinRetries               int                         `yaml:"max_join_retries" category:"advanced"`
	AbortIfFastJoinFails         bool                        `yaml:"abort_if_cluster_fast_join_fails" category:"advanced"`
	AbortIfFastJoinFailsMinNodes int                         `yaml:"abort_if_cluster_fast_join_fails_min_nodes" category:"advanced"`
	AbortIfJoinFails             bool                        `yaml:"abort_if_cluster_join_fails"`
	RejoinInterval               time.Duration               `yaml:"rejoin_interval" category:"advanced"`
	RejoinSeedNodes              flagext.StringSliceCSVMulti `yaml:"rejoin_seed_nodes" category:"experimental"`

	// Remove LEFT ingesters from ring after this timeout.
	LeftIngestersTimeout   time.Duration `yaml:"left_ingesters_timeout" category:"advanced"`
	ObsoleteEntriesTimeout time.Duration `yaml:"obsolete_entries_timeout" category:"experimental"`

	// Timeout used when leaving the memberlist cluster.
	LeaveTimeout                              time.Duration `yaml:"leave_timeout" category:"advanced"`
	BroadcastTimeoutForLocalUpdatesOnShutdown time.Duration `yaml:"broadcast_timeout_for_local_updates_on_shutdown" category:"advanced"`

	// How much space to use to keep received and sent messages in memory (for troubleshooting).
	MessageHistoryBufferBytes int `yaml:"message_history_buffer_bytes" category:"advanced"`

	// Size of the buffer for key watchers.
	WatchPrefixBufferSize int `yaml:"watch_prefix_buffer_size" category:"advanced"`

	TCPTransport TCPTransportConfig `yaml:",inline"`

	// Zone-aware routing configuration.
	ZoneAwareRouting ZoneAwareRoutingConfig `yaml:"zone_aware_routing"`

	// Propagation delay tracker configuration.
	PropagationDelayTracker PropagationDelayTrackerConfig `yaml:"propagation_delay_tracker" category:"experimental"`