consul

Documentation

Overview

This package provides Consul dynamic data-source implementation for Sentinel.

Example (ConsulDataSource_CustomizeClient)

client, err := api.NewClient(&api.Config{
	Address: "127.0.0.1:8500",
})
if err != nil {
	fmt.Println("Failed to instance consul client")
	os.Exit(1)
}
ds, err := NewDataSource("property_key",
	// customize consul client
	WithConsulClient(client),
	// preset property handlers
	WithPropertyHandlers(),
	// reset queryOptions, defaultQueryOptions as default
	WithQueryOptions(&api.QueryOptions{}),
)

if err != nil {
	fmt.Println("Failed to instance consul datasource")
	os.Exit(1)
}

if err := ds.Initialize(); err != nil {
	fmt.Println("Failed to initialize consul datasource")
	os.Exit(1)
}

Example (ConsulDataSource_CustomizeConfig)

ds, err := NewDataSource("property_key",
	// customize consul config
	WithConsulConfig(&api.Config{
		Address: "127.0.0.1:8500",
	}),
	// preset property handlers
	WithPropertyHandlers(),
	// reset queryOptions, defaultQueryOptions as default
	WithQueryOptions(&api.QueryOptions{
		WaitIndex: 0,
		// override default WaitTime(5min)
		WaitTime: time.Second * 90,
	}),
)

if err != nil {
	fmt.Println("Failed to instance consul datasource")
	os.Exit(1)
}

if err := ds.Initialize(); err != nil {
	fmt.Println("Failed to initialize consul datasource")
	os.Exit(1)
}

Index

• Variables
• func NewDataSource(propertyKey string, opts ...Option) (datasource.DataSource, error)
• type KVQuerier
• type Option
  • func WithConsulClient(client *api.Client) Option
  • func WithConsulConfig(config *api.Config) Option
  • func WithPropertyHandlers(handlers ...datasource.PropertyHandler) Option
  • func WithQueryOptions(queryOptions *api.QueryOptions) Option

Examples

• Package (ConsulDataSource_CustomizeClient)
• Package (ConsulDataSource_CustomizeConfig)

Variables

var (
	ErrNilConsulClient     = errors.New("nil consul client")
	ErrInvalidConsulConfig = errors.New("invalid consul config")
	ErrKeyDoesNotExist     = errors.New("key does not exist")
)

Functions

func NewDataSource

func NewDataSource(propertyKey string, opts ...Option) (datasource.DataSource, error)

Types

type KVQuerier

type KVQuerier interface {
	Get(key string, q *api.QueryOptions) (*api.KVPair, *api.QueryMeta, error)
	List(prefix string, q *api.QueryOptions) (api.KVPairs, *api.QueryMeta, error)
}

type Option

type Option func(*options)

func WithConsulClient

func WithConsulClient(client *api.Client) Option

WithConsulClient injects consul client instance

func WithConsulConfig

func WithConsulConfig(config *api.Config) Option

WithConsulConfig injects consul client config

func WithPropertyHandlers

func WithPropertyHandlers(handlers ...datasource.PropertyHandler) Option

WithPropertyHandlers injects property handlers

func WithQueryOptions

func WithQueryOptions(queryOptions *api.QueryOptions) Option

WithQueryOptions sets options for consulClient.Get method