chore: nest analytical storage backends under top-level storage key

flipt-io · Feb 5, 2024 · 337b179 · 337b179
1 parent 5c73f4b
commit 337b179
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 37 deletions.
diff --git a/config/flipt.schema.cue b/config/flipt.schema.cue
@@ -314,12 +314,13 @@ import "strings"
 	}
 
 	#analytics: {
-		enabled?: bool | *false
-		clickhouse?: {
-			enabled?:  bool | *false
-			url?:      string | *""
-			username?: string | *""
-			password?: string | *""
+		storage?: {
+			clickhouse?: {
+				enabled?:  bool | *false
+				url?:      string | *""
+				username?: string | *""
+				password?: string | *""
+			}
 		}
 		buffer?: {
 			capacity?:     int

diff --git a/config/flipt.schema.json b/config/flipt.schema.json
@@ -1081,31 +1081,33 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
-        "enabled": {
-          "type": "boolean",
-          "default": false
-        },
-        "clickhouse": {
+        "storage": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
-            "enabled": {
-              "type": "boolean",
+            "clickhouse": {
+              "type": "object",
               "additionalProperties": false,
-              "default": false,
+              "properties": {
+                "enabled": {
+                  "type": "boolean",
+                  "additionalProperties": false,
+                  "default": false
+                },
+                "url": {
+                  "type": "string",
+                  "default": ""
+                },
+                "username": {
+                  "type": "string",
+                  "default": ""
+                },
+                "password": {
+                  "type": "string",
+                  "default": ""
+                }
+              },
               "title": "Clickhouse"
-            },
-            "url": {
-              "type": "string",
-              "default": ""
-            },
-            "username": {
-              "type": "string",
-              "default": ""
-            },
-            "password": {
-              "type": "string",
-              "default": ""
             }
           }
         },

diff --git a/internal/config/analytics.go b/internal/config/analytics.go
@@ -11,8 +11,13 @@ import (
 // AnalyticsConfig defines the configuration for various mechanisms for
 // reporting and querying analytical data for Flipt.
 type AnalyticsConfig struct {
+	Storage AnalyticsStorageConfig `json:"storage,omitempty" mapstructure:"storage" yaml:"storage,omitempty"`
+	Buffer  BufferConfig           `json:"buffer,omitempty" mapstructure:"buffer" yaml:"buffer,omitempty"`
+}
+
+// AnalyticsStorageConfig is a collection of configuration option for storage backends.
+type AnalyticsStorageConfig struct {
 	Clickhouse ClickhouseConfig `json:"clickhouse,omitempty" mapstructure:"clickhouse" yaml:"clickhouse,omitempty"`
-	Buffer     BufferConfig     `json:"buffer,omitempty" mapstructure:"buffer" yaml:"buffer,omitempty"`
 }
 
 // ClickhouseConfig defines the connection details for connecting Flipt to Clickhouse.
@@ -24,7 +29,7 @@ type ClickhouseConfig struct {
 }
 
 func (a *AnalyticsConfig) Enabled() bool {
-	return a.Clickhouse.Enabled
+	return a.Storage.Clickhouse.Enabled
 }
 
 func (c *ClickhouseConfig) Auth() clickhouse.Auth {
@@ -52,7 +57,7 @@ func (a *AnalyticsConfig) setDefaults(v *viper.Viper) error {
 }
 
 func (a *AnalyticsConfig) validate() error {
-	if a.Clickhouse.Enabled && a.Clickhouse.URL == "" {
+	if a.Storage.Clickhouse.Enabled && a.Storage.Clickhouse.URL == "" {
 		return errors.New("clickhouse url not provided")
 	}
 

diff --git a/internal/config/testdata/analytics/invalid_buffer_configuration_flush_period.yml b/internal/config/testdata/analytics/invalid_buffer_configuration_flush_period.yml
@@ -1,4 +1,3 @@
 analytics:
-  enabled: true
   buffer:
     flush_period: "5s"
diff --git a/internal/config/testdata/analytics/invalid_clickhouse_configuration_url.yml b/internal/config/testdata/analytics/invalid_clickhouse_configuration_url.yml
@@ -1,4 +1,4 @@
 analytics:
-  enabled: true
-  clickhouse:
-    enabled: true
+  storage:
+    clickhouse:
+      enabled: true
diff --git a/internal/server/analytics/clickhouse/client.go b/internal/server/analytics/clickhouse/client.go
@@ -46,7 +46,7 @@ func New(logger *zap.Logger, cfg *config.Config, forceMigrate bool) (*Client, er
 			return
 		}
 
-		connection, err := connect(cfg.Analytics.Clickhouse)
+		connection, err := connect(cfg.Analytics.Storage.Clickhouse)
 		if err != nil {
 			clickhouseErr = err
 			return

diff --git a/internal/storage/sql/db.go b/internal/storage/sql/db.go
@@ -176,10 +176,10 @@ func open(cfg config.Config, opts Options) (*sql.DB, Driver, error) {
 // openAnalytics is a convenience function of providing a database.sql instance for
 // an analytics database.
 func openAnalytics(cfg config.Config) (*sql.DB, Driver, error) {
-	if cfg.Analytics.Clickhouse.Enabled {
+	if cfg.Analytics.Storage.Clickhouse.Enabled {
 		db := clickhouse.OpenDB(&clickhouse.Options{
-			Addr: []string{cfg.Analytics.Clickhouse.URL},
-			Auth: cfg.Analytics.Clickhouse.Auth(),
+			Addr: []string{cfg.Analytics.Storage.Clickhouse.URL},
+			Auth: cfg.Analytics.Storage.Clickhouse.Auth(),
 		})
 
 		return db, Clickhouse, nil