viper

package module
v1.7.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 7, 2020 License: MIT Imports: 31 Imported by: 0

README

NEW Watching and re-reading config files

use github.com/radovskyb/watcher to Watching and re-reading config files,so it could work in k8s.

viper.WatcherConfig()
viper.OnWatcherConfigChange(func(e watcher.Event) {
	fmt.Println("Config file changed:", e.FileInfo)
})

Old Watching and re-reading config files

Viper supports the ability to have your application live read a config file while running.

Gone are the days of needing to restart a server to have a config take effect, viper powered applications can read an update to a config file while running and not miss a beat.

Simply tell the viper instance to watchConfig. Optionally you can provide a function for Viper to run each time a change occurs.

Make sure you add all of the configPaths prior to calling WatchConfig()

viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
	fmt.Println("Config file changed:", e.Name)
})

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var RemoteConfig remoteConfigFactory

RemoteConfig is optional, see the remote package

View Source 
var SupportedExts = []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "dotenv", "env", "ini"}

SupportedExts are universally supported extensions.

View Source 
var SupportedRemoteProviders = []string{"etcd", "consul", "firestore"}

SupportedRemoteProviders are universally supported remote providers.

Functions

func AddConfigPath 

func AddConfigPath(in string)

AddConfigPath adds a path for Viper to search for the config file in. Can be called multiple times to define multiple search paths.

func AddRemoteProvider 

func AddRemoteProvider(provider, endpoint, path string) error

AddRemoteProvider adds a remote configuration source. Remote Providers are searched in the order they are added. provider is a string value: "etcd", "consul" or "firestore" are currently supported. endpoint is the url. etcd requires http://ip:port consul requires ip:port path is the path in the k/v store to retrieve configuration To retrieve a config file called myapp.json from /configs/myapp.json you should set path to /configs and set config name (SetConfigName()) to "myapp"

func AddSecureRemoteProvider 

func AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error

AddSecureRemoteProvider adds a remote configuration source. Secure Remote Providers are searched in the order they are added. provider is a string value: "etcd", "consul" or "firestore" are currently supported. endpoint is the url. etcd requires http://ip:port consul requires ip:port secretkeyring is the filepath to your openpgp secret keyring. e.g. /etc/secrets/myring.gpg path is the path in the k/v store to retrieve configuration To retrieve a config file called myapp.json from /configs/myapp.json you should set path to /configs and set config name (SetConfigName()) to "myapp" Secure Remote Providers are implemented with github.com/bketelsen/crypt

func AllKeys 

func AllKeys() []string

AllKeys returns all keys holding a value, regardless of where they are set. Nested keys are returned with a v.keyDelim separator

func AllSettings 

func AllSettings() map[string]interface{}

AllSettings merges all settings and returns them as a map[string]interface{}.

func AllowEmptyEnv added in v1.7.11 

func AllowEmptyEnv(allowEmptyEnv bool)

AllowEmptyEnv tells Viper to consider set, but empty environment variables as valid values instead of falling back. For backward compatibility reasons this is false by default.

func AutomaticEnv 

func AutomaticEnv()

AutomaticEnv makes Viper check if environment variables match any of the existing keys (config, default or flags). If matching env vars are found, they are loaded into Viper.

func BindEnv 

func BindEnv(input ...string) error

BindEnv binds a Viper key to a ENV variable. ENV variables are case sensitive. If only a key is provided, it will use the env key matching the key, uppercased. If more arguments are provided, they will represent the env variable names that should bind to this key and will be taken in the specified order. EnvPrefix will be used when set when env name is not provided.

func BindFlagValue 

func BindFlagValue(key string, flag FlagValue) error

BindFlagValue binds a specific key to a FlagValue.

func BindFlagValues 

func BindFlagValues(flags FlagValueSet) error

BindFlagValues binds a full FlagValue set to the configuration, using each flag's long name as the config key.

func BindPFlag 

func BindPFlag(key string, flag *pflag.Flag) error

BindPFlag binds a specific key to a pflag (as used by cobra). Example (where serverCmd is a Cobra instance): 

serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
Viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))

func BindPFlags 

func BindPFlags(flags *pflag.FlagSet) error

BindPFlags binds a full flag set to the configuration, using each flag's long name as the config key.

func ConfigFileUsed 

func ConfigFileUsed() string

ConfigFileUsed returns the file used to populate the config registry.

func Debug 

func Debug()

Debug prints all configuration registries for debugging purposes.

func Get 

func Get(key string) interface{}

Get can retrieve any value given the key to use. Get is case-insensitive for a key. Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: override, flag, env, config file, key/value store, default

Get returns an interface. For a specific value use one of the Get____ methods.

func GetBool 

func GetBool(key string) bool

GetBool returns the value associated with the key as a boolean.

func GetDuration 

func GetDuration(key string) time.Duration

GetDuration returns the value associated with the key as a duration.

func GetFloat64 

func GetFloat64(key string) float64

GetFloat64 returns the value associated with the key as a float64.

func GetInt 

func GetInt(key string) int

GetInt returns the value associated with the key as an integer.

func GetInt32 added in v1.1.0 

func GetInt32(key string) int32

GetInt32 returns the value associated with the key as an integer.

func GetInt64 

func GetInt64(key string) int64

GetInt64 returns the value associated with the key as an integer.

func GetIntSlice added in v1.7.11 

func GetIntSlice(key string) []int

GetIntSlice returns the value associated with the key as a slice of int values.

func GetSizeInBytes 

func GetSizeInBytes(key string) uint

GetSizeInBytes returns the size of the value associated with the given key in bytes.

func GetString 

func GetString(key string) string

GetString returns the value associated with the key as a string.

func GetStringMap 

func GetStringMap(key string) map[string]interface{}

GetStringMap returns the value associated with the key as a map of interfaces.

func GetStringMapString 

func GetStringMapString(key string) map[string]string

GetStringMapString returns the value associated with the key as a map of strings.

func GetStringMapStringSlice 

func GetStringMapStringSlice(key string) map[string][]string

GetStringMapStringSlice returns the value associated with the key as a map to a slice of strings.

func GetStringSlice 

func GetStringSlice(key string) []string

GetStringSlice returns the value associated with the key as a slice of strings.

func GetTime 

func GetTime(key string) time.Time

GetTime returns the value associated with the key as time.

func GetUint added in v1.7.11 

func GetUint(key string) uint

GetUint returns the value associated with the key as an unsigned integer.

func GetUint32 added in v1.7.11 

func GetUint32(key string) uint32

GetUint32 returns the value associated with the key as an unsigned integer.

func GetUint64 added in v1.7.11 

func GetUint64(key string) uint64

GetUint64 returns the value associated with the key as an unsigned integer.

func InConfig 

func InConfig(key string) bool

InConfig checks to see if the given key (or an alias) is in the config file.

func IsSet 

func IsSet(key string) bool

IsSet checks to see if the key has been set in any of the data locations. IsSet is case-insensitive for a key.

func MergeConfig 

func MergeConfig(in io.Reader) error

MergeConfig merges a new configuration with an existing config.

func MergeConfigMap added in v1.7.11 

func MergeConfigMap(cfg map[string]interface{}) error

MergeConfigMap merges the configuration from the map given with an existing config. Note that the map given may be modified.

func MergeInConfig 

func MergeInConfig() error

MergeInConfig merges a new configuration with an existing config.

func OnConfigChange 

func OnConfigChange(run func(in fsnotify.Event))

func OnWatcherConfigChange added in v1.7.11 

func OnWatcherConfigChange(run func(in watcher.Event))

func ReadConfig 

func ReadConfig(in io.Reader) error

ReadConfig will read a configuration file, setting existing keys to nil if the key does not exist in the file.

func ReadInConfig 

func ReadInConfig() error

ReadInConfig will discover and load the configuration file from disk and key/value stores, searching in one of the defined paths.

func ReadRemoteConfig 

func ReadRemoteConfig() error

