def

Documentation

Overview

Package def provides default values for both commands and tests.

Index

• Constants
• Variables
• func FromContext(ctx Ctx) (remoteIP string)
• func Init() error
• func NewContext(service string) context.Context
• func NewGoose(service string) *goose.Instance
• func NewMySQLConfig(cfg MySQLConfig) *mysql.Config
• func Version() string
• type Ctx
  • func NewContextWithRemoteIP(ctx Ctx, remoteIP string) Ctx
• type Metrics
  • func NewMetrics(reg *prometheus.Registry) Metrics
• type MySQLConfig

Constants

const (
	LogServer = "server" // "OpenAPI", "gRPC", "Prometheus metrics", etc.
	LogRemote = "remote" // Aligned IPv4:Port "   192.168.0.42:1234 ".
	LogAddr   = "addr"   // host:port.
	LogHost   = "host"   // DNS hostname or IPv4/IPv6 address.
	LogPort   = "port"   // TCP/UDP port number.
	LogFunc   = "func"   // RPC/event handler method name, REST resource path.
	LogUserID = "userID"
)

Log field names.

Variables

var (
	ProgName    = strings.TrimSuffix(path.Base(os.Args[0]), ".test")
	Hostname, _ = os.Hostname()

	TestSecond  = time.Duration(float64(time.Second) * testTimeFactor)
	TestTimeout = 7 * TestSecond
)

Constants.

Functions

func FromContext

func FromContext(ctx Ctx) (remoteIP string)

FromContext returns all values which might be stored in context using NewContext* functions of this package.

func Init

func Init() error

Init must be called once before using this package. It provides common initialization for both commands and tests.

func NewContext

func NewContext(service string) context.Context

NewContext returns context.Background() which contains logger configured for given service.

func NewGoose

func NewGoose(service string) *goose.Instance

NewGoose creates a goose instance with configured logger.

func NewMySQLConfig

func NewMySQLConfig(cfg MySQLConfig) *mysql.Config

NewMySQLConfig creates a new default config for MySQL.

func Version

func Version() string

Version returns application version based on build info.

Types

type Ctx

type Ctx = context.Context

func NewContextWithRemoteIP

func NewContextWithRemoteIP(ctx Ctx, remoteIP string) Ctx

NewContextWithRemoteIP creates and returns new context containing given remoteIP.

type Metrics

type Metrics struct {
	PanicsTotal           prometheus.Counter
	MisconfigurationTotal prometheus.Counter
}

Metrics shared by all packages.

func NewMetrics

func NewMetrics(reg *prometheus.Registry) Metrics

NewMetrics registers and returns metrics shared by all packages.

type MySQLConfig

type MySQLConfig struct {
	Addr netx.Addr
	User string
	Pass string
	DB   string
}

MySQLConfig contains MySQL connection and authentication details.