singleton

Documentation

Index

• func GetCustomCallerEncoder(caller zapcore.EntryCaller, enc zapcore.PrimitiveArrayEncoder)
• func GetCustomTimeEncoder(prefix string) zapcore.TimeEncoder
• func GetEncodeLevel(c *zapcore.EncoderConfig, level string)
• func GetEncoderConfig(options ZapOptions) (config zapcore.EncoderConfig)
• type Option
  • func WithPGSQL(options PGSQLOptions) Option
  • func WithRedisClient(options *redis.Options) Option
  • func WithViper(options ViperOptions) Option
  • func WithZapLogger(options ZapOptions) Option
• type PGSQLOptions
• type Singleton
  • func (s *Singleton) AddPlugin(opts ...Option) (err error)
• type ViperOptions
• type ZapOptions

Functions

func GetCustomCallerEncoder

func GetCustomCallerEncoder(caller zapcore.EntryCaller, enc zapcore.PrimitiveArrayEncoder)

func GetCustomTimeEncoder

func GetCustomTimeEncoder(prefix string) zapcore.TimeEncoder

func GetEncodeLevel

func GetEncodeLevel(c *zapcore.EncoderConfig, level string)

Set logger encode level based on config

func GetEncoderConfig

func GetEncoderConfig(options ZapOptions) (config zapcore.EncoderConfig)

Types

type Option

type Option func(*Singleton) error

func WithPGSQL

func WithPGSQL(options PGSQLOptions) Option

func WithRedisClient

func WithRedisClient(options *redis.Options) Option

func WithViper

func WithViper(options ViperOptions) Option

func WithZapLogger

func WithZapLogger(options ZapOptions) Option

type PGSQLOptions

type PGSQLOptions struct {
	Source          string
	MaxConns        int32
	MaxConnIdleTime time.Duration
}

type Singleton

type Singleton struct {
	Redis  *redis.Client
	Viper  *viper.Viper
	PGPool *pgxpool.Pool
	Logger *zap.Logger
}

func (*Singleton) AddPlugin

func (s *Singleton) AddPlugin(opts ...Option) (err error)

type ViperOptions

type ViperOptions struct {
	Path     string // path to look for the config file in, absolute path start with / and relative path start with .
	FileName string // name of config file (without extension)
	FileType string // REQUIRED if the config file does not have the extension in the name
	EnvName  string // Env to read from the config file
	Target   any
}

type ZapOptions

type ZapOptions struct {
	LogLevel          int    // -1-debug, 0-info, 1-warn, 2-error, 3-DPanic, 4-Panic, 5-Fatal
	Development       bool   // development mode
	DisableStacktrace bool   `default:"true"`    // DisableStacktrace completely disables automatic stacktrace capturing. By default, stacktraces are captured for WarnLevel and above logs in development and ErrorLevel and above in production.
	EncodingFormat    string `default:"console"` // json or console
	Prefix            string
	EncodeLevel       string
	ServiceName       string
	OutputPath        []string
}