ReadRemoteConfig attempts to get configuration from a remote source and read it in the remote configuration registry.

func RegisterAlias 

func RegisterAlias(alias string, key string)

RegisterAlias creates an alias that provides another accessor for the same key. This enables one to change a name without breaking the application.

func Reset 

func Reset()

Reset is intended for testing, will reset all to default settings. In the public interface for the viper package so applications can use it in their testing as well.

func SafeWriteConfig added in v1.0.1 

func SafeWriteConfig() error

SafeWriteConfig writes current configuration to file only if the file does not exist.

func SafeWriteConfigAs added in v1.0.1 

func SafeWriteConfigAs(filename string) error

SafeWriteConfigAs writes current configuration to a given filename if it does not exist.

func Set 

func Set(key string, value interface{})

Set sets the value for the key in the override register. Set is case-insensitive for a key. Will be used instead of values obtained via flags, config file, ENV, default, or key/value store.

func SetConfigFile 

func SetConfigFile(in string)

SetConfigFile explicitly defines the path, name and extension of the config file. Viper will use this and not check any of the config paths.

func SetConfigName 

func SetConfigName(in string)

SetConfigName sets name for the config file. Does not include extension.

func SetConfigPermissions added in v1.7.11 

func SetConfigPermissions(perm os.FileMode)

SetConfigPermissions sets the permissions for the config file.

func SetConfigType 

func SetConfigType(in string)

SetConfigType sets the type of the configuration returned by the remote source, e.g. "json".

func SetDefault 

func SetDefault(key string, value interface{})

SetDefault sets the default value for this key. SetDefault is case-insensitive for a key. Default only used when no value is provided by the user via flag, config or ENV.

func SetEnvKeyReplacer 

func SetEnvKeyReplacer(r *strings.Replacer)

SetEnvKeyReplacer sets the strings.Replacer on the viper object Useful for mapping an environmental variable to a key that does not match it.

func SetEnvPrefix 

func SetEnvPrefix(in string)

SetEnvPrefix defines a prefix that ENVIRONMENT variables will use. E.g. if your prefix is "spf", the env registry will look for env variables that start with "SPF_".

func SetFs 

func SetFs(fs afero.Fs)

SetFs sets the filesystem to use to read configuration.

func SetTypeByDefaultValue 

func SetTypeByDefaultValue(enable bool)

SetTypeByDefaultValue enables or disables the inference of a key value's type when the Get function is used based upon a key's default value as opposed to the value returned based on the normal fetch logic.

For example, if a key has a default value of []string{} and the same key is set via an environment variable to "a b c", a call to the Get function would return a string slice for the key if the key's type is inferred by the default value and the Get function would return: 

[]string {"a", "b", "c"}

Otherwise the Get function would return: 

"a b c"

func Unmarshal 

func Unmarshal(rawVal interface{}, opts ...DecoderConfigOption) error

Unmarshal unmarshals the config into a Struct. Make sure that the tags on the fields of the structure are properly set.

func UnmarshalExact added in v1.7.11 

func UnmarshalExact(rawVal interface{}, opts ...DecoderConfigOption) error

UnmarshalExact unmarshals the config into a Struct, erroring if a field is nonexistent in the destination struct.

func UnmarshalKey 

func UnmarshalKey(key string, rawVal interface{}, opts ...DecoderConfigOption) error

UnmarshalKey takes a single key and unmarshals it into a Struct.

func WatchConfig 

func WatchConfig()

func WatchRemoteConfig 

func WatchRemoteConfig() error

func WatcherConfig added in v1.7.11 

func WatcherConfig()

func WriteConfig added in v1.0.1 

func WriteConfig() error

WriteConfig writes the current configuration to a file.

func WriteConfigAs added in v1.0.1 

func WriteConfigAs(filename string) error

WriteConfigAs writes current configuration to a given filename.

Types

type ConfigFileAlreadyExistsError added in v1.7.11 

type ConfigFileAlreadyExistsError string

ConfigFileAlreadyExistsError denotes failure to write new configuration file.

