add nodeExporter.collectors.netdev settings.

Author: raptorsun

CHANGELOG.md

@@ -9,6 +9,7 @@
 - [#1855](https://github.com/openshift/cluster-monitoring-operator/pull/1855) Add nodeExporter.collectors.cpufreq settings.
 - [#1882](https://github.com/openshift/cluster-monitoring-operator/issues/1882) Allow configuring secrets in alertmanager component (platform)
 - [#1876](https://github.com/openshift/cluster-monitoring-operator/pull/1876) Add nodeExporter.collectors.tcpstat settings.
+- [#1888](https://github.com/openshift/cluster-monitoring-operator/pull/1888) Add nodeExporter.collectors.netdev settings.
 
 
 ## 4.12

Documentation/api.md

@@ -27,6 +27,7 @@ Configuring Cluster Monitoring is optional. If the config does not exist or is e
 * [KubeStateMetricsConfig](#kubestatemetricsconfig)
 * [NodeExporterCollectorConfig](#nodeexportercollectorconfig)
 * [NodeExporterCollectorCpufreqConfig](#nodeexportercollectorcpufreqconfig)
+* [NodeExporterCollectorNetDevConfig](#nodeexportercollectornetdevconfig)
 * [NodeExporterCollectorTcpStatConfig](#nodeexportercollectortcpstatconfig)
 * [NodeExporterConfig](#nodeexporterconfig)
 * [OpenShiftStateMetricsConfig](#openshiftstatemetricsconfig)
@@ -190,6 +191,7 @@ The `NodeExporterCollectorConfig` resource defines settings for individual colle
 | -------- | ---- | ----------- |
 | cpufreq | [NodeExporterCollectorCpufreqConfig](#nodeexportercollectorcpufreqconfig) | Defines the configuration of the `cpufreq` collector, which collects CPU frequency statistics. Disabled by default. |
 | tcpstat | [NodeExporterCollectorTcpStatConfig](#nodeexportercollectortcpstatconfig) | Defines the configuration of the `tcpstat` collector, which collects TCP connection statistics. Disabled by default. |
+| netdev | [NodeExporterCollectorNetDevConfig](#nodeexportercollectornetdevconfig) | Defines the configuration of the `netdev` collector, which collects network devices statistics. Enabled by default. |
 
 [Back to TOC](#table-of-contents)
 
@@ -208,6 +210,21 @@ The `NodeExporterCollectorCpufreqConfig` resource works as an on/off switch for
 
 [Back to TOC](#table-of-contents)
 
+## NodeExporterCollectorNetDevConfig
+
+#### Description
+
+The `NodeExporterCollectorNetDevConfig` resource works as an on/off switch for the `netdev` collector of the `node-exporter` agent. By default, the `netdev` collector is enabled. If disabled, these metrics become unavailable: `node_network_receive_bytes_total`, `node_network_receive_compressed_total`, `node_network_receive_drop_total`, `node_network_receive_errs_total`, `node_network_receive_fifo_total`, `node_network_receive_frame_total`, `node_network_receive_multicast_total`, `node_network_receive_nohandler_total`, `node_network_receive_packets_total`, `node_network_transmit_bytes_total`, `node_network_transmit_carrier_total`, `node_network_transmit_colls_total`, `node_network_transmit_compressed_total`, `node_network_transmit_drop_total`, `node_network_transmit_errs_total`, `node_network_transmit_fifo_total`, `node_network_transmit_packets_total`.
+
+
+<em>appears in: [NodeExporterCollectorConfig](#nodeexportercollectorconfig)</em>
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| enabled | bool | A Boolean flag that enables or disables the `netdev` collector. |
+
+[Back to TOC](#table-of-contents)
+
 ## NodeExporterCollectorTcpStatConfig
 
 #### Description

Documentation/openshiftdocs/index.adoc

@@ -47,6 +47,7 @@ The configuration file itself is always defined under the `config.yaml` key in t
 * link:modules/kubestatemetricsconfig.adoc[KubeStateMetricsConfig]
 * link:modules/nodeexportercollectorconfig.adoc[NodeExporterCollectorConfig]
 * link:modules/nodeexportercollectorcpufreqconfig.adoc[NodeExporterCollectorCpufreqConfig]
+* link:modules/nodeexportercollectornetdevconfig.adoc[NodeExporterCollectorNetDevConfig]
 * link:modules/nodeexportercollectortcpstatconfig.adoc[NodeExporterCollectorTcpStatConfig]
 * link:modules/nodeexporterconfig.adoc[NodeExporterConfig]
 * link:modules/openshiftstatemetricsconfig.adoc[OpenShiftStateMetricsConfig]

Documentation/openshiftdocs/modules/nodeexportercollectorconfig.adoc

@@ -22,6 +22,8 @@ Appears in: link:nodeexporterconfig.adoc[NodeExporterConfig]
 
 |tcpstat|link:nodeexportercollectortcpstatconfig.adoc[NodeExporterCollectorTcpStatConfig]|Defines the configuration of the `tcpstat` collector, which collects TCP connection statistics. Disabled by default.
 
+|netdev|link:nodeexportercollectornetdevconfig.adoc[NodeExporterCollectorNetDevConfig]|Defines the configuration of the `netdev` collector, which collects network devices statistics. Enabled by default.
+
 |===
 
 link:../index.adoc[Back to TOC]

Documentation/openshiftdocs/modules/nodeexportercollectornetdevconfig.adoc

@@ -0,0 +1,25 @@
+// DO NOT EDIT THE CONTENT IN THIS FILE. It is automatically generated from the 
+	// source code for the Cluster Monitoring Operator. Any changes made to this 
+	// file will be overwritten when the content is re-generated. If you wish to 
+	// make edits, read the docgen utility instructions in the source code for the 
+	// CMO.
+	:_content-type: ASSEMBLY
+
+== NodeExporterCollectorNetDevConfig
+
+=== Description
+
+The `NodeExporterCollectorNetDevConfig` resource works as an on/off switch for the `netdev` collector of the `node-exporter` agent. By default, the `netdev` collector is enabled. If disabled, these metrics become unavailable: `node_network_receive_bytes_total`, `node_network_receive_compressed_total`, `node_network_receive_drop_total`, `node_network_receive_errs_total`, `node_network_receive_fifo_total`, `node_network_receive_frame_total`, `node_network_receive_multicast_total`, `node_network_receive_nohandler_total`, `node_network_receive_packets_total`, `node_network_transmit_bytes_total`, `node_network_transmit_carrier_total`, `node_network_transmit_colls_total`, `node_network_transmit_compressed_total`, `node_network_transmit_drop_total`, `node_network_transmit_errs_total`, `node_network_transmit_fifo_total`, `node_network_transmit_packets_total`.
+
+
+
+Appears in: link:nodeexportercollectorconfig.adoc[NodeExporterCollectorConfig]
+
+[options="header"]
+|===
+| Property | Type | Description 
+|enabled|bool|A Boolean flag that enables or disables the `netdev` collector.
+
+|===
+
+link:../index.adoc[Back to TOC]

pkg/manifests/config.go

@@ -188,7 +188,7 @@ func (cfg *TelemeterClientConfig) IsEnabled() bool {
 
 func NewConfig(content io.Reader) (*Config, error) {
 	c := Config{}
-	cmc := ClusterMonitoringConfiguration{}
+	cmc := defaultClusterMonitoringConfiguration()
 	err := k8syaml.NewYAMLOrJSONDecoder(content, 4096).Decode(&cmc)
 	if err != nil {
 		return nil, err
@@ -200,6 +200,18 @@ func NewConfig(content io.Reader) (*Config, error) {
 	return res, nil
 }
 
+func defaultClusterMonitoringConfiguration() ClusterMonitoringConfiguration {
+	return ClusterMonitoringConfiguration{
+		NodeExporterConfig: NodeExporterConfig{
+			Collectors: NodeExporterCollectorConfig{
+				NetDev: NodeExporterCollectorNetDevConfig{
+					Enabled: true,
+				},
+			},
+		},
+	}
+}
+
 func (c *Config) applyDefaults() {
 	if c.Images == nil {
 		c.Images = &Images{}
@@ -392,7 +404,7 @@ func NewConfigFromString(content string) (*Config, error) {
 
 func NewDefaultConfig() *Config {
 	c := &Config{}
-	cmc := ClusterMonitoringConfiguration{}
+	cmc := defaultClusterMonitoringConfiguration()
 	c.ClusterMonitoringConfiguration = &cmc
 	c.UserWorkloadConfiguration = NewDefaultUserWorkloadMonitoringConfig()
 	c.applyDefaults()

pkg/manifests/manifests.go

@@ -815,6 +815,13 @@ func (f *Factory) updateNodeExporterArgs(args []string) []string {
 	} else {
 		args = setArg(args, "--no-collector.tcpstat", "")
 	}
+
+	if f.config.ClusterMonitoringConfiguration.NodeExporterConfig.Collectors.NetDev.Enabled {
+		args = setArg(args, "--collector.netdev", "")
+	} else {
+		args = setArg(args, "--no-collector.netdev", "")
+	}
+
 	return args
 }
 

pkg/manifests/manifests_test.go

@@ -2835,9 +2835,13 @@ func TestNodeExporterCollectorSettings(t *testing.T) {
 			name:   "default config",
 			config: "",
 			argsPresent: []string{"--no-collector.cpufreq",
-				"--no-collector.tcpstat"},
+				"--no-collector.tcpstat",
+				"--collector.netdev",
+			},
 			argsAbsent: []string{"--collector.cpufreq",
-				"--collector.tcpstat"},
+				"--collector.tcpstat",
+				"--no-collector.netdev",
+			},
 		},
 		{
 			name: "enable cpufreq collector",
@@ -2861,6 +2865,17 @@ nodeExporter:
 			argsPresent: []string{"--collector.tcpstat"},
 			argsAbsent:  []string{"--no-collector.tcpstat"},
 		},
+		{
+			name: "disable netdev collector",
+			config: `
+nodeExporter:
+  collectors:
+    netdev:
+      enabled: false
+`,
+			argsPresent: []string{"--no-collector.netdev"},
+			argsAbsent:  []string{"--collector.netdev"},
+		},
 	}
 
 	for _, test := range tests {

pkg/manifests/types.go

@@ -264,6 +264,9 @@ type NodeExporterCollectorConfig struct {
 	// Defines the configuration of the `tcpstat` collector, which collects TCP connection statistics.
 	// Disabled by default.
 	TcpStat NodeExporterCollectorTcpStatConfig `json:"tcpstat,omitempty"`
+	// Defines the configuration of the `netdev` collector, which collects network devices statistics.
+	// Enabled by default.
+	NetDev NodeExporterCollectorNetDevConfig `json:"netdev,omitempty"`
 }
 
 // The `NodeExporterCollectorCpufreqConfig` resource works as an on/off switch for
@@ -286,6 +289,32 @@ type NodeExporterCollectorTcpStatConfig struct {
 	Enabled bool `json:"enabled,omitempty"`
 }
 
+// The `NodeExporterCollectorNetDevConfig` resource works as an on/off switch for
+// the `netdev` collector of the `node-exporter` agent.
+// By default, the `netdev` collector is enabled.
+// If disabled, these metrics become unavailable:
+// `node_network_receive_bytes_total`,
+// `node_network_receive_compressed_total`,
+// `node_network_receive_drop_total`,
+// `node_network_receive_errs_total`,
+// `node_network_receive_fifo_total`,
+// `node_network_receive_frame_total`,
+// `node_network_receive_multicast_total`,
+// `node_network_receive_nohandler_total`,
+// `node_network_receive_packets_total`,
+// `node_network_transmit_bytes_total`,
+// `node_network_transmit_carrier_total`,
+// `node_network_transmit_colls_total`,
+// `node_network_transmit_compressed_total`,
+// `node_network_transmit_drop_total`,
+// `node_network_transmit_errs_total`,
+// `node_network_transmit_fifo_total`,
+// `node_network_transmit_packets_total`.
+type NodeExporterCollectorNetDevConfig struct {
+	// A Boolean flag that enables or disables the `netdev` collector.
+	Enabled bool `json:"enabled,omitempty"`
+}
+
 // The `UserWorkloadConfiguration` resource defines the settings
 // responsible for user-defined projects in the
 // `user-workload-monitoring-config` config map  in the

test/e2e/node_exporter_test.go

@@ -83,3 +83,54 @@ nodeExporter:
 	}
 
 }
+
+func TestNodeExporterCollectorDisablement(t *testing.T) {
+	t.Cleanup(func() {
+		f.MustDeleteConfigMap(t, &corev1.ConfigMap{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      clusterMonitorConfigMapName,
+				Namespace: f.Ns,
+			},
+		})
+	})
+
+	tests := []struct {
+		nameCollector string
+		config        string
+	}{
+		{
+			nameCollector: "netdev",
+			config: `
+nodeExporter:
+  collectors:
+    netdev:
+      enabled: false`,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run("Disable Collector: "+test.nameCollector, func(st *testing.T) {
+			f.PrometheusK8sClient.WaitForQueryReturn(
+				t, 5*time.Minute, fmt.Sprintf(`min(node_scrape_collector_success{collector="%s"})`, test.nameCollector),
+				func(v float64) error {
+					if v == 1 {
+						return nil
+					}
+					return fmt.Errorf(`expecting min(node_scrape_collector_success{collector="%s"}) = 1 but got %v.`, test.nameCollector, v)
+				},
+			)
+
+			f.MustCreateOrUpdateConfigMap(t, configMapWithData(t, test.config))
+
+			f.PrometheusK8sClient.WaitForQueryReturn(
+				t, 5*time.Minute, fmt.Sprintf(`absent_over_time(node_scrape_collector_success{collector="%s"}[1m])`, test.nameCollector),
+				func(v float64) error {
+					if v == 0 {
+						return fmt.Errorf(`expecting absent_over_time(node_scrape_collector_success{collector="%s"}[1m])> 0 but got %v.`, test.nameCollector, v)
+					}
+					return nil
+				},
+			)
+		})
+	}
+}