Documentation
¶
Index ¶
- Constants
- func OversizedMessage(b []byte) bool
- type Channel
- type ClusterChannel
- type ClusterMember
- type ClusterPeer
- type Member
- type Peer
- func (p *Peer) AddState(key string, s State, reg prometheus.Registerer) ClusterChannel
- func (p *Peer) ClusterSize() int
- func (p *Peer) Info() map[string]interface{}
- func (p *Peer) Join(reconnectInterval time.Duration, reconnectTimeout time.Duration) error
- func (p *Peer) Leave(timeout time.Duration) error
- func (p *Peer) Name() string
- func (p *Peer) Peers() []ClusterMember
- func (p *Peer) Position() int
- func (p *Peer) Ready() bool
- func (p *Peer) Self() *memberlist.Node
- func (p *Peer) Settle(ctx context.Context, interval time.Duration)
- func (p *Peer) Status() string
- func (p *Peer) WaitReady(ctx context.Context) error
- type PeerStatus
- type State
- type TLSTransport
- func (t *TLSTransport) DialTimeout(addr string, timeout time.Duration) (net.Conn, error)
- func (t *TLSTransport) FinalAdvertiseAddr(ip string, port int) (net.IP, int, error)
- func (t *TLSTransport) GetAutoBindPort() int
- func (t *TLSTransport) PacketCh() <-chan *memberlist.Packet
- func (t *TLSTransport) Shutdown() error
- func (t *TLSTransport) StreamCh() <-chan net.Conn
- func (t *TLSTransport) WriteTo(b []byte, addr string) (time.Time, error)
- type TLSTransportConfig
Constants ¶
const ( DefaultPushPullInterval = 60 * time.Second DefaultGossipInterval = 200 * time.Millisecond DefaultTCPTimeout = 10 * time.Second DefaultProbeTimeout = 500 * time.Millisecond DefaultProbeInterval = 1 * time.Second DefaultReconnectInterval = 10 * time.Second DefaultReconnectTimeout = 6 * time.Hour DefaultRefreshInterval = 15 * time.Second MaxGossipPacketSize = 1400 )
Variables ¶
This section is empty.
Functions ¶
func OversizedMessage ¶
OversizedMessage indicates whether or not the byte payload should be sent via TCP.
Types ¶
type Channel ¶
type Channel struct {
// contains filtered or unexported fields
}
Channel allows clients to send messages for a specific state type that will be broadcasted in a best-effort manner.
func NewChannel ¶
func NewChannel( key string, send func([]byte), peers func() []*memberlist.Node, sendOversize func(*memberlist.Node, []byte) error, logger log.Logger, stopc chan struct{}, reg prometheus.Registerer, ) *Channel
NewChannel creates a new Channel struct, which handles sending normal and oversize messages to peers.
type ClusterChannel ¶ added in v0.22.0
type ClusterChannel interface {
Broadcast([]byte)
}
ClusterChannel supports state broadcasting across peers.
type ClusterMember ¶ added in v0.22.0
type ClusterMember interface {
// Name returns the name of the node
Name() string
// Address returns the IP address of the node
Address() string
}
ClusterMember interface that represents node peers in a cluster
type ClusterPeer ¶ added in v0.22.0
type ClusterPeer interface {
// Name returns the unique identifier of this peer in the cluster.
Name() string
// Status returns a status string representing the peer state.
Status() string
// Peers returns the peer nodes in the cluster.
Peers() []ClusterMember
}
ClusterPeer represents a single Peer in a gossip cluster.
type Member ¶ added in v0.22.0
type Member struct {
// contains filtered or unexported fields
}
Member represents a member in the cluster.
type Peer ¶
type Peer struct {
// contains filtered or unexported fields
}
Peer is a single peer in a gossip cluster.
func Create ¶ added in v0.15.1
func Create( l log.Logger, reg prometheus.Registerer, bindAddr string, advertiseAddr string, knownPeers []string, waitIfEmpty bool, pushPullInterval time.Duration, gossipInterval time.Duration, tcpTimeout time.Duration, probeTimeout time.Duration, probeInterval time.Duration, tlsTransportConfig *TLSTransportConfig, allowInsecureAdvertise bool, label string, ) (*Peer, error)
func (*Peer) AddState ¶
func (p *Peer) AddState(key string, s State, reg prometheus.Registerer) ClusterChannel
AddState adds a new state that will be gossiped. It returns a channel to which broadcast messages for the state can be sent.
func (*Peer) ClusterSize ¶
ClusterSize returns the current number of alive members in the cluster.
func (*Peer) Self ¶
func (p *Peer) Self() *memberlist.Node
Self returns the node information about the peer itself.
func (*Peer) Settle ¶
Settle waits until the mesh is ready (and sets the appropriate internal state when it is). The idea is that we don't want to start "working" before we get a chance to know most of the alerts and/or silences. Inspired from https://github.com/apache/cassandra/blob/7a40abb6a5108688fb1b10c375bb751cbb782ea4/src/java/org/apache/cassandra/gms/Gossiper.java This is clearly not perfect or strictly correct but should prevent the alertmanager to send notification before it is obviously not ready. This is especially important for those that do not have persistent storage.
type PeerStatus ¶
type PeerStatus int
PeerStatus is the state that a peer is in.
const ( StatusNone PeerStatus = iota StatusAlive StatusFailed )
func (PeerStatus) String ¶
func (s PeerStatus) String() string
type State ¶
type State interface {
// MarshalBinary serializes the underlying state.
MarshalBinary() ([]byte, error)
// Merge merges serialized state into the underlying state.
Merge(b []byte) error
}
State is a piece of state that can be serialized and merged with other serialized state.
type TLSTransport ¶ added in v0.24.0
type TLSTransport struct {
// contains filtered or unexported fields
}
TLSTransport is a Transport implementation that uses TLS over TCP for both packet and stream operations.
func NewTLSTransport ¶ added in v0.24.0
func NewTLSTransport( ctx context.Context, logger log.Logger, reg prometheus.Registerer, bindAddr string, bindPort int, cfg *TLSTransportConfig, ) (*TLSTransport, error)
NewTLSTransport returns a TLS transport with the given configuration. On successful initialization, a tls listener will be created and listening. A valid bindAddr is required. If bindPort == 0, the system will assign a free port automatically.
func (*TLSTransport) DialTimeout ¶ added in v0.24.0
DialTimeout is used to create a connection that allows memberlist to perform two-way communications with a peer.
func (*TLSTransport) FinalAdvertiseAddr ¶ added in v0.24.0
FinalAdvertiseAddr is given the user's configured values (which might be empty) and returns the desired IP and port to advertise to the rest of the cluster.
func (*TLSTransport) GetAutoBindPort ¶ added in v0.24.0
func (t *TLSTransport) GetAutoBindPort() int
GetAutoBindPort returns the bind port that was automatically given by the system if a bindPort of 0 was specified during instantiation.
func (*TLSTransport) PacketCh ¶ added in v0.24.0
func (t *TLSTransport) PacketCh() <-chan *memberlist.Packet
PacketCh returns a channel that can be read to receive incoming packets from other peers.
func (*TLSTransport) Shutdown ¶ added in v0.24.0
func (t *TLSTransport) Shutdown() error
Shutdown is called when memberlist is shutting down; this gives the TLS Transport a chance to clean up the listener and other goroutines.
func (*TLSTransport) StreamCh ¶ added in v0.24.0
func (t *TLSTransport) StreamCh() <-chan net.Conn
StreamCh returns a channel that can be read to handle incoming stream connections from other peers.
type TLSTransportConfig ¶ added in v0.24.0
type TLSTransportConfig struct {
TLSServerConfig *web.TLSConfig `yaml:"tls_server_config"`
TLSClientConfig *config.TLSConfig `yaml:"tls_client_config"`
}
func GetTLSTransportConfig ¶ added in v0.24.0
func GetTLSTransportConfig(configPath string) (*TLSTransportConfig, error)
Source Files
Directories