Categorygo-micro.dev/v5config
package
5.3.0
Repository: https://github.com/micro/go-micro.git
Documentation: pkg.go.dev
Versions
2
Dependencies
11
Dependents
2
Files
421 SLOC

# README

Config GoDoc

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.

# Packages

Package encoder handles source encoding formats.
Package loader manages loading from multiple sources.
Package reader parses change sets and provides config values.
Package secrets is an interface for encrypting and decrypting secrets.
Package source is the interface for sources.

# Functions

Return config as raw json.
Get a value from the config.
Load config sources.
LoadFile is short hand for creating a file source and loading it.
Return config as a map.
NewConfig returns new config.
Scan values to a go type.
Force a source changeset sync.
Watch a value for changes.
WithLoader sets the loader for manager config.
WithReader sets the config reader.
WithSource appends a source to list of sources.

# Variables

Default Config Manager.

# Structs

# Interfaces

Config is an interface abstraction for dynamic configuration.
Watcher is the config watcher.

# Type aliases