config: tidy up config units

agent/config/config.go

@@ -11,9 +11,9 @@ import (
 
 type ServerConfig struct {
 	// URL is the server URL.
-	URL                      string `json:"url" yaml:"url"`
-	HeartbeatIntervalSeconds int    `json:"heartbeat_interval_seconds" yaml:"heartbeat_interval_seconds"`
-	HeartbeatTimeoutSeconds  int    `json:"heartbeat_timeout_seconds" yaml:"heartbeat_timeout_seconds"`
+	URL               string `json:"url" yaml:"url"`
+	HeartbeatInterval int    `json:"heartbeat_interval" yaml:"heartbeat_interval"`
+	HeartbeatTimeout  int    `json:"heartbeat_timeout" yaml:"heartbeat_timeout"`
 }
 
 func (c *ServerConfig) Validate() error {
@@ -23,10 +23,10 @@ func (c *ServerConfig) Validate() error {
 	if _, err := url.Parse(c.URL); err != nil {
 		return fmt.Errorf("invalid url: %w", err)
 	}
-	if c.HeartbeatIntervalSeconds == 0 {
+	if c.HeartbeatInterval == 0 {
 		return fmt.Errorf("missing heartbeat interval")
 	}
-	if c.HeartbeatTimeoutSeconds == 0 {
+	if c.HeartbeatTimeout == 0 {
 		return fmt.Errorf("missing heartbeat timeout")
 	}
 	return nil
@@ -35,7 +35,7 @@ func (c *ServerConfig) Validate() error {
 // ForwarderConfig contains the configuration for how to forward requests
 // from Pico.
 type ForwarderConfig struct {
-	TimeoutSeconds int `json:"timeout_seconds" yaml:"timeout_seconds"`
+	Timeout int `json:"timeout" yaml:"timeout"`
 }
 
 type AdminConfig struct {
@@ -119,30 +119,30 @@ Note Pico connects to the server with WebSockets, so will replace http/https
 with ws/wss (you can configure either).`,
 	)
 	fs.IntVar(
-		&c.Server.HeartbeatIntervalSeconds,
-		"server.heartbeat-interval-seconds",
+		&c.Server.HeartbeatInterval,
+		"server.heartbeat-interval",
 		10,
 		`
 Heartbeat interval in seconds.
 
 To verify the connection to the server is ok, the listener sends a
-heartbeat to the upstream at the '--server.heartbeat-interval-seconds'
-interval, with a timeout of '--server.heartbeat-timeout-seconds'.`,
+heartbeat to the upstream at the '--server.heartbeat-interval'
+interval, with a timeout of '--server.heartbeat-timeout'.`,
 	)
 	fs.IntVar(
-		&c.Server.HeartbeatTimeoutSeconds,
-		"server.heartbeat-timeout-seconds",
+		&c.Server.HeartbeatTimeout,
+		"server.heartbeat-timeout",
 		10,
 		`
 Heartbeat timeout in seconds.,
 
 To verify the connection to the server is ok, the listener sends a
-heartbeat to the upstream at the '--server.heartbeat-interval-seconds'
-interval, with a timeout of '--server.heartbeat-timeout-seconds'.`,
+heartbeat to the upstream at the '--server.heartbeat-interval'
+interval, with a timeout of '--server.heartbeat-timeout'.`,
 	)
 
 	fs.IntVar(
-		&c.Forwarder.TimeoutSeconds,
+		&c.Forwarder.Timeout,
 		"forwarder.timeout",
 		10,
 		`

agent/endpoint.go

@@ -44,7 +44,7 @@ func newEndpoint(
 		forwarder: newForwarder(
 			endpointID,
 			forwardAddr,
-			time.Duration(conf.Forwarder.TimeoutSeconds)*time.Second,
+			time.Duration(conf.Forwarder.Timeout)*time.Second,
 			metrics,
 			logger,
 		),
@@ -74,8 +74,8 @@ func (e *endpoint) Run(ctx context.Context) error {
 
 		if err := stream.Monitor(
 			ctx,
-			time.Duration(e.conf.Server.HeartbeatIntervalSeconds)*time.Second,
-			time.Duration(e.conf.Server.HeartbeatTimeoutSeconds)*time.Second,
+			time.Duration(e.conf.Server.HeartbeatInterval)*time.Second,
+			time.Duration(e.conf.Server.HeartbeatTimeout)*time.Second,
 		); err != nil {
 			if ctx.Err() != nil {
 				// Shutdown.

docs/configure.md

@@ -43,6 +43,7 @@ proxy:
 
     # The timeout when sending proxied requests to upstream listeners for forwarding
     # to other nodes in the cluster.
+    #
     # If the upstream does not respond within the given timeout a
     # '504 Gateway Timeout' is returned to the client.
     gateway_timeout: 15
@@ -51,7 +52,7 @@ upstream:
     # The host/port to listen for connections from upstream listeners.
     # 
     # If the host is unspecified it defaults to all listeners, such as
-    # '--proxy.bind-addr :8001' will listen on '0.0.0.0:8001'.
+    # '--upstream.bind-addr :8001' will listen on '0.0.0.0:8001'.
     bind_addr: :8001
 
     # Upstream listen address to advertise to other nodes in the cluster.
@@ -190,15 +191,15 @@ server:
     # Heartbeat interval in seconds.
     # 
     # To verify the connection to the server is ok, the listener sends a
-    # heartbeat to the upstream at the '--server.heartbeat-interval-seconds'
-    # interval, with a timeout of '--server.heartbeat-timeout-seconds'.`,
-    heartbeat_interval_seconds: 10
+    # heartbeat to the upstream at the '--server.heartbeat-interval'
+    # interval, with a timeout of '--server.heartbeat-timeout'.`,
+    heartbeat_interval: 10
 
     # Heartbeat timeout in seconds.,
     # 
     # To verify the connection to the server is ok, the listener sends a
-    # heartbeat to the upstream at the '--server.heartbeat-interval-seconds'
-    heartbeat_timeout_seconds: 10
+    # heartbeat to the upstream at the '--server.heartbeat-interval'
+    heartbeat_timeout: 10
 
 forwarder:
     # Forwarder timeout in seconds.
@@ -208,7 +209,7 @@ forwarder:
     # 
     # If the upstream does not respond within the given timeout a
     # '504 Gateway Timeout' is returned to the client.
-    timeout_seconds: 10
+    timeout: 10
 
 admin:
     # The host/port to listen for incoming admin connections.

server/config/config.go

@@ -72,6 +72,13 @@ type ClusterConfig struct {
 	Join []string `json:"join" yaml:"join"`
 }
 
+func (c *ClusterConfig) Validate() error {
+	if c.NodeID != "" && c.NodeIDPrefix != "" {
+		return fmt.Errorf("cannot specify both node ID and node ID prefix")
+	}
+	return nil
+}
+
 type ServerConfig struct {
 	// GracefulShutdownTimeout is the timeout to allow for graceful shutdown
 	// of the server in seconds.
@@ -108,6 +115,9 @@ func (c *Config) Validate() error {
 	if err := c.Gossip.Validate(); err != nil {
 		return fmt.Errorf("gossip: %w", err)
 	}
+	if err := c.Cluster.Validate(); err != nil {
+		return fmt.Errorf("cluster: %w", err)
+	}
 	if err := c.Server.Validate(); err != nil {
 		return fmt.Errorf("server: %w", err)
 	}
@@ -151,6 +161,7 @@ advertise address of '10.26.104.14:8000'.`,
 		`
 The timeout when sending proxied requests to upstream listeners for forwarding
 to other nodes in the cluster.
+
 If the upstream does not respond within the given timeout a
 '504 Gateway Timeout' is returned to the client.`,
 	)
@@ -163,7 +174,7 @@ If the upstream does not respond within the given timeout a
 The host/port to listen for connections from upstream listeners.
 
 If the host is unspecified it defaults to all listeners, such as
-'--proxy.bind-addr :8001' will listen on '0.0.0.0:8001'`,
+'--upstream.bind-addr :8001' will listen on '0.0.0.0:8001'`,
 	)
 	fs.StringVar(
 		&c.Upstream.AdvertiseAddr,

tests/proxy_test.go

@@ -118,11 +118,11 @@ func defaultAgentConfig(serverAddr string) *agentconfig.Config {
 	return &agentconfig.Config{
 		Server: agentconfig.ServerConfig{
 			URL:                      "http://" + serverAddr,
-			HeartbeatIntervalSeconds: 1,
-			HeartbeatTimeoutSeconds:  1,
+			HeartbeatInterval: 1,
+			HeartbeatTimeout:  1,
 		},
 		Forwarder: agentconfig.ForwarderConfig{
-			TimeoutSeconds: 1,
+			Timeout: 1,
 		},
 		Admin: agentconfig.AdminConfig{
 			BindAddr: "127.0.0.1:0",