Calculate memory.working_set.limit.pct for pod and container metricset (

#29547) * Calculate memory.working_set.limit.pct for pod and container metricset
elastic · Dec 21, 2021 · 7941c1c · 7941c1c
1 parent e6e65aa
commit 7941c1c
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 8 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -145,6 +145,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 - Preliminary AIX support {pull}27954[27954]
 - Add option to skip older k8s events {pull}29396[29396]
 - Add `add_resource_metadata` configuration to Kubernetes module. {pull}29133[29133]
+- Add `memory.workingset.limit.pct` field in Kubernetes container/pod metricset. {pull}29547[29547]
 
 *Packetbeat*
 

diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -41959,6 +41959,18 @@ format: bytes
 
 --
 
+*`kubernetes.container.memory.workingset.limit.pct`*::
++
+--
+Working set memory usage as a percentage of the defined limit for the container (or total node allocatable memory if unlimited)
+
+
+type: scaled_float
+
+format: percent
+
+--
+
 *`kubernetes.container.memory.pagefaults`*::
 +
 --
@@ -43023,6 +43035,18 @@ format: bytes
 
 --
 
+*`kubernetes.pod.memory.working_set.limit.pct`*::
++
+--
+Working set memory usage as a percentage of the defined limit for the pod containers (or total node allocatable memory if unlimited)
+
+
+type: scaled_float
+
+format: percent
+
+--
+
 
 *`kubernetes.pod.memory.rss.bytes`*::
 +

diff --git a/metricbeat/module/kubernetes/container/_meta/fields.yml b/metricbeat/module/kubernetes/container/_meta/fields.yml
@@ -126,6 +126,11 @@
               format: bytes
               description: >
                 Working set memory usage
+            - name: limit.pct
+              type: scaled_float
+              format: percent
+              description: >
+                Working set memory usage as a percentage of the defined limit for the container (or total node allocatable memory if unlimited)
         - name: pagefaults
           type: double
           description: >

diff --git a/metricbeat/module/kubernetes/container/container_test.go b/metricbeat/module/kubernetes/container/container_test.go
@@ -69,10 +69,11 @@ func TestEventMapping(t *testing.T) {
 		"memory.majorpagefaults":  0,
 
 		// calculated pct fields:
-		"cpu.usage.node.pct":     0.005631997,
-		"cpu.usage.limit.pct":    0.005631997,
-		"memory.usage.node.pct":  0.01,
-		"memory.usage.limit.pct": 0.1,
+		"cpu.usage.node.pct":          0.005631997,
+		"cpu.usage.limit.pct":         0.005631997,
+		"memory.usage.node.pct":       0.01,
+		"memory.usage.limit.pct":      0.1,
+		"memory.workingset.limit.pct": 0.09943977591036414,
 
 		"name": "nginx",
 

diff --git a/metricbeat/module/kubernetes/container/data.go b/metricbeat/module/kubernetes/container/data.go
@@ -135,6 +135,7 @@ func eventMapping(content []byte, perfMetrics *util.PerfMetricsCache) ([]common.
 
 			if memLimit > 0 {
 				containerEvent.Put("memory.usage.limit.pct", float64(container.Memory.UsageBytes)/memLimit)
+				containerEvent.Put("memory.workingset.limit.pct", float64(container.Memory.WorkingSetBytes)/memLimit)
 			}
 
 			events = append(events, containerEvent)

diff --git a/metricbeat/module/kubernetes/fields.go b/metricbeat/module/kubernetes/fields.go
diff --git a/metricbeat/module/kubernetes/pod/_meta/fields.yml b/metricbeat/module/kubernetes/pod/_meta/fields.yml
@@ -94,6 +94,11 @@
               format: bytes
               description: >
                 Total working set memory
+            - name: limit.pct
+              type: scaled_float
+              format: percent
+              description: >
+                Working set memory usage as a percentage of the defined limit for the pod containers (or total node allocatable memory if unlimited)
         - name: rss
           type: group
           fields:

diff --git a/metricbeat/module/kubernetes/pod/data.go b/metricbeat/module/kubernetes/pod/data.go
@@ -128,6 +128,8 @@ func eventMapping(content []byte, perfMetrics *util.PerfMetricsCache) ([]common.
 			}
 			if memLimit > 0 {
 				podEvent.Put("memory.usage.limit.pct", float64(usageMem)/memLimit)
+				podEvent.Put("memory.working_set.limit.pct", float64(workingSet)/memLimit)
+
 			}
 		}
 
@@ -137,6 +139,7 @@ func eventMapping(content []byte, perfMetrics *util.PerfMetricsCache) ([]common.
 			}
 			if memLimit > 0 {
 				podEvent.Put("memory.usage.limit.pct", float64(workingSet)/memLimit)
+				podEvent.Put("memory.working_set.limit.pct", float64(workingSet)/memLimit)
 			}
 		}
 

diff --git a/metricbeat/module/kubernetes/pod/pod_test.go b/metricbeat/module/kubernetes/pod/pod_test.go
@@ -64,9 +64,10 @@ func TestEventMapping(t *testing.T) {
 		"cpu.usage.node.pct":  0.005631997,
 		"cpu.usage.limit.pct": 0.005631997,
 
-		"memory.usage.bytes":     1462272,
-		"memory.usage.node.pct":  0.01,
-		"memory.usage.limit.pct": 0.1,
+		"memory.usage.bytes":           1462272,
+		"memory.usage.node.pct":        0.01,
+		"memory.usage.limit.pct":       0.1,
+		"memory.working_set.limit.pct": 0.09943977591036414,
 	}
 
 	for k, v := range testCases {