watcher

README

Consul K/V Watcher

A simple wrapper around Consul API to watch for changes in a specific K/V directory or changes on one key. Uses blocking queries and cache by default. It also implements a simple exponential backoff for retryable errors.

Documentation

Index

• Constants
• type Watcher
  • func New(consulClient *consul.Client, retryTime time.Duration, ...) *Watcher
  • func (w *Watcher) WatchKey(ctx context.Context, key string) (<-chan *consul.KVPair, error)
  • func (w *Watcher) WatchTree(ctx context.Context, path string) (<-chan consul.KVPairs, error)

Constants

const DefaultWaitTime = 10 * time.Minute

DefaultWaitTime is the maximum wait time allowed by Consul

Types

type Watcher

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

Watcher is a wrapper around the Consul client that watches for changes to a keys and directories

func New

func New(consulClient *consul.Client, retryTime time.Duration, debounceTime time.Duration) *Watcher

New returns a new Watcher

func (*Watcher) WatchKey

func (w *Watcher) WatchKey(ctx context.Context, key string) (<-chan *consul.KVPair, error)

WatchKey watches for changes to a key and emits a key value pair

func (*Watcher) WatchTree

func (w *Watcher) WatchTree(ctx context.Context, path string) (<-chan consul.KVPairs, error)

WatchTree watches for changes to a directory and emit key value pairs