configs

package
v0.0.0-...-1f1dc5f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 30, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package configs loads and validates static application configuration.

Index

Constants

View Source 
const (
	// DefaultAppName is returned by /api/info when config omits app.name.
	DefaultAppName = "echo-admin"

	// EnvPrefix is the environment variable prefix used for config overrides.
	EnvPrefix = "ECHO_ADMIN"

	// DefaultAppVersion is returned by /api/info when config omits app.version.
	DefaultAppVersion = "dev"

	// DefaultPort is the HTTP port used when config omits system.port.
	DefaultPort = ":9322"

	// DefaultUploadDir stores local back-office uploads for development.
	DefaultUploadDir = "uploads"

	// LogFormatConsole writes human-readable zerolog console output.
	LogFormatConsole = "console"

	// LogFormatJSON writes structured zerolog JSON output.
	LogFormatJSON = "json"

	// LogOutputStdout writes logs to standard output.
	LogOutputStdout = "stdout"

	// LogOutputStderr writes logs to standard error.
	LogOutputStderr = "stderr"

	// DefaultCapabilityTimeoutSeconds is the default health-check timeout for
	// external resources.
	DefaultCapabilityTimeoutSeconds = 3

	// DefaultMySQLMaxOpenConns is the default upper bound for the MySQL pool.
	DefaultMySQLMaxOpenConns = 25

	// DefaultMySQLMaxIdleConns is the default idle connection count for MySQL.
	DefaultMySQLMaxIdleConns = 5

	// DefaultMySQLConnMaxLifetimeSeconds controls how long MySQL connections can be reused.
	DefaultMySQLConnMaxLifetimeSeconds = 300

	// DefaultMySQLPort is the conventional TCP port used by MySQL.
	DefaultMySQLPort = 3306

	// DefaultRedisDB is the default logical Redis database.
	DefaultRedisDB = 0

	// DefaultTracingProtocol is the OTLP transport used by default.
	DefaultTracingProtocol = "grpc"

	// DefaultTracingShutdownTimeoutSeconds bounds provider flush during shutdown.
	DefaultTracingShutdownTimeoutSeconds = 5
)

Variables

This section is empty.

Functions

func Validate 

func Validate(cfg Config) error

Validate checks cross-field configuration rules that must fail before the HTTP runtime starts.

Types

type AdminConfig 

type AdminConfig struct {
	UploadDir string `mapstructure:"upload_dir"`
}

AdminConfig controls back-office runtime behavior.

type AppConfig 

type AppConfig struct {
	Name    string `mapstructure:"name"`
	Version string `mapstructure:"version"`
}

AppConfig controls process identity exposed by system routes.

type CORSConfig 

type CORSConfig struct {
	Enabled          bool     `mapstructure:"enabled"`
	AllowOrigins     []string `mapstructure:"allow_origins"`
	AllowMethods     []string `mapstructure:"allow_methods"`
	AllowHeaders     []string `mapstructure:"allow_headers"`
	AllowCredentials bool     `mapstructure:"allow_credentials"`
	ExposeHeaders    []string `mapstructure:"expose_headers"`
	MaxAgeSeconds    int      `mapstructure:"max_age_seconds"`
}

CORSConfig controls optional CORS middleware.

type Config 

type Config struct {
	App     AppConfig     `mapstructure:"app"`
	System  SystemConfig  `mapstructure:"system"`
	Log     LogConfig     `mapstructure:"log"`
	HTTP    HTTPConfig    `mapstructure:"http"`
	Admin   AdminConfig   `mapstructure:"admin"`
	MySQL   MySQLConfig   `mapstructure:"mysql"`
	Redis   RedisConfig   `mapstructure:"redis"`
	MongoDB MongoDBConfig `mapstructure:"mongodb"`
	Tracing TracingConfig `mapstructure:"tracing"`
}

Config is the complete application configuration loaded at startup.

func Load 

func Load(path string) (Config, error)

