consul

Documentation

Index

• Variables
• type Client
  • func NewClient(logger *zap.Logger, opts ...Option) (*Client, error)
  • func (c *Client) Deregister(_ context.Context, service *registry.ServiceInstance) error
  • func (c *Client) Register(_ context.Context, service *registry.ServiceInstance) (err error)
• type Option
  • func WithAddr(addr string) Option
  • func WithDeregisterCriticalServiceAfter(deregisterCriticalServiceAfter int) Option
  • func WithEnableHealthCheck(enable bool) Option
  • func WithHealthCheckInterval(interval int) Option
  • func WithHeartBeat(enable bool) Option
• type Options
• type Registry
  • func New(client *Client) *Registry
  • func (r *Registry) Deregister(ctx context.Context, service *registry.ServiceInstance) error
  • func (r *Registry) Register(ctx context.Context, service *registry.ServiceInstance) error

Variables

var (
	DefaultAddr                           = "127.0.0.1:8500"
	DefaultHealthCheckInterval            = 10
	DefaultDeregisterCriticalServiceAfter = 60
)

Types

type Client

type Client struct {
	*Options
	// contains filtered or unexported fields
}

Client is a consul client.

func NewClient

func NewClient(logger *zap.Logger, opts ...Option) (*Client, error)

NewClient returns a new consul client.

The default options are:

• Addr: DefaultAddr
• EnableHealthCheck: true
• HealthCheckInterval: DefaultHealthCheckInterval
• DeregisterCriticalServiceAfter: DefaultDeregisterCriticalServiceAfter
• HeartBeat: true

func (*Client) Deregister

func (c *Client) Deregister(_ context.Context, service *registry.ServiceInstance) error

func (*Client) Register

func (c *Client) Register(_ context.Context, service *registry.ServiceInstance) (err error)

type Option

type Option func(*Options)

func WithAddr

func WithAddr(addr string) Option

WithAddr sets the address of the consul server.

func WithDeregisterCriticalServiceAfter

func WithDeregisterCriticalServiceAfter(deregisterCriticalServiceAfter int) Option

WithDeregisterCriticalServiceAfter sets the time to wait before deregister a critical service.

func WithEnableHealthCheck

func WithEnableHealthCheck(enable bool) Option

WithEnableHealthCheck enables the health check.

func WithHealthCheckInterval

func WithHealthCheckInterval(interval int) Option

WithHealthCheckInterval sets the interval of the health check.

func WithHeartBeat

func WithHeartBeat(enable bool) Option

WithHeartBeat enables the heart beat.

type Options

type Options struct {
	// Addr is the address of the consul server.
	Addr string

	// EnableHealthCheck enables the health check.
	EnableHealthCheck bool

	// HealthCheckInterval is the interval of the health check.
	HealthCheckInterval int

	// DeregisterCriticalServiceAfter is the time to wait before deregister a critical service.
	DeregisterCriticalServiceAfter int

	// HeartBeat enables the heart beat.
	HeartBeat bool
}

type Registry

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

Registry is a consul registry.

func New

func New(client *Client) *Registry

New returns a new consul registry.

func (*Registry) Deregister

func (r *Registry) Deregister(ctx context.Context, service *registry.ServiceInstance) error

Deregister a service instance.

func (*Registry) Register

func (r *Registry) Register(ctx context.Context, service *registry.ServiceInstance) error

Register a service instance.