goapp

Documentation

Index

• Variables
• func Estimate(name string) func()
• func HidePass(link string) string
• func InitConfig(configFile string) error
• func InitEnv(config *viper.Viper)
• func InvokeWithBackoff[K any](ctx context.Context, f func() (K, bool, error), b backoff.BackOff) (K, error)
• func IsRetryableCode(c int) bool
• func IsRetryableErr(err error) bool
• func Sanitize(str string) string
• func StartWithDefault()
• func StartWithFlags(fs *flag.FlagSet, args []string)
• func Sub(config *viper.Viper, name string) *viper.Viper
• func ValidateHTTPResp(resp *http.Response, bodyLen int) error

Variables

var Config = viper.New()

Config is a viper based application config

var Log = log.Logger

Log is applications logger

Functions

func Estimate

func Estimate(name string) func()

Estimate estimates and logs execution duration sample: defer goapp.Estimate("function")()

func HidePass

func HidePass(link string) string

HidePass removes pass from URL

func InitConfig

func InitConfig(configFile string) error

InitConfig tries to load config.yml from exe's dir

func InitEnv

func InitEnv(config *viper.Viper)

InitEnv initializes viper for environment variables

func InvokeWithBackoff

func InvokeWithBackoff[K any](ctx context.Context, f func() (K, bool, error), b backoff.BackOff) (K, error)

InvokeWithBackoff func with backoff

func IsRetryableCode

func IsRetryableCode(c int) bool

IsRetryableCode returns true if status is a retryable HTTP code

func IsRetryableErr

func IsRetryableErr(err error) bool

IsRetryableErr check if err may be retryable

func Sanitize

func Sanitize(str string) string

Sanitize replaces new lines in str for logging

func StartWithDefault

func StartWithDefault()

StartWithDefault default app initialization function Tries to load config from commandline option '-c' panics on error

func StartWithFlags

func StartWithFlags(fs *flag.FlagSet, args []string)

StartWithFlags app initialization function with flagset panics on error

func Sub

func Sub(config *viper.Viper, name string) *viper.Viper

Sub extracts Sub config from viper using env variables

func ValidateHTTPResp

func ValidateHTTPResp(resp *http.Response, bodyLen int) error

ValidateHTTPResp returns error if code is not in [200, 299] bodyLen - size of bytes to try read body