package consul

import "github.com/go-kit/kit/sd/consul"

Package consul provides Instancer and Registrar implementations for Consul.

Index ¶

• type Client
• func NewClient(c *consul.Client) Client
• type Instancer
• func NewInstancer(client Client, logger log.Logger, service string, tags []string, passingOnly bool) *Instancer
• func (s *Instancer) Deregister(ch chan<- sd.Event)
• func (s *Instancer) Register(ch chan<- sd.Event)
• func (s *Instancer) Stop()
• type Registrar
• func NewRegistrar(client Client, r *stdconsul.AgentServiceRegistration, logger log.Logger) *Registrar
• func (p *Registrar) Deregister()
• func (p *Registrar) Register()

Package Files ¶

client.go doc.go instancer.go registrar.go

type Client ¶ Uses

type Client interface {
    // Register a service with the local agent.
    Register(r *consul.AgentServiceRegistration) error

    // Deregister a service with the local agent.
    Deregister(r *consul.AgentServiceRegistration) error

    // Service
    Service(service, tag string, passingOnly bool, queryOpts *consul.QueryOptions) ([]*consul.ServiceEntry, *consul.QueryMeta, error)
}

Client is a wrapper around the Consul API.

func NewClient ¶ Uses

func NewClient(c *consul.Client) Client

NewClient returns an implementation of the Client interface, wrapping a concrete Consul client.

type Instancer ¶ Uses

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

Instancer yields instances for a service in Consul.

func NewInstancer ¶ Uses

func NewInstancer(client Client, logger log.Logger, service string, tags []string, passingOnly bool) *Instancer

NewInstancer returns a Consul instancer that publishes instances for the requested service. It only returns instances for which all of the passed tags are present.

func (*Instancer) Deregister ¶ Uses

func (s *Instancer) Deregister(ch chan<- sd.Event)

Deregister implements Instancer.

func (*Instancer) Register ¶ Uses

func (s *Instancer) Register(ch chan<- sd.Event)

Register implements Instancer.

func (*Instancer) Stop ¶ Uses

func (s *Instancer) Stop()

Stop terminates the instancer.

type Registrar ¶ Uses

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

Registrar registers service instance liveness information to Consul.

func NewRegistrar ¶ Uses

func NewRegistrar(client Client, r *stdconsul.AgentServiceRegistration, logger log.Logger) *Registrar

NewRegistrar returns a Consul Registrar acting on the provided catalog registration.

func (*Registrar) Deregister ¶ Uses

func (p *Registrar) Deregister()

Deregister implements sd.Registrar interface.

func (*Registrar) Register ¶ Uses

func (p *Registrar) Register()

Register implements sd.Registrar interface.