config

Documentation

Index

• Variables
• func File() string
• func FileFromEnv(env string) string
• func MarshalToBytes(cfg Map) ([]byte, error)
• func ReadFile() ([]byte, error)
• func ReadFileFromEnv(env string) ([]byte, error)
• func UnmarshalFromBytes(bytes []byte, cfg Map) error
• func UnmarshalFromFile(cfg Configurator) error
• func Watch(params WatchParams) error
• func WriteFileToEnv(env string, data []byte) error
• type Config
  • func (cfg *Config) Auth0Config() *auth0.Config
  • func (cfg *Config) GRPCConfig() *grpc.Config
  • func (cfg *Config) HTTPConfig() *http.Config
  • func (cfg *Config) NSQConfig() *nsq.Config
  • func (cfg *Config) OpentracingConfig() *opentracing.Config
  • func (cfg *Config) PGConfig() *pg.Config
  • func (cfg *Config) RedisConfig() *redis.Config
  • func (cfg *Config) RistrettoConfig() *ristretto.Config
  • func (cfg *Config) TransportConfig() *transport.Config
• type Configurator
  • func NewConfigurator() Configurator
• type Map
  • func (m Map) Map(key string) Map
• type WaitTime
  • func NewWaitTime() WaitTime
• type WatchParams
• type Watcher
  • func NewWatcher(params WatchParams) *Watcher
  • func (w *Watcher) Start() error
  • func (w *Watcher) Stop() error

Variables

var (
	// Module for fx.
	Module = fx.Options(ConfiguratorModule, UnmarshalModule, ConfigModule, WatchModule)

	// ConfiguratorModule for fx.
	ConfiguratorModule = fx.Provide(NewConfigurator)

	// UnmarshalModule for fx.
	UnmarshalModule = fx.Invoke(UnmarshalFromFile)

	// WatchModule for fx.
	WatchModule = fx.Options(
		fx.Invoke(Watch),
		fx.Provide(NewWaitTime),
	)

	// ConfigModule for fx.
	ConfigModule = fx.Options(
		fx.Provide(redisConfig), fx.Provide(ristrettoConfig),
		fx.Provide(auth0Config),
		fx.Provide(pgConfig),
		fx.Provide(opentracingConfig),
		fx.Provide(transportConfig),
		fx.Provide(grpcConfig),
		fx.Provide(httpConfig),
		fx.Provide(nsqConfig),
	)
)

Functions

func File

func File() string

File config location.

func FileFromEnv

func FileFromEnv(env string) string

FileFromEnv location.

func MarshalToBytes

func MarshalToBytes(cfg Map) ([]byte, error)

MarshalToBytes the map.

func ReadFile

func ReadFile() ([]byte, error)

ReadFile from config location.

func ReadFileFromEnv

func ReadFileFromEnv(env string) ([]byte, error)

ReadFileFromEnv variable of config location.

func UnmarshalFromBytes

func UnmarshalFromBytes(bytes []byte, cfg Map) error

UnmarshalFromBytes to map.

func UnmarshalFromFile

func UnmarshalFromFile(cfg Configurator) error

UnmarshalFromFile to config.

func Watch

func Watch(params WatchParams) error

Watch the configuration. If it changes terminate the application.

func WriteFileToEnv

func WriteFileToEnv(env string, data []byte) error

WriteFileToEnv location.

Types

type Config

type Config struct {
	Cache     cache.Config     `yaml:"cache"`
	Security  security.Config  `yaml:"security"`
	SQL       sql.Config       `yaml:"sql"`
	Trace     trace.Config     `yaml:"trace"`
	Transport transport.Config `yaml:"transport"`
}

Config for the service.

func (*Config) Auth0Config

func (cfg *Config) Auth0Config() *auth0.Config

func (*Config) GRPCConfig

func (cfg *Config) GRPCConfig() *grpc.Config

func (*Config) HTTPConfig

func (cfg *Config) HTTPConfig() *http.Config

func (*Config) NSQConfig

func (cfg *Config) NSQConfig() *nsq.Config

func (*Config) OpentracingConfig

func (cfg *Config) OpentracingConfig() *opentracing.Config

func (*Config) PGConfig

func (cfg *Config) PGConfig() *pg.Config

func (*Config) RedisConfig

func (cfg *Config) RedisConfig() *redis.Config

func (*Config) RistrettoConfig

func (cfg *Config) RistrettoConfig() *ristretto.Config

func (*Config) TransportConfig

func (cfg *Config) TransportConfig() *transport.Config

type Configurator

type Configurator interface {
	RedisConfig() *redis.Config
	RistrettoConfig() *ristretto.Config
	Auth0Config() *auth0.Config
	PGConfig() *pg.Config
	OpentracingConfig() *opentracing.Config
	TransportConfig() *transport.Config
	GRPCConfig() *grpc.Config
	HTTPConfig() *http.Config
	NSQConfig() *nsq.Config
}

Configurator for config.

func NewConfigurator

func NewConfigurator() Configurator

NewConfigurator for config.

type Map

type Map map[string]any

Map for config.

func (Map) Map

func (m Map) Map(key string) Map

Map at the key.

type WaitTime

type WaitTime time.Duration

WaitTime for shutting down.

func NewWaitTime

func NewWaitTime() WaitTime

NewWaitTime for shutting down.

type WatchParams

type WatchParams struct {
	fx.In

	Lifecycle  fx.Lifecycle
	Shutdowner fx.Shutdowner
	Logger     *zap.Logger
	WaitTime   WaitTime
	Config     Configurator
}

WatchParams for config.

type Watcher

type Watcher struct {
	// contains filtered or unexported fields
}

Watcher of config changes.

func NewWatcher

func NewWatcher(params WatchParams) *Watcher

NewWatcher of config changes.

func (*Watcher) Start

func (w *Watcher) Start() error

Start watching.

func (*Watcher) Stop

func (w *Watcher) Stop() error

Stop watching.