config

Documentation

Index

• Constants
• type Config
  • func Get() (*Config, error)
• type LogConfig
• type MemoryWatcherConfig

Constants

const (
	ErrInvalidPort = "invalid port value"
	ErrValidation  = "validation error"
)

const (
	EnvPrefix = "BW_"
)

const (
	ErrNoSuchFileOrDirectory = "open .*: no such file or directory"
)

Types

type Config

type Config struct {
	// Port with api server is listen
	Port int `koanf:"port" validate:"gt=0,lte=65535"`
	// Host name, using for listening
	Host string `koanf:"host" validate:"required"`
	// Logger configuration
	Logging LogConfig `koanf:"logging" validate:"required"`
	// Memory wather configuration
	Memory MemoryWatcherConfig `koanf:"memory" validate:"required"`
}

Server configuration.

func Get

func Get() (*Config, error)

Return configuration struct, if initialized, else - try to initialize and return configuration struct or error if it fails.

type LogConfig

type LogConfig struct {
	// Restrict logger print output to console
	Verbose bool `koanf:"verbose"`
	// Logging level
	Level string `koanf:"level" validate:"required"`
	// File to logging output
	File string `koanf:"file" validate:"required"`
}

Logger configuration.

type MemoryWatcherConfig

type MemoryWatcherConfig struct {
	// If false - disabling memory watcher
	Enabled bool `koanf:"enabled"`
	// Interval for scanning memory state
	ScanInterval time.Duration `koanf:"interval"`
}

Memory watcher configuration.