fix: Address new comments

Author: sambuc

cmd/csi-rclone-plugin/main.go

@@ -17,19 +17,26 @@ import (
 )
 
 var (
-	endpoint            string
-	nodeID              string
-	cacheDir            string
-	cacheSize           string
-	metricsServerConfig metrics.ServerConfig
-	meters              []metrics.Observable
+	endpoint  string
+	nodeID    string
+	cacheDir  string
+	cacheSize string
+	meters    []metrics.Observable
 )
 
 func init() {
 	flag.Set("logtostderr", "true")
 }
 
 func main() {
+	metricsServerConfig := metrics.ServerConfig{
+		Host:            "localhost",
+		Port:            9090,
+		PathPrefix:      "/metrics",
+		PollPeriod:      30 * time.Second,
+		ShutdownTimeout: 5 * time.Second,
+		Enabled:         false,
+	}
 
 	root := &cobra.Command{
 		Use:   "rclone",
@@ -81,12 +88,12 @@ func main() {
 
 	root.ParseFlags(os.Args[1:])
 
-	if metricsServerConfig.Enable {
+	if metricsServerConfig.Enabled {
 		// Gracefully exit the metrics background servers
 		ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGTERM, syscall.SIGINT)
 		defer stop()
 
-		metricsServer := metricsServerConfig.NewServer(ctx, 5*time.Second, 30*time.Second, &meters)
+		metricsServer := metricsServerConfig.NewServer(ctx, &meters)
 		go metricsServer.ListenAndServe()
 	}
 

deploy/csi-rclone/templates/csi-controller-rclone.yaml

@@ -59,15 +59,21 @@ spec:
       - name: rclone
         args:
         - run
-        {{- if .Values.csiControllerRclone.rclone.metrics.enable }}
-        - --metrics-enable={{.Values.csiControllerRclone.rclone.metrics.enable}}
+        {{- if .Values.csiControllerRclone.rclone.metrics.enabled }}
+        - --metrics-enabled={{.Values.csiControllerRclone.rclone.metrics.enabled}}
         {{- end }}
         {{- if .Values.csiControllerRclone.rclone.metrics.host }}
         - --metrics-host={{.Values.csiControllerRclone.rclone.metrics.host}}
         {{- end }}
         {{- if .Values.csiControllerRclone.rclone.metrics.port }}
         - --metrics-port={{.Values.csiControllerRclone.rclone.metrics.port}}
         {{- end }}
+        {{- if .Values.csiControllerRclone.rclone.metrics.pathPrefix }}
+        - --metrics-path-prefix={{.Values.csiControllerRclone.rclone.metrics.pathPrefix}}
+        {{- end }}
+        {{- if .Values.csiControllerRclone.rclone.metrics.pollPeriod }}
+        - --metrics-path-prefix={{.Values.csiControllerRclone.rclone.metrics.pollPeriod}}
+        {{- end }}
         - controller
         - --nodeid=$(NODE_ID)
         - --endpoint=$(CSI_ENDPOINT)

deploy/csi-rclone/templates/csi-nodeplugin-rclone.yaml

@@ -60,15 +60,21 @@ spec:
       - name: rclone
         args:
         - run
-        {{- if .Values.csiNodepluginRclone.rclone.metrics.enable }}
-        - --metrics-enable={{.Values.csiNodepluginRclone.rclone.metrics.enable}}
+        {{- if .Values.csiNodepluginRclone.rclone.metrics.enabled }}
+        - --metrics-enabled={{.Values.csiNodepluginRclone.rclone.metrics.enabled}}
         {{- end }}
         {{- if .Values.csiNodepluginRclone.rclone.metrics.host }}
         - --metrics-host={{.Values.csiNodepluginRclone.rclone.metrics.host}}
         {{- end }}
         {{- if .Values.csiNodepluginRclone.rclone.metrics.port }}
         - --metrics-port={{.Values.csiNodepluginRclone.rclone.metrics.port}}
         {{- end }}
+        {{- if .Values.csiNodepluginRclone.rclone.metrics.pathPrefix }}
+        - --metrics-path-prefix={{.Values.csiNodepluginRclone.rclone.metrics.pathPrefix}}
+        {{- end }}
+        {{- if .Values.csiNodepluginRclone.rclone.metrics.pollPeriod }}
+        - --metrics-path-prefix={{.Values.csiNodepluginRclone.rclone.metrics.pollPeriod}}
+        {{- end }}
         - node
         - --nodeid=$(NODE_ID)
         - --endpoint=$(CSI_ENDPOINT)

deploy/csi-rclone/values.yaml

@@ -28,9 +28,11 @@ csiControllerRclone:
     goMemLimit: # 115Mi
     # Prometheus metrics
     metrics:
-      enable: true
+      enabled: true
       host: # localhost
-      port: 80
+      port: 9090
+      pathPrefix: # /metrics
+      pollPeriod: # 30s
   replicas: 1
   serviceAccount:
     annotations: {}
@@ -69,9 +71,11 @@ csiNodepluginRclone:
     goMemLimit: # 115Mi
     # Prometheus metrics
     metrics:
-      enable: true
+      enabled: true
       host: # localhost
-      port: 80
+      port: 9090
+      pathPrefix: # /metrics
+      pollPeriod: # 30s
     # Options to configure rclone's caching with VFS
     cache:
       # The location of the cache directory

pkg/metrics/server.go

@@ -62,38 +62,41 @@ func poll(ctx context.Context, period time.Duration, observe Observable) {
 }
 
 type ServerConfig struct {
-	host       string
-	port       int16
-	pathPrefix string
-	Enable     bool
+	Host            string
+	Port            int16
+	PathPrefix      string
+	PollPeriod      time.Duration
+	ShutdownTimeout time.Duration
+	Enabled         bool
 }
 
 func (config *ServerConfig) CommandLineParameters(root *cobra.Command) {
-	root.PersistentFlags().StringVar(&config.host, "metrics-host", "localhost", "Host name or ip address for Prometheus metrics")
-	root.PersistentFlags().Int16Var(&config.port, "metrics-port", 80, "Port for Prometheus metrics")
-	root.PersistentFlags().BoolVar(&config.Enable, "metrics-enable", false, "Enable Prometheus metrics")
-
-	config.pathPrefix = "/metrics"
+	root.PersistentFlags().StringVar(&config.Host, "metrics-host", config.Host, "Host name or ip address for Prometheus metrics")
+	root.PersistentFlags().Int16Var(&config.Port, "metrics-port", config.Port, "Port for Prometheus metrics")
+	root.PersistentFlags().StringVar(&config.PathPrefix, "metrics-path-prefix", config.PathPrefix, "Path prefix for Prometheus metrics")
+	root.PersistentFlags().DurationVar(&config.PollPeriod, "metrics-poll-period", config.PollPeriod, "Polling period for Prometheus metrics updates")
+	root.PersistentFlags().DurationVar(&config.ShutdownTimeout, "metrics-shutdown-timeout", config.ShutdownTimeout, "Shutdown timeout of the Prometheus metrics server")
+	root.PersistentFlags().BoolVar(&config.Enabled, "metrics-enabled", config.Enabled, "Prometheus metrics state")
 }
 
-func (config *ServerConfig) NewServer(ctx context.Context, shutdownTimeout, pollPeriod time.Duration, meters *[]Observable) *Server {
+func (config *ServerConfig) NewServer(ctx context.Context, meters *[]Observable) *Server {
 	mux := http.NewServeMux()
-	mux.Handle(config.pathPrefix, promhttp.Handler())
+	mux.Handle(config.PathPrefix, promhttp.Handler())
 
 	server := Server{
-		http:             http.Server{Addr: fmt.Sprintf("%s:%d", config.host, config.port), Handler: mux},
+		http:             http.Server{Addr: fmt.Sprintf("%s:%d", config.Host, config.Port), Handler: mux},
 		shutdownFinished: make(chan struct{}),
 	}
 
-	go poll(ctx, pollPeriod,
+	go poll(ctx, config.PollPeriod,
 		func() {
 			for _, observer := range *meters {
 				observer()
 			}
 		},
 	)
 
-	go server.shutdown(ctx, shutdownTimeout)
+	go server.shutdown(ctx, config.ShutdownTimeout)
 
 	return &server
 }