kv

Documentation

Index

• Constants
• func RegistererWithKVName(reg prometheus.Registerer, name string) prometheus.Registerer
• type Client
  • func NewClient(cfg Config, codec codec.Codec, reg prometheus.Registerer) (Client, error)
  • func PrefixClient(client Client, prefix string) Client
• type Config
  • func (cfg *Config) RegisterFlagsWithPrefix(flagsPrefix, defaultPrefix string, f *flag.FlagSet)
• type MultiClient
  • func NewMultiClient(cfg MultiConfig, clients []kvclient) *MultiClient
  • func (m *MultiClient) CAS(ctx context.Context, key string, ...) error
  • func (m *MultiClient) Delete(ctx context.Context, key string) error
  • func (m *MultiClient) Get(ctx context.Context, key string) (interface{}, error)
  • func (m *MultiClient) List(ctx context.Context, prefix string) ([]string, error)
  • func (m *MultiClient) WatchKey(ctx context.Context, key string, f func(interface{}) bool)
  • func (m *MultiClient) WatchPrefix(ctx context.Context, prefix string, f func(string, interface{}) bool)
• type MultiConfig
  • func (cfg *MultiConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, prefix string)
• type MultiRuntimeConfig
• type StoreConfig

Constants

const (
	// Primary is a role to use KV store primarily.
	Primary = role("primary")
	// Secondary is a role for KV store used by "multi" KV store.
	Secondary = role("secondary")
)

Functions

func RegistererWithKVName

func RegistererWithKVName(reg prometheus.Registerer, name string) prometheus.Registerer

RegistererWithKVName wraps the provided Registerer with the KV name label. If a nil reg is provided, a nil registry is returned

Types

type Client

type Client interface {
	// List returns a list of keys under the given prefix. Returned keys will
	// include the prefix.
	List(ctx context.Context, prefix string) ([]string, error)

	// Get a specific key.  Will use a codec to deserialise key to appropriate type.
	// If the key does not exist, Get will return nil and no error.
	Get(ctx context.Context, key string) (interface{}, error)

	// Delete a specific key. Deletions are best-effort and no error will
	// be returned if the key does not exist.
	Delete(ctx context.Context, key string) error

	// CAS stands for Compare-And-Swap.  Will call provided callback f with the
	// current value of the key and allow callback to return a different value.
	// Will then attempt to atomically swap the current value for the new value.
	// If that doesn't succeed will try again - callback will be called again
	// with new value etc.  Guarantees that only a single concurrent CAS
	// succeeds.  Callback can return nil to indicate it is happy with existing
	// value.
	CAS(ctx context.Context, key string, f func(in interface{}) (out interface{}, retry bool, err error)) error

	// WatchKey calls f whenever the value stored under key changes.
	WatchKey(ctx context.Context, key string, f func(interface{}) bool)

	// WatchPrefix calls f whenever any value stored under prefix changes.
	WatchPrefix(ctx context.Context, prefix string, f func(string, interface{}) bool)
}

Client is a high-level client for key-value stores (such as Etcd and Consul) that exposes operations such as CAS and Watch which take callbacks. It also deals with serialisation by using a Codec and having a instance of the the desired type passed in to methods ala json.Unmarshal.

func NewClient

func NewClient(cfg Config, codec codec.Codec, reg prometheus.Registerer) (Client, error)

NewClient creates a new Client (consul, etcd or inmemory) based on the config, encodes and decodes data for storage using the codec.

func PrefixClient

func PrefixClient(client Client, prefix string) Client

PrefixClient takes a KVClient and forces a prefix on all its operations.

type Config

type Config struct {
	Store       string `yaml:"store"`
	Prefix      string `yaml:"prefix"`
	StoreConfig `yaml:",inline"`

	Mock Client `yaml:"-"`
}

Config is config for a KVStore currently used by ring and HA tracker, where store can be consul or inmemory.

func (*Config) RegisterFlagsWithPrefix

func (cfg *Config) RegisterFlagsWithPrefix(flagsPrefix, defaultPrefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix adds the flags required to config this to the given FlagSet. If prefix is an empty string we will register consul flags with no prefix and the store flag with the prefix ring, so ring.store. For everything else we pass the prefix to the Consul flags. If prefix is not an empty string it should end with a period.

type MultiClient

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

MultiClient implements kv.Client by forwarding all API calls to primary client. Writes performed via CAS method are also (optionally) forwarded to secondary clients.

func NewMultiClient

func NewMultiClient(cfg MultiConfig, clients []kvclient) *MultiClient

NewMultiClient creates new MultiClient with given KV Clients. First client in the slice is the primary client.

func (*MultiClient) CAS

func (m *MultiClient) CAS(ctx context.Context, key string, f func(in interface{}) (out interface{}, retry bool, err error)) error

CAS is a part of kv.Client interface.

func (*MultiClient) Delete

func (m *MultiClient) Delete(ctx context.Context, key string) error

Delete is a part of the kv.Client interface.

func (*MultiClient) Get

func (m *MultiClient) Get(ctx context.Context, key string) (interface{}, error)

Get is a part of kv.Client interface.

func (*MultiClient) List

func (m *MultiClient) List(ctx context.Context, prefix string) ([]string, error)

List is a part of the kv.Client interface.

func (*MultiClient) WatchKey

func (m *MultiClient) WatchKey(ctx context.Context, key string, f func(interface{}) bool)

WatchKey is a part of kv.Client interface.

func (*MultiClient) WatchPrefix

func (m *MultiClient) WatchPrefix(ctx context.Context, prefix string, f func(string, interface{}) bool)

WatchPrefix is a part of kv.Client interface.

type MultiConfig

type MultiConfig struct {
	Primary   string `yaml:"primary"`
	Secondary string `yaml:"secondary"`

	MirrorEnabled bool          `yaml:"mirror_enabled"`
	MirrorTimeout time.Duration `yaml:"mirror_timeout"`

	// ConfigProvider returns channel with MultiRuntimeConfig updates.
	ConfigProvider func() <-chan MultiRuntimeConfig `yaml:"-"`
}

MultiConfig is a configuration for MultiClient.

func (*MultiConfig) RegisterFlagsWithPrefix

func (cfg *MultiConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, prefix string)

RegisterFlagsWithPrefix registers flags with prefix.

type MultiRuntimeConfig

type MultiRuntimeConfig struct {
	// Primary store used by MultiClient. Can be updated in runtime to switch to a different store (eg. consul -> etcd,
	// or to gossip). Doing this allows nice migration between stores. Empty values are ignored.
	PrimaryStore string `yaml:"primary"`

	// Mirroring enabled or not. Nil = no change.
	Mirroring *bool `yaml:"mirror_enabled"`
}

MultiRuntimeConfig has values that can change in runtime (via overrides)

type StoreConfig

type StoreConfig struct {
	Consul consul.Config `yaml:"consul"`
	Etcd   etcd.Config   `yaml:"etcd"`
	Multi  MultiConfig   `yaml:"multi"`

	// Function that returns memberlist.KV store to use. By using a function, we can delay
	// initialization of memberlist.KV until it is actually required.
	MemberlistKV func() (*memberlist.KV, error) `yaml:"-"`
}

StoreConfig is a configuration used for building single store client, either Consul, Etcd, Memberlist or MultiClient. It was extracted from Config to keep single-client config separate from final client-config (with all the wrappers)