viperx

Documentation

Index

• Variables
• func AddWatcher(f func(event fsnotify.Event) error)
• func BindEnvsToSchema(schema json.RawMessage) error
• func GetBool(l *logrusx.Logger, key string, fallback bool, deprecated ...string) bool
• func GetDuration(l *logrusx.Logger, key string, fallback time.Duration, deprecated ...string) time.Duration
• func GetFloat64(l *logrusx.Logger, key string, fallback float64, deprecated ...string) float64
• func GetInt(l *logrusx.Logger, key string, fallback int, deprecated ...string) int
• func GetString(l *logrusx.Logger, key string, fallback string, deprecated ...string) string
• func GetStringMapConfig(paths ...string) map[string]interface{}
• func GetStringSlice(l *logrusx.Logger, key string, fallback []string, deprecated ...string) []string
• func InitializeConfig(applicationName string, homeOverride string, l *logrusx.Logger) *logrusx.Logger
• func PrintHumanReadableValidationErrors(w io.Writer, err error)
• func RegisterConfigFlag(c *cobra.Command, applicationName string)
• func ResetWatchers()
• func UnmarshalKey(key string, destination interface{}) error
• func Validate(name string, content []byte) error
• func ValidateFromURL(url string) error
• func WatchAndValidateViper(l *logrusx.Logger, schema []byte, productName string, immutables []string, ...)
• func WatchConfig(l *logrusx.Logger, o *WatchOptions)
• type WatchOptions

Variables

var ErrRollbackConfigurationChanges = errors.New("an error occurred and configuration changes should be reverted")

ErrRollbackConfigurationChanges should be used when a configuration is e.g. invalid and should be rolled back.

Functions

func AddWatcher

func AddWatcher(f func(event fsnotify.Event) error)

AddWatcher adds a function callback to viper.OnConfigChange().

func BindEnvsToSchema

func BindEnvsToSchema(schema json.RawMessage) error

BindEnvsToSchema uses all keys it can find from “

func GetBool

func GetBool(l *logrusx.Logger, key string, fallback bool, deprecated ...string) bool

GetBool returns a bool from viper config or false.

func GetDuration

func GetDuration(l *logrusx.Logger, key string, fallback time.Duration, deprecated ...string) time.Duration

GetDuration returns a duration from viper config or the fallback value.

func GetFloat64

func GetFloat64(l *logrusx.Logger, key string, fallback float64, deprecated ...string) float64

GetFloat64 returns a float64 value from viper config or the fallback value.

func GetInt

func GetInt(l *logrusx.Logger, key string, fallback int, deprecated ...string) int

GetInt returns an int value from viper config or the fallback value.

func GetString

func GetString(l *logrusx.Logger, key string, fallback string, deprecated ...string) string

GetString returns a string from viper config or the fallback value.

func GetStringMapConfig

func GetStringMapConfig(paths ...string) map[string]interface{}

GetStringMapConfig returns a string map using all settings which will lookup env vars

func GetStringSlice

func GetStringSlice(l *logrusx.Logger, key string, fallback []string, deprecated ...string) []string

GetStringSlice returns a string slice from viper config or the fallback value.

func InitializeConfig

func InitializeConfig(applicationName string, homeOverride string, l *logrusx.Logger) *logrusx.Logger

InitializeConfig initializes viper.

func PrintHumanReadableValidationErrors

func PrintHumanReadableValidationErrors(w io.Writer, err error)

PrintHumanReadableValidationErrors prints human readable validation errors. Duh.

func RegisterConfigFlag

func RegisterConfigFlag(c *cobra.Command, applicationName string)

RegisterConfigFlag registers the --config / -c flag.

func ResetWatchers

func ResetWatchers()

ResetWatchers resets all the watchers.

func UnmarshalKey

func UnmarshalKey(key string, destination interface{}) error

UnmarshalKey unmarshals a viper key into the destination struct. The destination struct must be JSON-compatible (i.e. have `json` struct tags)

func Validate

func Validate(name string, content []byte) error

Validate validates the viper config

If env vars are supported, they must be bound using viper.BindEnv.

func ValidateFromURL

func ValidateFromURL(url string) error

ValidateFromURL validates the viper config by loading the schema from a URL

Uses Validate internally.

func WatchAndValidateViper

func WatchAndValidateViper(l *logrusx.Logger, schema []byte, productName string, immutables []string, sensitiveDumpConfigDir string)

func WatchConfig

func WatchConfig(l *logrusx.Logger, o *WatchOptions)

WatchConfig is a helper makes watching configuration files easy.

Types

type WatchOptions

type WatchOptions struct {
	// Immutables are keys that cause OnImmutableChange to be fired when modified.
	Immutables []string
	// OnImmutableChange - see Immutables.
	OnImmutableChange func(key string)
}

WatchOptions configures WatchConfig.