config

Documentation

Overview

Package config implements logic to load dynamic configuration from various sources It also defines environment specific configuration (dev, prod, ...)

Index

• func Adapters() []string
• func NewStore(configStoreURI string) (store.Store, error)
• func Register(name string, adapter store.Adapter)
• func ValueOf(s string) string
• type AdapterConfig
• type Config
• type Log
• type Request
  • func (r *Request) Timeout() time.Duration
• type Stats

Functions

func Adapters

func Adapters() []string

Adapters returns the list of registered adapters

func NewStore

func NewStore(configStoreURI string) (store.Store, error)

NewStore returns a loaded config store defined by the ConfigStorage env

func Register

func Register(name string, adapter store.Adapter)

Register makes a store adapter available by the provided name. If an adapter is registered twice or if an adapter is nil, it will panic.

func ValueOf

func ValueOf(s string) string

ValueOf extracts the environment variable name given or the plain string given

e.g. foo -> foo

$DATABASE_URL -> http://foo.bar:8083

Types

type AdapterConfig

type AdapterConfig struct {
	Adapter string            `json:"adapter"`
	Config  map[string]string `json:"config"`
}

AdapterConfig is a generic config struct for adapters

type Config

type Config struct {
	Node    string      `json:"node"`
	Version string      `json:"version"`
	Request Request     `json:"request"`
	Log     Log         `json:"log"`
	Stats   Stats       `json:"stats"`
	App     interface{} `json:"app"`
}

Config defines the app config

type Log

type Log struct {
	Level     string        `json:"level"`
	Formatter AdapterConfig `json:"formatter"`
	Printer   AdapterConfig `json:"printer"`
}

Log contains all log-related configuration

type Request

type Request struct {
	TimeoutMS    time.Duration `json:"timeout_ms"`
	AllowContext bool          `json:"allow_context"`
	Panic        bool          `json:"panic"`
}

Request defines the request default configuration

func (*Request) Timeout

func (r *Request) Timeout() time.Duration

Timeout returns the TimeoutMS field in time.Duration

type Stats

type Stats struct {
	On      bool              `json:"on"`
	Adapter string            `json:"adapter"`
	Config  map[string]string `json:"config"`
}

Stats contains all stats-related configuration