kubeletstats receiver: add working-set and page-fault metrics (#666)

Author: pmcollins

receiver/kubeletstatsreceiver/kubelet/mem.go

@@ -24,6 +24,9 @@ func memMetrics(prefix string, s *stats.MemoryStats) []*metricspb.Metric {
 		memAvailableMetric(prefix, s),
 		memUsageMetric(prefix, s),
 		memRssMetric(prefix, s),
+		memWorkingSetMetric(prefix, s),
+		memPageFaultsMetric(prefix, s),
+		memMajorPageFaultsMetric(prefix, s),
 	}
 }
 
@@ -38,3 +41,15 @@ func memUsageMetric(prefix string, s *stats.MemoryStats) *metricspb.Metric {
 func memRssMetric(prefix string, s *stats.MemoryStats) *metricspb.Metric {
 	return intGauge(prefix+"memory.rss", "By", s.RSSBytes)
 }
+
+func memWorkingSetMetric(prefix string, s *stats.MemoryStats) *metricspb.Metric {
+	return intGauge(prefix+"memory.working_set", "By", s.WorkingSetBytes)
+}
+
+func memPageFaultsMetric(prefix string, s *stats.MemoryStats) *metricspb.Metric {
+	return intGauge(prefix+"memory.page_faults", "1", s.PageFaults)
+}
+
+func memMajorPageFaultsMetric(prefix string, s *stats.MemoryStats) *metricspb.Metric {
+	return intGauge(prefix+"memory.major_page_faults", "1", s.MajorPageFaults)
+}

receiver/kubeletstatsreceiver/kubelet/metrics.go

@@ -27,7 +27,8 @@ func MetricsData(
 	summary *stats.Summary,
 	metadata Metadata,
 	typeStr string,
-	metricGroupsToCollect map[MetricGroup]bool) []*consumerdata.MetricsData {
+	metricGroupsToCollect map[MetricGroup]bool,
+) []*consumerdata.MetricsData {
 	acc := &metricDataAccumulator{
 		metadata:              metadata,
 		logger:                logger,

receiver/kubeletstatsreceiver/kubelet/metrics_test.go

@@ -95,3 +95,65 @@ func TestLabels(t *testing.T) {
 	require.Equal(t, labelValue.Value, "myval")
 	require.True(t, labelValue.HasValue)
 }
+
+func TestWorkingSetMem(t *testing.T) {
+	metrics := indexedFakeMetrics()
+	nodeWsMetrics := metrics["k8s.node.memory.working_set"]
+	wsMetric := nodeWsMetrics[0]
+	value := wsMetric.Timeseries[0].Points[0].Value
+	ptv := value.(*metricspb.Point_Int64Value)
+	require.Equal(t, int64(1234567890), ptv.Int64Value)
+	requireContains(t, metrics, "k8s.pod.memory.working_set")
+	requireContains(t, metrics, "container.memory.working_set")
+}
+
+func TestPageFaults(t *testing.T) {
+	metrics := indexedFakeMetrics()
+	nodePageFaults := metrics["k8s.node.memory.page_faults"]
+	value := nodePageFaults[0].Timeseries[0].Points[0].Value
+	ptv := value.(*metricspb.Point_Int64Value)
+	require.Equal(t, int64(12345), ptv.Int64Value)
+	requireContains(t, metrics, "k8s.pod.memory.page_faults")
+	requireContains(t, metrics, "container.memory.page_faults")
+}
+
+func TestMajorPageFaults(t *testing.T) {
+	metrics := indexedFakeMetrics()
+	nodePageFaults := metrics["k8s.node.memory.major_page_faults"]
+	value := nodePageFaults[0].Timeseries[0].Points[0].Value
+	ptv := value.(*metricspb.Point_Int64Value)
+	require.Equal(t, int64(12), ptv.Int64Value)
+	requireContains(t, metrics, "k8s.pod.memory.major_page_faults")
+	requireContains(t, metrics, "container.memory.major_page_faults")
+}
+
+func requireContains(t *testing.T, metrics map[string][]*metricspb.Metric, metricName string) {
+	_, found := metrics[metricName]
+	require.True(t, found)
+}
+
+func indexedFakeMetrics() map[string][]*metricspb.Metric {
+	mds := fakeMetrics()
+	metrics := make(map[string][]*metricspb.Metric)
+	for _, md := range mds {
+		for _, metric := range md.Metrics {
+			metricName := metric.MetricDescriptor.Name
+			list := metrics[metricName]
+			list = append(list, metric)
+			metrics[metricName] = list
+		}
+	}
+	return metrics
+}
+
+func fakeMetrics() []*consumerdata.MetricsData {
+	rc := &fakeRestClient{}
+	statsProvider := NewStatsProvider(rc)
+	summary, _ := statsProvider.StatsSummary()
+	mgs := map[MetricGroup]bool{
+		ContainerMetricGroup: true,
+		PodMetricGroup:       true,
+		NodeMetricGroup:      true,
+	}
+	return MetricsData(zap.NewNop(), summary, Metadata{}, "foo", mgs)
+}

receiver/kubeletstatsreceiver/testdata/stats-summary.json

@@ -65,10 +65,10 @@
       "time": "2020-04-20T22:52:27Z",
       "availableBytes": 2620624896,
       "usageBytes": 3608727552,
-      "workingSetBytes": 1410809856,
+      "workingSetBytes": 1234567890,
       "rssBytes": 607125504,
-      "pageFaults": 24915,
-      "majorPageFaults": 0
+      "pageFaults": 12345,
+      "majorPageFaults": 12
     },
     "network": {
       "time": "2020-04-20T22:52:27Z",