config

README

Config

Config is a pluggable dynamic config package

Most config in applications are statically configured or include complex logic to load from multiple sources. Go Config makes this easy, pluggable and mergeable. You'll never have to deal with config in the same way again.

Features

• Dynamic Loading - Load configuration from multiple source as and when needed. Go Config manages watching config sources in the background and automatically merges and updates an in memory view.

• Pluggable Sources - Choose from any number of sources to load and merge config. The backend source is abstracted away into a standard format consumed internally and decoded via encoders. Sources can be env vars, flags, file, etcd, k8s configmap, etc.

• Mergeable Config - If you specify multiple sources of config, regardless of format, they will be merged and presented in a single view. This massively simplifies priority order loading and changes based on environment.

• Observe Changes - Optionally watch the config for changes to specific values. Hot reload your app using Go Config's watcher. You don't have to handle ad-hoc hup reloading or whatever else, just keep reading the config and watch for changes if you need to be notified.

• Sane Defaults - In case config loads badly or is completely wiped away for some unknown reason, you can specify fallback values when accessing any config values directly. This ensures you'll always be reading some sane default in the event of a problem.

Documentation

Overview

Package config is an interface for dynamic configuration.

Index

• type Config
  • func NewConfig(opts ...Option) (Config, error)
• type Option
  • func Storage(e bool) Option
  • func StorageDir(d string) Option
  • func Watch(t bool) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Watcher

Types

type Config

type Config interface {
	// provide the reader.Values interface
	reader.Values
	// Stop the config loader/watcher
	Close() error
	// Load config Sources
	Load(source ...source.Source) error
	// Force a source change set sync
	Sync() error
	// Watch a value for changes
	Watch(path ...string) (Watcher, error)
}

Config is an interface abstraction for dynamic configuration

func NewConfig

func NewConfig(opts ...Option) (Config, error)

NewConfig returns new config

type Option

type Option func(o *Options)

func Storage

func Storage(e bool) Option

func StorageDir

func StorageDir(d string) Option

func Watch

func Watch(t bool) Option

type Options

type Options struct {
	Storage    bool
	StorageDir string
	Watch      bool
	// for alternative data
	Context context.Context
}

func NewOptions

func NewOptions(opts ...Option) Options

type Watcher

type Watcher interface {
	Next() (reader.Value, error)
	Stop() error
}

Watcher is the config watcher