Load reads a static application config file and applies supported environment variable overrides.

func Normalize 

func Normalize(cfg Config) Config

Normalize applies application config defaults.

type HTTPConfig 

type HTTPConfig struct {
	RecoveryDisabled       bool       `mapstructure:"recovery_disabled"`
	RequestContextDisabled bool       `mapstructure:"request_context_disabled"`
	RequestLogDisabled     bool       `mapstructure:"request_log_disabled"`
	GzipDisabled           bool       `mapstructure:"gzip_disabled"`
	SecureCookies          bool       `mapstructure:"secure_cookies"`
	CORS                   CORSConfig `mapstructure:"cors"`
}

HTTPConfig controls server-owned HTTP middleware.

type Level 

type Level int8

Level identifies the runtime logging and debug mode. 

const (
	// DebugLevel logs are typically voluminous, and are usually disabled in
	// production.
	DebugLevel Level = iota + 1
	// OnlineLevel is the default production priority.
	OnlineLevel
)

type LogConfig 

type LogConfig struct {
	Format string `mapstructure:"format"`
	Output string `mapstructure:"output"`
	Caller bool   `mapstructure:"caller"`
}

LogConfig controls process-level structured logging.

type MongoDBConfig 

type MongoDBConfig struct {
	Enabled               bool   `mapstructure:"enabled"`
	URI                   string `mapstructure:"uri"`
	Database              string `mapstructure:"database"`
	ConnectTimeoutSeconds int    `mapstructure:"connect_timeout_seconds"`
	PingTimeoutSeconds    int    `mapstructure:"ping_timeout_seconds"`
}

MongoDBConfig controls the optional process-level MongoDB resource.

type MySQLConfig 

type MySQLConfig struct {
	Enabled                bool   `mapstructure:"enabled"`
	Host                   string `mapstructure:"host"`
	Port                   int    `mapstructure:"port"`
	Database               string `mapstructure:"database"`
	Username               string `mapstructure:"username"`
	Password               string `mapstructure:"password"`
	MaxOpenConns           int    `mapstructure:"max_open_conns"`
	MaxIdleConns           int    `mapstructure:"max_idle_conns"`
	ConnMaxLifetimeSeconds int    `mapstructure:"conn_max_lifetime_seconds"`
	PingTimeoutSeconds     int    `mapstructure:"ping_timeout_seconds"`
}

MySQLConfig controls the optional process-level MySQL resource.

type RedisConfig 

type RedisConfig struct {
	Enabled             bool   `mapstructure:"enabled"`
	Address             string `mapstructure:"address"`
	Username            string `mapstructure:"username"`
	Password            string `mapstructure:"password"`
	DB                  int    `mapstructure:"db"`
	DialTimeoutSeconds  int    `mapstructure:"dial_timeout_seconds"`
	ReadTimeoutSeconds  int    `mapstructure:"read_timeout_seconds"`
	WriteTimeoutSeconds int    `mapstructure:"write_timeout_seconds"`
	PingTimeoutSeconds  int    `mapstructure:"ping_timeout_seconds"`
}

RedisConfig controls the optional process-level Redis resource.

type SystemConfig 

type SystemConfig struct {
	Port  string `mapstructure:"port"`
	Level Level  `mapstructure:"level"`
}

SystemConfig controls process-level runtime settings.

type TracingConfig 

type TracingConfig struct {
	Enabled                bool    `mapstructure:"enabled"`
	Endpoint               string  `mapstructure:"endpoint"`
	Protocol               string  `mapstructure:"protocol"`
	Insecure               bool    `mapstructure:"insecure"`
	ServiceName            string  `mapstructure:"service_name"`
	SampleRatio            float64 `mapstructure:"sample_ratio"`
	ShutdownTimeoutSeconds int     `mapstructure:"shutdown_timeout_seconds"`
}

TracingConfig controls optional OpenTelemetry export to Jaeger OTLP.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.