func (ConfigFileAlreadyExistsError) Error added in v1.7.11 

func (faee ConfigFileAlreadyExistsError) Error() string

Error returns the formatted error when configuration already exists.

type ConfigFileNotFoundError 

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

ConfigFileNotFoundError denotes failing to find configuration file.

func (ConfigFileNotFoundError) Error 

func (fnfe ConfigFileNotFoundError) Error() string

Error returns the formatted configuration error.

type ConfigMarshalError added in v1.0.1 

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

ConfigMarshalError happens when failing to marshal the configuration.

func (ConfigMarshalError) Error added in v1.0.1 

func (e ConfigMarshalError) Error() string

Error returns the formatted configuration error.

type ConfigParseError 

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

ConfigParseError denotes failing to parse configuration file.

func (ConfigParseError) Error 

func (pe ConfigParseError) Error() string

Error returns the formatted configuration error.

type DecoderConfigOption added in v1.1.0 

type DecoderConfigOption func(*mapstructure.DecoderConfig)

A DecoderConfigOption can be passed to viper.Unmarshal to configure mapstructure.DecoderConfig options

func DecodeHook added in v1.1.0 

func DecodeHook(hook mapstructure.DecodeHookFunc) DecoderConfigOption

DecodeHook returns a DecoderConfigOption which overrides the default DecoderConfig.DecodeHook value, the default is: 

 mapstructure.ComposeDecodeHookFunc(
		mapstructure.StringToTimeDurationHookFunc(),
		mapstructure.StringToSliceHookFunc(","),
	)

type FlagValue 

type FlagValue interface {
	HasChanged() bool
	Name() string
	ValueString() string
	ValueType() string
}

FlagValue is an interface that users can implement to bind different flags to viper.

type FlagValueSet 

type FlagValueSet interface {
	VisitAll(fn func(FlagValue))
}

FlagValueSet is an interface that users can implement to bind a set of flags to viper.

type Option added in v1.7.11 

type Option interface {
	// contains filtered or unexported methods
}

Option configures Viper using the functional options paradigm popularized by Rob Pike and Dave Cheney. If you're unfamiliar with this style, see https://commandcenter.blogspot.com/2014/01/self-referential-functions-and-design.html and https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis.

func EnvKeyReplacer added in v1.7.11 

func EnvKeyReplacer(r StringReplacer) Option

EnvKeyReplacer sets a replacer used for mapping environment variables to internal keys.

func KeyDelimiter added in v1.7.11 

func KeyDelimiter(d string) Option

KeyDelimiter sets the delimiter used for determining key parts. By default it's value is ".".

type RemoteConfigError 

type RemoteConfigError string

RemoteConfigError denotes encountering an error while trying to pull the configuration from the remote provider.

func (RemoteConfigError) Error 

func (rce RemoteConfigError) Error() string

Error returns the formatted remote provider error

type RemoteProvider 

type RemoteProvider interface {
	Provider() string
	Endpoint() string
	Path() string
	SecretKeyring() string
}

RemoteProvider stores the configuration necessary to connect to a remote key/value store. Optional secretKeyring to unencrypt encrypted values can be provided.

type RemoteResponse 

type RemoteResponse struct {
	Value []byte
	Error error
}

type StringReplacer added in v1.7.11 

type StringReplacer interface {
	// Replace returns a copy of s with all replacements performed.
	Replace(s string) string
}

StringReplacer applies a set of replacements to a string.

type UnsupportedConfigError 

type UnsupportedConfigError string

UnsupportedConfigError denotes encountering an unsupported configuration filetype.

func (UnsupportedConfigError) Error 

func (str UnsupportedConfigError) Error() string

Error returns the formatted configuration error.

type UnsupportedRemoteProviderError 

type UnsupportedRemoteProviderError string

UnsupportedRemoteProviderError denotes encountering an unsupported remote provider. Currently only etcd and Consul are supported.

func (UnsupportedRemoteProviderError) Error 

func (str UnsupportedRemoteProviderError) Error() string

