config

Documentation

Index

• Variables
• func Get(path, file, env, configType string, cfg interface{}) error
• func GetCustomForDefaultPath(configType string, cfg interface{}) error
• func GetWithAbsolutePath(path, file, configType string, cfg interface{}, notifier Notify) error
• func LookupEnvOrDefault(key string, defaultVal string) string
• type DefaultConfig
  • func GetDefault() (DefaultConfig, error)
• type GRPC
• type GRPCClient
• type HTTP
• type Kafka
• type MaskedString
  • func (s MaskedString) MarshalJSON() ([]byte, error)
  • func (s MaskedString) String() string
  • func (s MaskedString) Unmask() string
• type Metrics
• type NOSQLDB
• type Notify
• type SQLDB
• type Service
• type Tracing

Variables

var Environments = map[string]string{
	"local":      "local",
	"staging":    "staging",
	"production": "production",
}

Functions

func Get

func Get(path, file, env, configType string, cfg interface{}) error

func GetCustomForDefaultPath

func GetCustomForDefaultPath(configType string, cfg interface{}) error

func GetWithAbsolutePath

func GetWithAbsolutePath(path, file, configType string, cfg interface{}, notifier Notify) error

func LookupEnvOrDefault

func LookupEnvOrDefault(key string, defaultVal string) string

Types

type DefaultConfig

type DefaultConfig struct {
	Service Service
	HTTP    HTTP
	GRPC    GRPC
	Tracing Tracing
	Metrics Metrics
	SqlDB   SQLDB
	NoSqlDB NOSQLDB
}

func GetDefault

func GetDefault() (DefaultConfig, error)

type GRPC

type GRPC struct {
	Host            string
	Port            string
	ReadTimeout     time.Duration
	WriteTimeout    time.Duration
	ShutdownTimeout time.Duration
}

type GRPCClient

type GRPCClient struct {
	Host     string
	Port     string
	TLS      bool
	Insecure bool
}

type HTTP

type HTTP struct {
	Host            string
	Port            string
	ReadTimeout     time.Duration
	WriteTimeout    time.Duration
	ShutdownTimeout time.Duration
}

type Kafka

type Kafka struct {
	TopicPrefix string
	Broker      string
	Key         MaskedString
	Secret      MaskedString
}

type MaskedString

type MaskedString string

func (MaskedString) MarshalJSON

func (s MaskedString) MarshalJSON() ([]byte, error)

func (MaskedString) String

func (s MaskedString) String() string

String implements the fmt.Stringer interface.

func (MaskedString) Unmask

func (s MaskedString) Unmask() string

type Metrics

type Metrics struct {
	Name     string
	Endpoint string
	Port     string
}

type NOSQLDB

type NOSQLDB struct {
	User     string
	Password MaskedString
	Scheme   string // `mongodb://` or `mongodb+srv://`
	Host     string
	Port     string
	Database string
}

type Notify

type Notify func(description string)

type SQLDB

type SQLDB struct {
	User     string
	Password MaskedString
	Host     string
	Port     string
	Database string
}

type Service

type Service struct {
	Name           string
	SandboxEnabled bool
	TracingEnabled bool
}

type Tracing

type Tracing struct {
	Name     string
	Endpoint string
	Port     string
}