Make KeyVisualizer disabled by default (#1645)

cmd/tidb-dashboard/main.go

@@ -69,6 +69,7 @@ func NewCLIConfig() *DashboardCLIConfig {
 	flag.BoolVar(&cfg.CoreConfig.EnableExperimental, "experimental", cfg.CoreConfig.EnableExperimental, "allow experimental features")
 	flag.StringVar(&cfg.CoreConfig.FeatureVersion, "feature-version", cfg.CoreConfig.FeatureVersion, "target TiDB version for standalone mode")
 	flag.IntVar(&cfg.CoreConfig.NgmTimeout, "ngm-timeout", cfg.CoreConfig.NgmTimeout, "timeout secs for accessing the ngm API")
+	flag.BoolVar(&cfg.CoreConfig.EnableKeyVisualizer, "keyviz", true, "enable/disable key visualizer(default: true)")
 
 	showVersion := flag.BoolP("version", "v", false, "print version information and exit")
 

pkg/config/config.go

@@ -30,26 +30,28 @@ type Config struct {
 	ClusterTLSInfo   *transport.TLSInfo // TLS info for mTLS authentication between TiDB components.
 	TiDBTLSConfig    *tls.Config        // TLS config for mTLS authentication between TiDB and MySQL client.
 
-	EnableTelemetry    bool
-	EnableExperimental bool
-	FeatureVersion     string // assign the target TiDB version when running TiDB Dashboard as standalone mode
+	EnableTelemetry     bool
+	EnableExperimental  bool
+	EnableKeyVisualizer bool
+	FeatureVersion      string // assign the target TiDB version when running TiDB Dashboard as standalone mode
 
 	NgmTimeout int // in seconds
 }
 
 func Default() *Config {
 	return &Config{
-		DataDir:            "/tmp/dashboard-data",
-		TempDir:            "",
-		PDEndPoint:         "http://127.0.0.1:2379",
-		PublicPathPrefix:   defaultPublicPathPrefix,
-		ClusterTLSConfig:   nil,
-		ClusterTLSInfo:     nil,
-		TiDBTLSConfig:      nil,
-		EnableTelemetry:    false,
-		EnableExperimental: false,
-		FeatureVersion:     version.PDVersion,
-		NgmTimeout:         30, // s
+		DataDir:             "/tmp/dashboard-data",
+		TempDir:             "",
+		PDEndPoint:          "http://127.0.0.1:2379",
+		PublicPathPrefix:    defaultPublicPathPrefix,
+		ClusterTLSConfig:    nil,
+		ClusterTLSInfo:      nil,
+		TiDBTLSConfig:       nil,
+		EnableTelemetry:     false,
+		EnableExperimental:  false,
+		EnableKeyVisualizer: true,
+		FeatureVersion:      version.PDVersion,
+		NgmTimeout:          30, // s
 	}
 }
 

pkg/config/dynamic_config_manager.go

@@ -77,6 +77,7 @@ func (m *DynamicConfigManager) Start(ctx context.Context) error {
 			dc = &DynamicConfig{}
 		}
 		dc.Adjust()
+		dc.KeyVisual.AutoCollectionDisabled = !m.config.EnableKeyVisualizer
 
 		if err := backoff.Retry(func() error { return m.Set(dc) }, bo); err != nil {
 			log.Error("Failed to start DynamicConfigManager", zap.Error(err))