Error returns the formatted remote provider error.

type Viper 

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

Viper is a prioritized configuration registry. It maintains a set of configuration sources, fetches values to populate those, and provides them according to the source's priority. The priority of the sources is the following: 1. overrides 2. flags 3. env. variables 4. config file 5. key/value store 6. defaults

For example, if values from the following sources were loaded: 

Defaults : {
	"secret": "",
	"user": "default",
	"endpoint": "https://localhost"
}
Config : {
	"user": "root"
	"secret": "defaultsecret"
}
Env : {
	"secret": "somesecretkey"
}

The resulting config will have the following values: 

{
	"secret": "somesecretkey",
	"user": "root",
	"endpoint": "https://localhost"
}

func GetViper 

func GetViper() *Viper

GetViper gets the global Viper instance.

func New 

func New() *Viper

New returns an initialized Viper instance.

func NewWithOptions added in v1.7.11 

func NewWithOptions(opts ...Option) *Viper

NewWithOptions creates a new Viper instance.

func Sub 

func Sub(key string) *Viper

Sub returns new Viper instance representing a sub tree of this instance. Sub is case-insensitive for a key.

func (*Viper) AddConfigPath 

func (v *Viper) AddConfigPath(in string)

func (*Viper) AddRemoteProvider 

func (v *Viper) AddRemoteProvider(provider, endpoint, path string) error

func (*Viper) AddSecureRemoteProvider 

func (v *Viper) AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error

func (*Viper) AllKeys 

func (v *Viper) AllKeys() []string

func (*Viper) AllSettings 

func (v *Viper) AllSettings() map[string]interface{}

func (*Viper) AllowEmptyEnv added in v1.7.11 

func (v *Viper) AllowEmptyEnv(allowEmptyEnv bool)

func (*Viper) AutomaticEnv 

func (v *Viper) AutomaticEnv()

func (*Viper) BindEnv 

func (v *Viper) BindEnv(input ...string) error

func (*Viper) BindFlagValue 

func (v *Viper) BindFlagValue(key string, flag FlagValue) error

func (*Viper) BindFlagValues 

func (v *Viper) BindFlagValues(flags FlagValueSet) (err error)

func (*Viper) BindPFlag 

func (v *Viper) BindPFlag(key string, flag *pflag.Flag) error

func (*Viper) BindPFlags 

func (v *Viper) BindPFlags(flags *pflag.FlagSet) error

func (*Viper) ConfigFileUsed 

func (v *Viper) ConfigFileUsed() string

func (*Viper) Debug 

func (v *Viper) Debug()

func (*Viper) Get 

func (v *Viper) Get(key string) interface{}

func (*Viper) GetBool 

func (v *Viper) GetBool(key string) bool

func (*Viper) GetDuration 

func (v *Viper) GetDuration(key string) time.Duration

func (*Viper) GetFloat64 

func (v *Viper) GetFloat64(key string) float64

func (*Viper) GetInt 

func (v *Viper) GetInt(key string) int

func (*Viper) GetInt32 added in v1.1.0 

func (v *Viper) GetInt32(key string) int32

func (*Viper) GetInt64 

func (v *Viper) GetInt64(key string) int64

func (*Viper) GetIntSlice added in v1.7.11 

func (v *Viper) GetIntSlice(key string) []int

func (*Viper) GetSizeInBytes 

func (v *Viper) GetSizeInBytes(key string) uint

func (*Viper) GetString 

func (v *Viper) GetString(key string) string

func (*Viper) GetStringMap 

func (v *Viper) GetStringMap(key string) map[string]interface{}

func (*Viper) GetStringMapString 

func (v *Viper) GetStringMapString(key string) map[string]string

func (*Viper) GetStringMapStringSlice 

func (v *Viper) GetStringMapStringSlice(key string) map[string][]string

func (*Viper) GetStringSlice 

func (v *Viper) GetStringSlice(key string) []string

func (*Viper) GetTime 

func (v *Viper) GetTime(key string) time.Time

func (*Viper) GetUint added in v1.7.11 

