resolver

README

gRPC Consul resolver

This lib resolves Consul services by name.

Usage

Somewhere in your init code:

import (
    "github.com/nvx/grpc-consul-resolver"
)

// Will query consul every 5 seconds.
resolver.RegisterDefault(time.Second * 5)

Getting connection:

conn, err := grpc.DialContext(ctx, "consul://service/my-awesome-service")

Using a tag

conn, err := grpc.DialContext(ctx, "consul://service/my-awesome-service/http")

Using a prepared query

conn, err := grpc.DialContext(ctx, "consul://query/my-awesome-query")

With round-robin balancer:

import (
    "google.golang.org/grpc/balancer/roundrobin"
)

conn, err := grpc.DialContext(ctx, "consul://service/my-awesome-service", grpc.WithBalancerName(roundrobin.Name))

Documentation

Index

• Constants
• func RegisterDefault(watchInterval time.Duration)
• type ConsulResolver
  • func (r *ConsulResolver) Close()
  • func (r *ConsulResolver) ResolveNow(resolver.ResolveNowOptions)
• type ConsulResolverBuilder
  • func (b *ConsulResolverBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error)
  • func (b *ConsulResolverBuilder) Scheme() string

Constants

const (
	Scheme = "consul"
)

Functions

func RegisterDefault

func RegisterDefault(watchInterval time.Duration)

Types

type ConsulResolver

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

func (*ConsulResolver) Close

func (r *ConsulResolver) Close()

func (*ConsulResolver) ResolveNow

func (r *ConsulResolver) ResolveNow(resolver.ResolveNowOptions)

type ConsulResolverBuilder

type ConsulResolverBuilder struct {
	WatchInterval      time.Duration
	ConsulClientConfig *api.Config
}

func (*ConsulResolverBuilder) Build

func (b *ConsulResolverBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error)

func (*ConsulResolverBuilder) Scheme

func (b *ConsulResolverBuilder) Scheme() string