config

Documentation

Index

• Constants
• func Configure(v *viper.Viper, p *pflag.FlagSet)
• func ErrorHandler(logger log.Logger) emperror.Handler
• type Config
  • func (c Config) Validate() error

Constants

const (
	// ServiceName is an identifier-like name used anywhere this app needs to be identified.
	ServiceName = "hollowtrees"

	// FriendlyServiceName is the visible name of the service.
	FriendlyServiceName = "Hollowtrees"

	// ConfigEnvPrefix defines the prefix that ENVIRONMENT variables will use
	ConfigEnvPrefix = "HT"
)

Functions

func Configure

func Configure(v *viper.Viper, p *pflag.FlagSet)

Configure configures some defaults in the Viper instance

func ErrorHandler

func ErrorHandler(logger log.Logger) emperror.Handler

ErrorHandler returns an error handler.

Types

type Config

type Config struct {
	// Meaningful values are recommended (eg. production, development, staging, release/123, etc)
	Environment string

	// Turns on some debug functionality (eg. more verbose logs)
	Debug bool

	// Log configuration
	Log log.Config

	// Healthcheck configuration
	Healthcheck healthcheck.Config

	// Prometheus alert handler configuration
	Promalert promalert.Config
}

Config holds any kind of configuration that comes from the outside world and is necessary for running the application

func (Config) Validate

func (c Config) Validate() error

Validate validates the configuration