setup

Documentation

Index

• Variables
• func InitSetup(appName string, opts ...OptionFunc) error
• func InitTelemetry(ctx context.Context, telemetryOpts ...telemetry.Option) error
• type OptionFunc
  • func WithConfigFileToBeUsed(file string) OptionFunc
  • func WithDefaultCfgFileLocations(f ...string) OptionFunc
  • func WithDefaultCfgFileName(f string) OptionFunc
  • func WithDefaultValues(vals map[string]any) OptionFunc
  • func WithEnvPrefix(prefix string) OptionFunc
  • func WithOpenTelemetryOptions(opts ...telemetry.Option) OptionFunc
• type Options
  • func (o *Options) GetDefaultCfgFileLocations(appName string) []string
  • func (o *Options) GetDefaultCfgFileName() string
  • func (o *Options) GetDefaultValues() map[string]any
  • func (o *Options) GetEnvPrefix() string

Variables

var (
	ErrTracesInitialization           = errors.New("initializing meter")
	ErrTracesConnectionInitialization = errors.New("initializing metrics connection")
	ErrTracesExporterInitialization   = errors.New("initializing metric exporter")
)

var (
	ErrMeterInitialization             = errors.New("initializing meter")
	ErrMetricsConnectionInitialization = errors.New("initializing metrics connection")
	ErrMetricsExporterInitialization   = errors.New("initializing metric exporter")
)

var (
	ErrEmptyAppName = errors.New("appName is empty")
)

var (
	ErrInvalidLogOutputConfig = errors.New("invalid log output configuration: should enable stdout or define an output file")
)

Functions

func InitSetup

func InitSetup(appName string, opts ...OptionFunc) error

InitSetup sets up application default configurations for spf13/viper and slog libraries

func InitTelemetry

func InitTelemetry(ctx context.Context, telemetryOpts ...telemetry.Option) error

InitTelemetry initializes telemetry configuration

Types

type OptionFunc

type OptionFunc func(*Options)

OptionFunc customization option

func WithConfigFileToBeUsed

func WithConfigFileToBeUsed(file string) OptionFunc

WithConfigFileToBeUsed defines the app configuration file to be used

func WithDefaultCfgFileLocations

func WithDefaultCfgFileLocations(f ...string) OptionFunc

WithDefaultCfgFileLocations defines locations to search for config files

func WithDefaultCfgFileName

func WithDefaultCfgFileName(f string) OptionFunc

WithDefaultCfgFileName defines default config file name

func WithDefaultValues

func WithDefaultValues(vals map[string]any) OptionFunc

WithDefaultValues adds default values to Viper configuration

Default configuration keys:

• Logs configuration
• Log level:
• Log format: `log.format` (accepts `text` or `json`)
• Log level: `log.level` (accepts `info`, `debug`, `warn` or `error`)
• Log output file: `log.output_to_file` (output file path as a string)
• Log to stdout: `log.output_to_stdout` (accepts `true` or `false`)

func WithEnvPrefix

func WithEnvPrefix(prefix string) OptionFunc

WithEnvPrefix defines the environment variable prefix to be used

func WithOpenTelemetryOptions

func WithOpenTelemetryOptions(opts ...telemetry.Option) OptionFunc

WithOpenTelemetryOptions sets OpenTelemetry options

type Options

type Options struct {
	DefaultValues           map[string]any
	CfgFilePathToBeUsed     string
	DefaultCfgFileName      string
	EnvPrefix               string
	OpenTelemetryOptions    []telemetry.Option
	DefaultCfgFileLocations []string
}

func (*Options) GetDefaultCfgFileLocations

func (o *Options) GetDefaultCfgFileLocations(appName string) []string

GetDefaultCfgFileLocations returns default config file locations

func (*Options) GetDefaultCfgFileName

func (o *Options) GetDefaultCfgFileName() string

GetDefaultCfgFileName returns default config file name

func (*Options) GetDefaultValues

func (o *Options) GetDefaultValues() map[string]any

func (*Options) GetEnvPrefix

func (o *Options) GetEnvPrefix() string