feat: registry.
This commit is contained in:
Bobo
@@ -1,31 +1,245 @@
|
||||
package consul
|
||||
|
||||
import (
|
||||
consulKratos "github.com/go-kratos/kratos/contrib/registry/consul/v2"
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"math/rand"
|
||||
"net"
|
||||
"net/url"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/go-kratos/kratos/v2/log"
|
||||
"github.com/go-kratos/kratos/v2/registry"
|
||||
|
||||
consulClient "github.com/hashicorp/consul/api"
|
||||
|
||||
conf "github.com/tx7do/kratos-bootstrap/api/gen/go/conf/v1"
|
||||
"github.com/hashicorp/consul/api"
|
||||
)
|
||||
|
||||
// NewRegistry 创建一个注册发现客户端 - Consul
|
||||
func NewRegistry(c *conf.Registry) *consulKratos.Registry {
|
||||
if c == nil || c.Consul == nil {
|
||||
return nil
|
||||
}
|
||||
type Datacenter string
|
||||
|
||||
cfg := consulClient.DefaultConfig()
|
||||
cfg.Address = c.Consul.GetAddress()
|
||||
cfg.Scheme = c.Consul.GetScheme()
|
||||
const (
|
||||
SingleDatacenter Datacenter = "SINGLE"
|
||||
MultiDatacenter Datacenter = "MULTI"
|
||||
)
|
||||
|
||||
var cli *consulClient.Client
|
||||
var err error
|
||||
if cli, err = consulClient.NewClient(cfg); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
// Client is consul client config
|
||||
type Client struct {
|
||||
dc Datacenter
|
||||
cli *api.Client
|
||||
ctx context.Context
|
||||
cancel context.CancelFunc
|
||||
|
||||
reg := consulKratos.New(cli, consulKratos.WithHealthCheck(c.Consul.GetHealthCheck()))
|
||||
|
||||
return reg
|
||||
// resolve service entry endpoints
|
||||
resolver ServiceResolver
|
||||
// healthcheck time interval in seconds
|
||||
healthcheckInterval int
|
||||
// heartbeat enable heartbeat
|
||||
heartbeat bool
|
||||
// deregisterCriticalServiceAfter time interval in seconds
|
||||
deregisterCriticalServiceAfter int
|
||||
// serviceChecks user custom checks
|
||||
serviceChecks api.AgentServiceChecks
|
||||
}
|
||||
|
||||
func defaultResolver(_ context.Context, entries []*api.ServiceEntry) []*registry.ServiceInstance {
|
||||
services := make([]*registry.ServiceInstance, 0, len(entries))
|
||||
for _, entry := range entries {
|
||||
var version string
|
||||
for _, tag := range entry.Service.Tags {
|
||||
ss := strings.SplitN(tag, "=", 2)
|
||||
if len(ss) == 2 && ss[0] == "version" {
|
||||
version = ss[1]
|
||||
}
|
||||
}
|
||||
endpoints := make([]string, 0)
|
||||
for scheme, addr := range entry.Service.TaggedAddresses {
|
||||
if scheme == "lan_ipv4" || scheme == "wan_ipv4" || scheme == "lan_ipv6" || scheme == "wan_ipv6" {
|
||||
continue
|
||||
}
|
||||
endpoints = append(endpoints, addr.Address)
|
||||
}
|
||||
if len(endpoints) == 0 && entry.Service.Address != "" && entry.Service.Port != 0 {
|
||||
endpoints = append(endpoints, fmt.Sprintf("http://%s:%d", entry.Service.Address, entry.Service.Port))
|
||||
}
|
||||
services = append(services, ®istry.ServiceInstance{
|
||||
ID: entry.Service.ID,
|
||||
Name: entry.Service.Service,
|
||||
Metadata: entry.Service.Meta,
|
||||
Version: version,
|
||||
Endpoints: endpoints,
|
||||
})
|
||||
}
|
||||
|
||||
return services
|
||||
}
|
||||
|
||||
// ServiceResolver is used to resolve service endpoints
|
||||
type ServiceResolver func(ctx context.Context, entries []*api.ServiceEntry) []*registry.ServiceInstance
|
||||
|
||||
// Service get services from consul
|
||||
func (c *Client) Service(ctx context.Context, service string, index uint64, passingOnly bool) ([]*registry.ServiceInstance, uint64, error) {
|
||||
if c.dc == MultiDatacenter {
|
||||
return c.multiDCService(ctx, service, index, passingOnly)
|
||||
}
|
||||
|
||||
opts := &api.QueryOptions{
|
||||
WaitIndex: index,
|
||||
WaitTime: time.Second * 55,
|
||||
Datacenter: string(c.dc),
|
||||
}
|
||||
opts = opts.WithContext(ctx)
|
||||
|
||||
if c.dc == SingleDatacenter {
|
||||
opts.Datacenter = ""
|
||||
}
|
||||
|
||||
entries, meta, err := c.singleDCEntries(service, "", passingOnly, opts)
|
||||
if err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
return c.resolver(ctx, entries), meta.LastIndex, nil
|
||||
}
|
||||
|
||||
func (c *Client) multiDCService(ctx context.Context, service string, index uint64, passingOnly bool) ([]*registry.ServiceInstance, uint64, error) {
|
||||
opts := &api.QueryOptions{
|
||||
WaitIndex: index,
|
||||
WaitTime: time.Second * 55,
|
||||
}
|
||||
opts = opts.WithContext(ctx)
|
||||
|
||||
var instances []*registry.ServiceInstance
|
||||
|
||||
dcs, err := c.cli.Catalog().Datacenters()
|
||||
if err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
|
||||
for _, dc := range dcs {
|
||||
opts.Datacenter = dc
|
||||
e, m, err := c.singleDCEntries(service, "", passingOnly, opts)
|
||||
if err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
|
||||
ins := c.resolver(ctx, e)
|
||||
for _, in := range ins {
|
||||
if in.Metadata == nil {
|
||||
in.Metadata = make(map[string]string, 1)
|
||||
}
|
||||
in.Metadata["dc"] = dc
|
||||
}
|
||||
|
||||
instances = append(instances, ins...)
|
||||
opts.WaitIndex = m.LastIndex
|
||||
}
|
||||
|
||||
return instances, opts.WaitIndex, nil
|
||||
}
|
||||
|
||||
func (c *Client) singleDCEntries(service, tag string, passingOnly bool, opts *api.QueryOptions) ([]*api.ServiceEntry, *api.QueryMeta, error) {
|
||||
return c.cli.Health().Service(service, tag, passingOnly, opts)
|
||||
}
|
||||
|
||||
// Register register service instance to consul
|
||||
func (c *Client) Register(_ context.Context, svc *registry.ServiceInstance, enableHealthCheck bool) error {
|
||||
addresses := make(map[string]api.ServiceAddress, len(svc.Endpoints))
|
||||
checkAddresses := make([]string, 0, len(svc.Endpoints))
|
||||
for _, endpoint := range svc.Endpoints {
|
||||
raw, err := url.Parse(endpoint)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
addr := raw.Hostname()
|
||||
port, _ := strconv.ParseUint(raw.Port(), 10, 16)
|
||||
|
||||
checkAddresses = append(checkAddresses, net.JoinHostPort(addr, strconv.FormatUint(port, 10)))
|
||||
addresses[raw.Scheme] = api.ServiceAddress{Address: endpoint, Port: int(port)}
|
||||
}
|
||||
asr := &api.AgentServiceRegistration{
|
||||
ID: svc.ID,
|
||||
Name: svc.Name,
|
||||
Meta: svc.Metadata,
|
||||
Tags: []string{fmt.Sprintf("version=%s", svc.Version)},
|
||||
TaggedAddresses: addresses,
|
||||
}
|
||||
if len(checkAddresses) > 0 {
|
||||
host, portRaw, _ := net.SplitHostPort(checkAddresses[0])
|
||||
port, _ := strconv.ParseInt(portRaw, 10, 32)
|
||||
asr.Address = host
|
||||
asr.Port = int(port)
|
||||
}
|
||||
if enableHealthCheck {
|
||||
for _, address := range checkAddresses {
|
||||
asr.Checks = append(asr.Checks, &api.AgentServiceCheck{
|
||||
TCP: address,
|
||||
Interval: fmt.Sprintf("%ds", c.healthcheckInterval),
|
||||
DeregisterCriticalServiceAfter: fmt.Sprintf("%ds", c.deregisterCriticalServiceAfter),
|
||||
Timeout: "5s",
|
||||
})
|
||||
}
|
||||
// custom checks
|
||||
asr.Checks = append(asr.Checks, c.serviceChecks...)
|
||||
}
|
||||
if c.heartbeat {
|
||||
asr.Checks = append(asr.Checks, &api.AgentServiceCheck{
|
||||
CheckID: "service:" + svc.ID,
|
||||
TTL: fmt.Sprintf("%ds", c.healthcheckInterval*2),
|
||||
DeregisterCriticalServiceAfter: fmt.Sprintf("%ds", c.deregisterCriticalServiceAfter),
|
||||
})
|
||||
}
|
||||
|
||||
err := c.cli.Agent().ServiceRegister(asr)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if c.heartbeat {
|
||||
go func() {
|
||||
time.Sleep(time.Second)
|
||||
err = c.cli.Agent().UpdateTTL("service:"+svc.ID, "pass", "pass")
|
||||
if err != nil {
|
||||
log.Errorf("[Consul]update ttl heartbeat to consul failed!err:=%v", err)
|
||||
}
|
||||
ticker := time.NewTicker(time.Second * time.Duration(c.healthcheckInterval))
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-c.ctx.Done():
|
||||
_ = c.cli.Agent().ServiceDeregister(svc.ID)
|
||||
return
|
||||
default:
|
||||
}
|
||||
select {
|
||||
case <-c.ctx.Done():
|
||||
_ = c.cli.Agent().ServiceDeregister(svc.ID)
|
||||
return
|
||||
case <-ticker.C:
|
||||
// ensure that unregistered services will not be re-registered by mistake
|
||||
if errors.Is(c.ctx.Err(), context.Canceled) || errors.Is(c.ctx.Err(), context.DeadlineExceeded) {
|
||||
_ = c.cli.Agent().ServiceDeregister(svc.ID)
|
||||
return
|
||||
}
|
||||
err = c.cli.Agent().UpdateTTL("service:"+svc.ID, "pass", "pass")
|
||||
if err != nil {
|
||||
log.Errorf("[Consul] update ttl heartbeat to consul failed! err=%v", err)
|
||||
// when the previous report fails, try to re register the service
|
||||
time.Sleep(time.Duration(rand.Intn(5)) * time.Second)
|
||||
if err := c.cli.Agent().ServiceRegister(asr); err != nil {
|
||||
log.Errorf("[Consul] re registry service failed!, err=%v", err)
|
||||
} else {
|
||||
log.Warn("[Consul] re registry of service occurred success")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Deregister service by service ID
|
||||
func (c *Client) Deregister(_ context.Context, serviceID string) error {
|
||||
defer c.cancel()
|
||||
return c.cli.Agent().ServiceDeregister(serviceID)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user