add enable-metrics arg to disable metrics (#2232)

Author: hongzhen-ma

cmd/controller/controller.go

@@ -43,7 +43,9 @@ func CmdMain() {
 	go loopOvnNbctlDaemon(config)
 	go func() {
 		mux := http.NewServeMux()
-		mux.Handle("/metrics", promhttp.Handler())
+		if config.EnableMetrics {
+			mux.Handle("/metrics", promhttp.Handler())
+		}
 		if config.EnablePprof {
 			mux.HandleFunc("/debug/pprof/", pprof.Index)
 			mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)

cmd/daemon/cniserver.go

@@ -87,7 +87,9 @@ func CmdMain() {
 	}
 
 	mux := http.NewServeMux()
-	mux.Handle("/metrics", promhttp.Handler())
+	if config.EnableMetrics {
+		mux.Handle("/metrics", promhttp.Handler())
+	}
 	if config.EnablePprof {
 		mux.HandleFunc("/debug/pprof/", pprof.Index)
 		mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)

cmd/ovn_monitor/ovn_monitor.go

@@ -32,8 +32,10 @@ func CmdMain() {
 	}
 	exporter.StartOvnMetrics()
 
-	http.Handle(config.MetricsPath, promhttp.Handler())
-	klog.Infoln("Listening on", config.ListenAddress)
+	if config.EnableMetrics {
+		http.Handle(config.MetricsPath, promhttp.Handler())
+		klog.Infoln("Listening on", config.ListenAddress)
+	}
 
 	// conform to Gosec G114
 	// https://github.com/securego/gosec#available-rules

cmd/pinger/pinger.go

@@ -24,8 +24,9 @@ func CmdMain() {
 	if err != nil {
 		util.LogFatalAndExit(err, "failed to parse config")
 	}
-	if config.Mode == "server" {
+	if config.Mode == "server" && config.EnableMetrics {
 		http.Handle("/metrics", promhttp.Handler())
+
 		go func() {
 			server := &http.Server{
 				Addr:              fmt.Sprintf("0.0.0.0:%d", config.Port),

pkg/controller/config.go

@@ -80,6 +80,7 @@ type Configuration struct {
 	EnableExternalVpc bool
 	EnableEcmp        bool
 	EnableKeepVmIP    bool
+	EnableMetrics     bool
 
 	ExternalGatewayConfigNS string
 	ExternalGatewayNet      string
@@ -136,6 +137,7 @@ func ParseFlags() (*Configuration, error) {
 		argEnableExternalVpc       = pflag.Bool("enable-external-vpc", true, "Enable external vpc support")
 		argEnableEcmp              = pflag.Bool("enable-ecmp", false, "Enable ecmp route for centralized subnet")
 		argKeepVmIP                = pflag.Bool("keep-vm-ip", false, "Whether to keep ip for kubevirt pod when pod is rebuild")
+		argEnableMetrics           = pflag.Bool("enable-metrics", true, "Whether to support metrics query")
 
 		argExternalGatewayConfigNS = pflag.String("external-gateway-config-ns", "kube-system", "The namespace of configmap external-gateway-config, default: kube-system")
 		argExternalGatewayNet      = pflag.String("external-gateway-net", "external", "The namespace of configmap external-gateway-config, default: external")
@@ -205,6 +207,7 @@ func ParseFlags() (*Configuration, error) {
 		EnableEcmp:                    *argEnableEcmp,
 		EnableKeepVmIP:                *argKeepVmIP,
 		NodePgProbeTime:               *argNodePgProbeTime,
+		EnableMetrics:                 *argEnableMetrics,
 	}
 
 	if config.NetworkType == util.NetworkTypeVlan && config.DefaultHostInterface == "" {

pkg/daemon/config.go

@@ -55,6 +55,7 @@ type Configuration struct {
 	DefaultProviderName     string
 	DefaultInterfaceName    string
 	ExternalGatewayConfigNS string
+	EnableMetrics           bool
 }
 
 // ParseFlags will parse cmd args then init kubeClient and configuration
@@ -84,6 +85,7 @@ func ParseFlags() *Configuration {
 		argsDefaultProviderName    = pflag.String("default-provider-name", "provider", "The vlan or vxlan type default provider interface name")
 		argsDefaultInterfaceName   = pflag.String("default-interface-name", "", "The default host interface name in the vlan/vxlan type")
 		argExternalGatewayConfigNS = pflag.String("external-gateway-config-ns", "kube-system", "The namespace of configmap external-gateway-config, default: kube-system")
+		argEnableMetrics           = pflag.Bool("enable-metrics", true, "Whether to support metrics query")
 	)
 
 	// mute info log for ipset lib
@@ -130,6 +132,7 @@ func ParseFlags() *Configuration {
 		DefaultProviderName:     *argsDefaultProviderName,
 		DefaultInterfaceName:    *argsDefaultInterfaceName,
 		ExternalGatewayConfigNS: *argExternalGatewayConfigNS,
+		EnableMetrics:           *argEnableMetrics,
 	}
 	return config
 }

pkg/ovnmonitor/config.go

@@ -40,6 +40,7 @@ type Configuration struct {
 	ServiceVswitchdFilePidPath      string
 	ServiceNorthdFileLogPath        string
 	ServiceNorthdFilePidPath        string
+	EnableMetrics                   bool
 }
 
 // ParseFlags get parameters information.
@@ -49,6 +50,7 @@ func ParseFlags() (*Configuration, error) {
 		argMetricsPath   = pflag.String("telemetry-path", "/metrics", "Path under which to expose metrics.")
 		argPollTimeout   = pflag.Int("ovs.timeout", 2, "Timeout on JSON-RPC requests to OVN.")
 		argPollInterval  = pflag.Int("ovs.poll-interval", 30, "The minimum interval (in seconds) between collections from OVN server.")
+		argEnableMetrics = pflag.Bool("enable-metrics", true, "Whether to support metrics query")
 
 		argSystemRunDir                    = pflag.String("system.run.dir", "/var/run/openvswitch", "OVS default run directory.")
 		argDatabaseVswitchName             = pflag.String("database.vswitch.name", "Open_vSwitch", "The name of OVS db.")
@@ -121,6 +123,7 @@ func ParseFlags() (*Configuration, error) {
 		ServiceVswitchdFilePidPath:      *argServiceVswitchdFilePidPath,
 		ServiceNorthdFileLogPath:        *argServiceNorthdFileLogPath,
 		ServiceNorthdFilePidPath:        *argServiceNorthdFilePidPath,
+		EnableMetrics:                   *argEnableMetrics,
 	}
 
 	klog.Infof("ovn monitor config is %+v", config)

pkg/pinger/config.go

@@ -34,6 +34,7 @@ type Configuration struct {
 	PodProtocols       []string
 	ExternalAddress    string
 	NetworkMode        string
+	EnableMetrics      bool
 
 	// Used for OVS Monitor
 	PollTimeout                     int
@@ -64,6 +65,7 @@ func ParseFlags() (*Configuration, error) {
 		argExternalDns        = pflag.String("external-dns", "", "check external dns resolve from pod")
 		argExternalAddress    = pflag.String("external-address", "", "check ping connection to an external address, default: 114.114.114.114")
 		argNetworkMode        = pflag.String("network-mode", "kube-ovn", "The cni plugin current cluster used, default: kube-ovn")
+		argEnableMetrics      = pflag.Bool("enable-metrics", true, "Whether to support metrics query")
 
 		argPollTimeout                     = pflag.Int("ovs.timeout", 2, "Timeout on JSON-RPC requests to OVS.")
 		argPollInterval                    = pflag.Int("ovs.poll-interval", 15, "The minimum interval (in seconds) between collections from OVS server.")
@@ -115,6 +117,7 @@ func ParseFlags() (*Configuration, error) {
 		PodName:            os.Getenv("POD_NAME"),
 		ExternalAddress:    *argExternalAddress,
 		NetworkMode:        *argNetworkMode,
+		EnableMetrics:      *argEnableMetrics,
 
 		// OVS Monitor
 		PollTimeout:                     *argPollTimeout,