Skip to content

support consul custom tags #3486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

support consul custom tags #3486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d0ff6cb
support custom tags
nogolang Dec 12, 2024
29b94a8
fix lint
nogolang Dec 15, 2024
558b6bf
fix lint
nogolang Dec 16, 2024
7708a7a
Merge branch 'main' into main
nogolang Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions contrib/registry/consul/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ type Client struct {
deregisterCriticalServiceAfter int
// serviceChecks user custom checks
serviceChecks api.AgentServiceChecks
// tags custom consul tags
tags []string
}

func defaultResolver(_ context.Context, entries []*api.ServiceEntry) []*registry.ServiceInstance {
Expand Down Expand Up @@ -143,7 +145,7 @@ func (c *Client) singleDCEntries(service, tag string, passingOnly bool, opts *ap
}

// Register register service instance to consul
func (c *Client) Register(_ context.Context, svc *registry.ServiceInstance, enableHealthCheck bool) error {
func (c *Client) Register(_ context.Context, svc *registry.ServiceInstance, enableHealthCheck bool, tags []string) error {
addresses := make(map[string]api.ServiceAddress, len(svc.Endpoints))
checkAddresses := make([]string, 0, len(svc.Endpoints))
for _, endpoint := range svc.Endpoints {
Expand All @@ -157,11 +159,12 @@ func (c *Client) Register(_ context.Context, svc *registry.ServiceInstance, enab
checkAddresses = append(checkAddresses, net.JoinHostPort(addr, strconv.FormatUint(port, 10)))
addresses[raw.Scheme] = api.ServiceAddress{Address: endpoint, Port: int(port)}
}
tags = append(tags, fmt.Sprintf("version=%s", svc.Version))
asr := &api.AgentServiceRegistration{
ID: svc.ID,
Name: svc.Name,
Meta: svc.Metadata,
Tags: []string{fmt.Sprintf("version=%s", svc.Version)},
Tags: tags,
TaggedAddresses: addresses,
}
if len(checkAddresses) > 0 {
Expand All @@ -179,7 +182,6 @@ func (c *Client) Register(_ context.Context, svc *registry.ServiceInstance, enab
Timeout: "5s",
})
}
// custom checks
asr.Checks = append(asr.Checks, c.serviceChecks...)
}
if c.heartbeat {
Expand Down
10 changes: 9 additions & 1 deletion contrib/registry/consul/registry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,14 @@ func WithServiceCheck(checks ...*api.AgentServiceCheck) Option {
}
}

func WithServiceTags(tags []string) Option {
return func(o *Registry) {
if len(tags) > 0 {
o.cli.tags = tags
}
}
}

// Config is consul registry config
type Config struct {
*api.Config
Expand Down Expand Up @@ -124,7 +132,7 @@ func New(apiClient *api.Client, opts ...Option) *Registry {

// Register register service
func (r *Registry) Register(ctx context.Context, svc *registry.ServiceInstance) error {
return r.cli.Register(ctx, svc, r.enableHealthCheck)
return r.cli.Register(ctx, svc, r.enableHealthCheck, r.cli.tags)
}

// Deregister deregister service
Expand Down