README
¶
go-consul-instance-manager
Библиотека для отслеживания состояния экземпляров какого-либо сервиса через Hashicorp Consul.
Пример использования
см. в директории /example
Консистентное хэширование
В основе механизма определения держателя ключа (метод iman.GetDataOwner(key)) лежит механизм консистентного хэширования на основе хэш-кольца. Подробнее можно почитать ЗДЕСЬ и ЗДЕСЬ.
Диаграмма классов
instance status
Documentation
¶
Index ¶
- Variables
- func WithBackupHashring(hashFunc hashring.HashFunc) options.Option[Client]
- func WithConsulClient(cc *consul.Client) options.Option[Client]
- func WithDownHoldDuration(dur time.Duration) options.Option[Client]
- func WithLogger(l zerolog.Logger) options.Option[Client]
- func WithPollInterval(dur time.Duration) options.Option[Client]
- type Client
- type Comparable
- type Instance
- type InstanceStatus
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidInstanceStatus = errors.New("not a valid InstanceStatus")
Functions ¶
func WithBackupHashring ¶ added in v1.1.1
func WithConsulClient ¶
Sets custon consul client to operate with. Default is client based on DefaultConfig().
func WithDownHoldDuration ¶
Sets duration, for which node will be marked as pending before being removed from instances list. Default is 15s.
func WithLogger ¶
Sets custom logger. Default is stdout console logger.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) Deregister ¶
Deregisters instance of cl.appName with given parameters.
func (*Client) GetDataHolders ¶ added in v1.1.1
Get list of instances that hold given key. Client must be started to run this method properly.
func (*Client) GetInstances ¶
Get list of alive instances now. Client must be started to run this method properly.
type Comparable ¶
type Comparable interface{ comparable }
type Instance ¶
type Instance struct {
// contains filtered or unexported fields
}
func (*Instance) Status ¶
func (ins *Instance) Status() InstanceStatus
type InstanceStatus ¶
type InstanceStatus uint8
ENUM(alive, pending)
const ( // InstanceStatusAlive is a InstanceStatus of type Alive. InstanceStatusAlive InstanceStatus = iota // InstanceStatusPending is a InstanceStatus of type Pending. InstanceStatusPending )
func ParseInstanceStatus ¶
func ParseInstanceStatus(name string) (InstanceStatus, error)
ParseInstanceStatus attempts to convert a string to a InstanceStatus.
func (InstanceStatus) IsValid ¶
func (x InstanceStatus) IsValid() bool
IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values
func (InstanceStatus) String ¶
func (x InstanceStatus) String() string
String implements the Stringer interface.
Source Files
Directories