func (v *Viper) GetUint(key string) uint

func (*Viper) GetUint32 added in v1.7.11 

func (v *Viper) GetUint32(key string) uint32

func (*Viper) GetUint64 added in v1.7.11 

func (v *Viper) GetUint64(key string) uint64

func (*Viper) InConfig 

func (v *Viper) InConfig(key string) bool

func (*Viper) IsSet 

func (v *Viper) IsSet(key string) bool

func (*Viper) MergeConfig 

func (v *Viper) MergeConfig(in io.Reader) error

func (*Viper) MergeConfigMap added in v1.7.11 

func (v *Viper) MergeConfigMap(cfg map[string]interface{}) error

func (*Viper) MergeInConfig 

func (v *Viper) MergeInConfig() error

func (*Viper) OnConfigChange 

func (v *Viper) OnConfigChange(run func(in fsnotify.Event))

func (*Viper) OnWatcherConfigChange added in v1.7.11 

func (v *Viper) OnWatcherConfigChange(run func(in watcher.Event))

func (*Viper) ReadConfig 

func (v *Viper) ReadConfig(in io.Reader) error

func (*Viper) ReadInConfig 

func (v *Viper) ReadInConfig() error

func (*Viper) ReadRemoteConfig 

func (v *Viper) ReadRemoteConfig() error

func (*Viper) RegisterAlias 

func (v *Viper) RegisterAlias(alias string, key string)

func (*Viper) SafeWriteConfig added in v1.0.1 

func (v *Viper) SafeWriteConfig() error

func (*Viper) SafeWriteConfigAs added in v1.0.1 

func (v *Viper) SafeWriteConfigAs(filename string) error

func (*Viper) Set 

func (v *Viper) Set(key string, value interface{})

func (*Viper) SetConfigFile 

func (v *Viper) SetConfigFile(in string)

func (*Viper) SetConfigName 

func (v *Viper) SetConfigName(in string)

func (*Viper) SetConfigPermissions added in v1.7.11 

func (v *Viper) SetConfigPermissions(perm os.FileMode)

func (*Viper) SetConfigType 

func (v *Viper) SetConfigType(in string)

func (*Viper) SetDefault 

func (v *Viper) SetDefault(key string, value interface{})

func (*Viper) SetEnvKeyReplacer 

func (v *Viper) SetEnvKeyReplacer(r *strings.Replacer)

func (*Viper) SetEnvPrefix 

func (v *Viper) SetEnvPrefix(in string)

func (*Viper) SetFs 

func (v *Viper) SetFs(fs afero.Fs)

func (*Viper) SetTypeByDefaultValue 

func (v *Viper) SetTypeByDefaultValue(enable bool)

func (*Viper) Sub 

func (v *Viper) Sub(key string) *Viper

func (*Viper) Unmarshal 

func (v *Viper) Unmarshal(rawVal interface{}, opts ...DecoderConfigOption) error

func (*Viper) UnmarshalExact 

func (v *Viper) UnmarshalExact(rawVal interface{}, opts ...DecoderConfigOption) error

func (*Viper) UnmarshalKey 

func (v *Viper) UnmarshalKey(key string, rawVal interface{}, opts ...DecoderConfigOption) error

func (*Viper) WatchConfig 

func (v *Viper) WatchConfig()

func (*Viper) WatchRemoteConfig 

func (v *Viper) WatchRemoteConfig() error

func (*Viper) WatchRemoteConfigOnChannel 

func (v *Viper) WatchRemoteConfigOnChannel() error

func (*Viper) WatcherConfig added in v1.7.11 

func (v *Viper) WatcherConfig()

func (*Viper) WriteConfig added in v1.0.1 

func (v *Viper) WriteConfig() error

func (*Viper) WriteConfigAs added in v1.0.1 

func (v *Viper) WriteConfigAs(filename string) error

Source Files

View all Source files

Directories

Path Synopsis
internal
testutil
Package remote integrates the remote features of Viper.
 Package remote integrates the remote features of Viper.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.