http_server and log config sections

Author: FZambia

internal/app/mux.go

@@ -358,10 +358,10 @@ func runHTTPServers(
 
 	apiDisabled := cfg.HttpAPI.Disabled
 
-	httpAddress := cfg.Address
-	httpPort := strconv.Itoa(cfg.Port)
-	httpInternalAddress := cfg.InternalAddress
-	httpInternalPort := cfg.InternalPort
+	httpAddress := cfg.HTTP.Address
+	httpPort := strconv.Itoa(cfg.HTTP.Port)
+	httpInternalAddress := cfg.HTTP.InternalAddress
+	httpInternalPort := cfg.HTTP.InternalPort
 
 	if httpInternalAddress == "" && httpAddress != "" {
 		// If custom internal address not explicitly set we try to reuse main
@@ -387,7 +387,7 @@ func runHTTPServers(
 		portFlags |= HandlerWebsocket
 	}
 	if cfg.WebTransport.Enabled {
-		if !cfg.HTTP3.Enabled {
+		if !cfg.HTTP.HTTP3.Enabled {
 			log.Fatal().Msg("can not enable webtransport without experimental HTTP/3")
 		}
 		portFlags |= HandlerWebtransport
@@ -448,8 +448,8 @@ func runHTTPServers(
 		log.Fatal().Err(err).Msg("can not get TLS config")
 	}
 	var internalTLSConfig *tls.Config
-	if cfg.InternalTLS.Enabled {
-		internalTLSConfig, err = cfg.InternalTLS.ToGoTLSConfig("internal_tls")
+	if cfg.HTTP.InternalTLS.Enabled {
+		internalTLSConfig, err = cfg.HTTP.InternalTLS.ToGoTLSConfig("internal_tls")
 		if err != nil {
 			log.Fatal().Err(err).Msg("can not get internal TLS config")
 		}
@@ -463,14 +463,14 @@ func runHTTPServers(
 			continue
 		}
 		var addrTLSConfig *tls.Config
-		if !cfg.TLSExternal || addr == externalAddr {
+		if !cfg.HTTP.TLSExternal || addr == externalAddr {
 			addrTLSConfig = tlsConfig
 		}
-		if addr != externalAddr && cfg.InternalTLS.Enabled {
+		if addr != externalAddr && cfg.HTTP.InternalTLS.Enabled {
 			addrTLSConfig = internalTLSConfig
 		}
 
-		useHTTP3 := cfg.HTTP3.Enabled && addr == externalAddr
+		useHTTP3 := cfg.HTTP.HTTP3.Enabled && addr == externalAddr
 
 		var wtServer *webtransport.Server
 		if useHTTP3 {
@@ -516,7 +516,7 @@ func runHTTPServers(
 				if addrTLSConfig == nil {
 					log.Fatal().Msg("HTTP/3 requires TLS configured")
 				}
-				if cfg.TLSAutocert.Enabled {
+				if cfg.HTTP.TLSAutocert.Enabled {
 					log.Fatal().Msg("can not use HTTP/3 with autocert")
 				}
 

internal/app/node.go

@@ -34,7 +34,7 @@ func centrifugeNodeConfig(version string, edition string, cfgContainer *config.C
 	cfg.RecoveryMaxPublicationLimit = appCfg.Client.RecoveryMaxPublicationLimit
 	cfg.HistoryMetaTTL = appCfg.Channel.HistoryMetaTTL.ToDuration()
 	cfg.ClientConnectIncludeServerTime = appCfg.Client.ConnectIncludeServerTime
-	cfg.LogLevel = logging.CentrifugeLogLevel(strings.ToLower(appCfg.LogLevel))
+	cfg.LogLevel = logging.CentrifugeLogLevel(strings.ToLower(appCfg.Log.Level))
 	cfg.LogHandler = logHandler
 	if appCfg.Client.ConnectCodeToUnidirectionalDisconnect.Enabled {
 		uniCodeTransforms := make(map[uint32]centrifuge.Disconnect)
@@ -53,7 +53,7 @@ func nodeName(cfg config.Config) string {
 	if name != "" {
 		return name
 	}
-	port := strconv.Itoa(cfg.Port)
+	port := strconv.Itoa(cfg.HTTP.Port)
 	var hostname string
 	hostname, err := os.Hostname()
 	if err != nil {

internal/app/tls.go

@@ -16,14 +16,14 @@ import (
 var startHTTPChallengeServerOnce sync.Once
 
 func GetTLSConfig(cfg config.Config) (*tls.Config, error) {
-	tlsEnabled := cfg.TLS.Enabled
-	tlsAutocertEnabled := cfg.TLSAutocert.Enabled
-	tlsAutocertHostWhitelist := cfg.TLSAutocert.HostWhitelist
-	tlsAutocertCacheDir := cfg.TLSAutocert.CacheDir
-	tlsAutocertEmail := cfg.TLSAutocert.Email
-	tlsAutocertServerName := cfg.TLSAutocert.ServerName
-	tlsAutocertHTTP := cfg.TLSAutocert.HTTP
-	tlsAutocertHTTPAddr := cfg.TLSAutocert.HTTPAddr
+	tlsEnabled := cfg.HTTP.TLS.Enabled
+	tlsAutocertEnabled := cfg.HTTP.TLSAutocert.Enabled
+	tlsAutocertHostWhitelist := cfg.HTTP.TLSAutocert.HostWhitelist
+	tlsAutocertCacheDir := cfg.HTTP.TLSAutocert.CacheDir
+	tlsAutocertEmail := cfg.HTTP.TLSAutocert.Email
+	tlsAutocertServerName := cfg.HTTP.TLSAutocert.ServerName
+	tlsAutocertHTTP := cfg.HTTP.TLSAutocert.HTTP
+	tlsAutocertHTTPAddr := cfg.HTTP.TLSAutocert.HTTPAddr
 
 	if tlsAutocertEnabled {
 		certManager := autocert.Manager{
@@ -69,7 +69,7 @@ func GetTLSConfig(cfg config.Config) (*tls.Config, error) {
 
 	} else if tlsEnabled {
 		// Autocert disabled - just try to use provided SSL cert and key files.
-		return cfg.TLS.ToGoTLSConfig("http_server")
+		return cfg.HTTP.TLS.ToGoTLSConfig("http_server")
 	}
 
 	return nil, nil

internal/config/config.go

@@ -18,31 +18,12 @@ import (
 )
 
 type Config struct {
-	// Address to bind HTTP server to.
-	Address string `mapstructure:"address" json:"address" envconfig:"address" toml:"address" yaml:"address"`
-	// Port to bind HTTP server to.
-	Port int `mapstructure:"port" json:"port" envconfig:"port" default:"8000" toml:"port" yaml:"port"`
-	// InternalAddress to bind internal HTTP server to. Internal server is used to serve endpoints
-	// which are normally should not be exposed to the outside world.
-	InternalAddress string `mapstructure:"internal_address" json:"internal_address" envconfig:"internal_address" toml:"internal_address" yaml:"internal_address"`
-	// InternalPort to bind internal HTTP server to.
-	InternalPort string `mapstructure:"internal_port" json:"internal_port" envconfig:"internal_port" toml:"internal_port" yaml:"internal_port"`
-	// PidFile is a path to write PID file with server's PID.
+	// PidFile is a path to write a file with Centrifugo process PID.
 	PidFile string `mapstructure:"pid_file" json:"pid_file" envconfig:"pid_file" toml:"pid_file" yaml:"pid_file"`
-	// LogLevel is a log level for Centrifugo logger. Supported values: none, trace, debug, info, warn, error.
-	LogLevel string `mapstructure:"log_level" json:"log_level" envconfig:"log_level" default:"info" toml:"log_level" yaml:"log_level"`
-	// LogFile is a path to log file. If not set logs go to stdout.
-	LogFile string `mapstructure:"log_file" json:"log_file" envconfig:"log_file" toml:"log_file" yaml:"log_file"`
-
-	// TLS configuration for HTTP server.
-	TLS configtypes.TLSConfig `mapstructure:"tls" json:"tls" envconfig:"tls" toml:"tls" yaml:"tls"`
-	// TLSAutocert for automatic TLS certificates from ACME provider (ex. Let's Encrypt).
-	TLSAutocert configtypes.TLSAutocert `mapstructure:"tls_autocert" json:"tls_autocert" envconfig:"tls_autocert" toml:"tls_autocert" yaml:"tls_autocert"`
-	// TLSExternal enables TLS only for external HTTP endpoints.
-	TLSExternal bool `mapstructure:"tls_external" json:"tls_external" envconfig:"tls_external" toml:"tls_external" yaml:"tls_external"`
-	// InternalTLS is a custom configuration for internal HTTP endpoints. If not set InternalTLS will be the same as TLS.
-	InternalTLS configtypes.TLSConfig `mapstructure:"internal_tls" json:"internal_tls" envconfig:"internal_tls" toml:"internal_tls" yaml:"internal_tls"`
-
+	// HTTP is a configuration for Centrifugo HTTP server.
+	HTTP configtypes.HTTPServer `mapstructure:"http_server" json:"http_server" envconfig:"http_server" toml:"http_server" yaml:"http_server"`
+	// Log is a configuration for logging.
+	Log configtypes.Log `mapstructure:"log" json:"log" envconfig:"log" toml:"log" yaml:"log"`
 	// Engine is a configuration for Centrifugo engine. It's a handy combination of Broker and PresenceManager.
 	// Currently only memory and redis engines are supported – both implement all the features. For more granular
 	// control use Broker and PresenceManager options.
@@ -109,9 +90,6 @@ type Config struct {
 	// Debug helps to enable Go profiling endpoints.
 	Debug configtypes.Debug `mapstructure:"debug" json:"debug" envconfig:"debug" toml:"debug" yaml:"debug"`
 
-	// HTTP3 enables HTTP/3 support. EXPERIMENTAL.
-	HTTP3 configtypes.HTTP3 `mapstructure:"http3" json:"http3" envconfig:"http3" toml:"http3" yaml:"http3"`
-
 	// OpenTelemetry is a configuration for OpenTelemetry tracing.
 	OpenTelemetry configtypes.OpenTelemetry `mapstructure:"opentelemetry" json:"opentelemetry" envconfig:"opentelemetry" toml:"opentelemetry" yaml:"opentelemetry"`
 	// Graphite is a configuration for export metrics to Graphite.
@@ -136,18 +114,18 @@ type Meta struct {
 }
 
 func DefineFlags(rootCmd *cobra.Command) {
-	rootCmd.Flags().StringP("address", "a", "", "interface address to listen on")
-	rootCmd.Flags().StringP("port", "p", "8000", "port to bind HTTP server to")
-	rootCmd.Flags().StringP("internal_address", "", "", "custom interface address to listen on for internal endpoints")
-	rootCmd.Flags().StringP("internal_port", "", "", "custom port for internal endpoints")
+	rootCmd.Flags().StringP("pid_file", "", "", "optional path to create PID file")
+	rootCmd.Flags().StringP("http_server.address", "a", "", "interface address to listen on")
+	rootCmd.Flags().StringP("http_server.port", "p", "8000", "port to bind HTTP server to")
+	rootCmd.Flags().StringP("http_server.internal_address", "", "", "custom interface address to listen on for internal endpoints")
+	rootCmd.Flags().StringP("http_server.internal_port", "", "", "custom port for internal endpoints")
 	rootCmd.Flags().StringP("engine.type", "", "memory", "broker to use: ex. redis")
 	rootCmd.Flags().BoolP("broker.enabled", "", false, "enable broker")
 	rootCmd.Flags().StringP("broker.type", "", "memory", "broker to use: ex. redis")
 	rootCmd.Flags().BoolP("presence_manager.enabled", "", false, "enable presence manager")
 	rootCmd.Flags().StringP("presence_manager.type", "", "memory", "presence manager to use: ex. redis")
-	rootCmd.Flags().StringP("log_level", "", "info", "set the log level: trace, debug, info, error, fatal or none")
-	rootCmd.Flags().StringP("log_file", "", "", "optional log file - if not specified logs go to STDOUT")
-	rootCmd.Flags().StringP("pid_file", "", "", "optional path to create PID file")
+	rootCmd.Flags().StringP("log.level", "", "info", "set the log level: trace, debug, info, error, fatal or none")
+	rootCmd.Flags().StringP("log.file", "", "", "optional log file - if not specified logs go to STDOUT")
 	rootCmd.Flags().BoolP("debug.enabled", "", false, "enable debug endpoints")
 	rootCmd.Flags().BoolP("admin.enabled", "", false, "enable admin web interface")
 	rootCmd.Flags().BoolP("admin.external", "", false, "expose admin web interface on external port")

internal/config/testdata/config.json

@@ -1,6 +1,8 @@
 {
-  "tls": {
-    "enabled": true
+  "http_server": {
+    "tls": {
+      "enabled": true
+    }
   },
   "engine": {
     "type": "redis",

internal/config/testdata/config.toml

@@ -1,10 +1,13 @@
-[tls]
-enabled = true
+[http_server]
+
+  [http_server.tls]
+  enabled = true
 
 [engine]
 type = "redis"
 
   [engine.redis]
+  address = "redis:6379"
   presence_ttl = "30s"
 
 [client]

internal/config/testdata/config.yaml

@@ -1,9 +1,11 @@
 ---
-tls:
-  enabled: true
+http_server:
+  tls:
+    enabled: true
 engine:
   type: redis
   redis:
+    address: redis:6379
     presence_ttl: 30s
 client:
   allowed_origins:

internal/configtypes/types.go

@@ -8,6 +8,37 @@ import (
 	"net"
 )
 
+// HTTPServer configuration.
+type HTTPServer struct {
+	// Address to bind HTTP server to.
+	Address string `mapstructure:"address" json:"address" envconfig:"address" toml:"address" yaml:"address"`
+	// Port to bind HTTP server to.
+	Port int `mapstructure:"port" json:"port" envconfig:"port" default:"8000" toml:"port" yaml:"port"`
+	// InternalAddress to bind internal HTTP server to. Internal server is used to serve endpoints
+	// which are normally should not be exposed to the outside world.
+	InternalAddress string `mapstructure:"internal_address" json:"internal_address" envconfig:"internal_address" toml:"internal_address" yaml:"internal_address"`
+	// InternalPort to bind internal HTTP server to.
+	InternalPort string `mapstructure:"internal_port" json:"internal_port" envconfig:"internal_port" toml:"internal_port" yaml:"internal_port"`
+	// TLS configuration for HTTP server.
+	TLS TLSConfig `mapstructure:"tls" json:"tls" envconfig:"tls" toml:"tls" yaml:"tls"`
+	// TLSAutocert for automatic TLS certificates from ACME provider (ex. Let's Encrypt).
+	TLSAutocert TLSAutocert `mapstructure:"tls_autocert" json:"tls_autocert" envconfig:"tls_autocert" toml:"tls_autocert" yaml:"tls_autocert"`
+	// TLSExternal enables TLS only for external HTTP endpoints.
+	TLSExternal bool `mapstructure:"tls_external" json:"tls_external" envconfig:"tls_external" toml:"tls_external" yaml:"tls_external"`
+	// InternalTLS is a custom configuration for internal HTTP endpoints. If not set InternalTLS will be the same as TLS.
+	InternalTLS TLSConfig `mapstructure:"internal_tls" json:"internal_tls" envconfig:"internal_tls" toml:"internal_tls" yaml:"internal_tls"`
+	// HTTP3 allows enabling HTTP/3 support. EXPERIMENTAL!
+	HTTP3 HTTP3 `mapstructure:"http3" json:"http3" envconfig:"http3" toml:"http3" yaml:"http3"`
+}
+
+// Log configuration.
+type Log struct {
+	// Level is a log level for Centrifugo logger. Supported values: none, trace, debug, info, warn, error.
+	Level string `mapstructure:"level" default:"info" json:"level" envconfig:"level" toml:"level" yaml:"level"`
+	// File is a path to log file. If not set logs go to stdout.
+	File string `mapstructure:"file" json:"file" envconfig:"file" toml:"file" yaml:"file"`
+}
+
 // Token common configuration.
 type Token struct {
 	HMACSecretKey      string `mapstructure:"hmac_secret_key" json:"hmac_secret_key" envconfig:"hmac_secret_key" yaml:"hmac_secret_key" toml:"hmac_secret_key"`

internal/logging/logging.go

@@ -125,9 +125,9 @@ func Setup(cfg config.Config) (centrifuge.LogHandler, func()) {
 	var writers []io.Writer
 
 	var file *os.File
-	if cfg.LogFile != "" {
+	if cfg.Log.File != "" {
 		var err error
-		file, err = os.OpenFile(cfg.LogFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
+		file, err = os.OpenFile(cfg.Log.File, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
 		if err != nil {
 			log.Fatal().Err(err).Msg("error opening log file")
 		}
@@ -141,7 +141,7 @@ func Setup(cfg config.Config) (centrifuge.LogHandler, func()) {
 		}
 	}
 
-	logLevel, ok := logLevelMatches[strings.ToUpper(cfg.LogLevel)]
+	logLevel, ok := logLevelMatches[strings.ToUpper(cfg.Log.Level)]
 	if !ok {
 		logLevel = zerolog.InfoLevel
 	}

internal/middleware/log.go

@@ -71,10 +71,3 @@ func (lrw *statusResponseWriter) Connection() http3.Connection {
 func (lrw *statusResponseWriter) HTTPStream() http3.Stream {
 	return lrw.ResponseWriter.(http3.HTTPStreamer).HTTPStream()
 }
-
-// CloseNotify implements http.CloseNotifier.
-//
-//goland:noinspection GoDeprecation
-func (lrw *statusResponseWriter) CloseNotify() <-chan bool {
-	return lrw.ResponseWriter.(http.CloseNotifier).CloseNotify()
-}