config

Documentation

Index

• Variables
• func File() (string, error)
• func FileFromEnv(env string) (string, error)
• func MarshalToBytes(cfg Map) ([]byte, error)
• func ReadFile() ([]byte, error)
• func UnmarshalFromBytes(bytes []byte, cfg Map) error
• func UnmarshalFromFile(cfg Configurator) error
• func WriteFileToEnv(env string, data []byte) error
• type Config
  • func (cfg *Config) Auth0Config() *auth0.Config
  • func (cfg *Config) DatadogConfig() *datadog.Config
  • func (cfg *Config) GRPCConfig() *grpc.Config
  • func (cfg *Config) HTTPConfig() *http.Config
  • func (cfg *Config) JaegerConfig() *jaeger.Config
  • func (cfg *Config) NSQConfig() *nsq.Config
  • func (cfg *Config) PGConfig() *pg.Config
  • func (cfg *Config) RedisConfig() *redis.Config
  • func (cfg *Config) RistrettoConfig() *ristretto.Config
• type Configurator
  • func NewConfigurator() Configurator
• type Map
  • func (m Map) Map(key string) Map

Variables

var (
	// Module for fx.
	// nolint:gochecknoglobals
	Module = fx.Options(ConfiguratorModule, UnmarshalModule, ConfigModule)

	// ConfiguratorModule for fx.
	// nolint:gochecknoglobals
	ConfiguratorModule = fx.Provide(NewConfigurator)

	// UnmarshalModule for fx.
	// nolint:gochecknoglobals
	UnmarshalModule = fx.Invoke(UnmarshalFromFile)

	// ConfigModule for fx.
	// nolint:gochecknoglobals
	ConfigModule = fx.Options(
		fx.Provide(redisConfig), fx.Provide(ristrettoConfig),
		fx.Provide(auth0Config),
		fx.Provide(pgConfig),
		fx.Provide(datadogConfig), fx.Provide(jaegerConfig),
		fx.Provide(grpcConfig), fx.Provide(httpConfig), fx.Provide(nsqConfig),
	)
)

var ErrMissingConfigFile = errors.New("missing config file")

ErrMissingConfigFile for config.

Functions

func File

func File() (string, error)

File config location.

func FileFromEnv

func FileFromEnv(env string) (string, error)

FileFromEnv location.

func MarshalToBytes

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

MarshalToBytes the map.

func ReadFile

func ReadFile() ([]byte, error)

ReadFile from 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 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) DatadogConfig

func (cfg *Config) DatadogConfig() *datadog.Config

func (*Config) GRPCConfig

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

func (*Config) HTTPConfig

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

func (*Config) JaegerConfig

func (cfg *Config) JaegerConfig() *jaeger.Config

func (*Config) NSQConfig

func (cfg *Config) NSQConfig() *nsq.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

type Configurator

type Configurator interface {
	RedisConfig() *redis.Config
	RistrettoConfig() *ristretto.Config
	Auth0Config() *auth0.Config
	PGConfig() *pg.Config
	DatadogConfig() *datadog.Config
	JaegerConfig() *jaeger.Config
	GRPCConfig() *grpc.Config
	HTTPConfig() *http.Config
	NSQConfig() *nsq.Config
}

Configurator for config.

func NewConfigurator

func NewConfigurator() Configurator

NewConfigurator for config. nolint:ireturn

type Map

type Map map[string]any

Map for config.

func (Map) Map

func (m Map) Map(key string) Map

Map at the key.