register

Documentation

Index

• Constants
• type HealthChecker
  • func NewHealthChecker(registration Lifecycle, checks []healthcheck.Agent) *HealthChecker
  • func (checker *HealthChecker) Start()
  • func (checker *HealthChecker) Stop()
• type Lifecycle
• type RegistrationAgent
  • func NewRegistrationAgent(config RegistrationConfig) (*RegistrationAgent, error)
  • func (agent *RegistrationAgent) Start()
  • func (agent *RegistrationAgent) Stop()
• type RegistrationConfig

Constants

const DefaultHeartbeatsPerTTL = 3

DefaultHeartbeatsPerTTL default number of heartbeats per TTL

const DefaultReregistrationDelay = time.Duration(5) * time.Second

DefaultReregistrationDelay default delay before registering

const DefaultTTL = time.Duration(60) * time.Second

DefaultTTL default TTL requested for registration

Types

type HealthChecker

type HealthChecker struct {
	// contains filtered or unexported fields
}

HealthChecker uses a collection of periodic health checks to manage registration. Registration is maintained while the state of the health checker is healthy. If the state changes to unhealthy, the registration agent is stopped. Similarly, if the state changes to healthy the registration agent is started again. The health checker is considered unhealthy if any health check's last reported status is unhealthy.

func NewHealthChecker

func NewHealthChecker(registration Lifecycle, checks []healthcheck.Agent) *HealthChecker

NewHealthChecker instantiates a health checker.

func (*HealthChecker) Start

func (checker *HealthChecker) Start()

Start healthchecking and maintaining registration with registry. Non-blocking.

func (*HealthChecker) Stop

func (checker *HealthChecker) Stop()

Stop healthchecking and maintaining registration with registry. Blocks until deregistration attempt is complete.

type Lifecycle

type Lifecycle interface {
	Start()
	Stop()
}

Lifecycle is the interface implemented by objects that can be started and stopped.

type RegistrationAgent

type RegistrationAgent struct {
	// contains filtered or unexported fields
}

RegistrationAgent maintains a registration with registry.

func NewRegistrationAgent

func NewRegistrationAgent(config RegistrationConfig) (*RegistrationAgent, error)

NewRegistrationAgent instantiates a new instance of the agent

func (*RegistrationAgent) Start

func (agent *RegistrationAgent) Start()

Start maintaining registration with registry. Non-blocking.

func (*RegistrationAgent) Stop

func (agent *RegistrationAgent) Stop()

Stop maintaining registration with registry. Blocks until deregistration attempt is complete.

type RegistrationConfig

type RegistrationConfig struct {
	Registry api.ServiceRegistry
	Identity identity.Provider
}

RegistrationConfig options