Support for Node.js profiles (#4728)

dgieselaar · web-flow · commit 5a1318b75b21 · 2021-02-18T16:40:04.000+08:00
* Support for Node.js profiles

Implements support for Node.js profiles, by normalizing sample.count to samples.count and adding wall.microseconds as a supported value type.
diff --git a/apmpackage/apm/0.1.0/data_stream/profile_metrics/fields/fields.yml b/apmpackage/apm/0.1.0/data_stream/profile_metrics/fields/fields.yml
@@ -102,6 +102,10 @@
   type: long
   description: |
     Source code line number for the top stack frame.
+- name: profile.wall.us
+  type: long
+  description: |
+    Amount of wall time profiled, in microseconds.
 - name: service.environment
   type: keyword
   description: |
diff --git a/changelogs/head.asciidoc b/changelogs/head.asciidoc
@@ -30,6 +30,7 @@ https://github.com/elastic/apm-server/compare/7.11\...master[View commits]
 * When tail-sampling is enabled, a default policy must be defined {pull}4729[4729]
 * Support additional config options when running under Fleet {pull}4690[4690]
 * Upgrade Go to 1.15.8 {pull}4733[4733]
+* Add support for Node.js wall time profiles {pull}4728[4728]
 
 [float]
 ==== Deprecated
diff --git a/cmd/pprofessor/fetcher.go b/cmd/pprofessor/fetcher.go
@@ -166,6 +166,11 @@ func (f *fetcher) fetchProfile(
 							"field": "profile.cpu.ns",
 						},
 					},
+					"wall_us": map[string]interface{}{
+						"sum": map[string]interface{}{
+							"field": "profile.wall.us",
+						},
+					},
 					"alloc_objects": map[string]interface{}{
 						"sum": map[string]interface{}{
 							"field": "profile.alloc_objects.count",
@@ -257,6 +262,7 @@ func (f *fetcher) fetchProfile(
 				if i == 0 {
 					node.samplesCount += int64(stack.SamplesCount.Value)
 					node.cpuNanos += int64(stack.CPUNanos.Value)
+					node.wallMicros += int64(stack.WallMicros.Value)
 					node.allocObjects += int64(stack.AllocObjects.Value)
 					node.allocSpaceBytes += int64(stack.AllocSpace.Value)
 					node.inuseObjects += int64(stack.InuseObjects.Value)
@@ -285,6 +291,7 @@ func (f *fetcher) fetchProfile(
 		SampleType: []*profile.ValueType{
 			{Type: "samples", Unit: "count"},
 			{Type: "cpu", Unit: "nanoseconds"},
+			{Type: "wall", Unit: "microseconds"},
 			{Type: "alloc_objects", Unit: "count"},
 			{Type: "alloc_space", Unit: "bytes"},
 			{Type: "inuse_objects", Unit: "count"},
@@ -340,6 +347,7 @@ func (f *fetcher) fetchProfile(
 				Value: []int64{
 					node.samplesCount,
 					node.cpuNanos,
+					node.wallMicros,
 					node.allocObjects,
 					node.allocSpaceBytes,
 					node.inuseObjects,
@@ -377,6 +385,7 @@ type aggregationsResult struct {
 			}
 			DocCount     int             `json:"doc_count"`
 			CPUNanos     numericAggValue `json:"cpu_ns"`
+			WallMicros   numericAggValue `json:"wall_us"`
 			AllocObjects numericAggValue `json:"alloc_objects"`
 			AllocSpace   numericAggValue `json:"alloc_space"`
 			InuseObjects numericAggValue `json:"inuse_objects"`
@@ -416,6 +425,7 @@ type profileNode struct {
 
 	samplesCount    int64
 	cpuNanos        int64
+	wallMicros      int64
 	allocObjects    int64
 	allocSpaceBytes int64
 	inuseObjects    int64
diff --git a/docs/fields.asciidoc b/docs/fields.asciidoc
@@ -2206,6 +2206,17 @@ type: long
 --
 
 
+*`profile.wall.us`*::
++
+--
+Amount of wall time profiled, in microseconds.
+
+
+type: long
+
+--
+
+
 *`profile.samples.count`*::
 +
 --
diff --git a/include/fields.go b/include/fields.go
diff --git a/model/profile.go b/model/profile.go
@@ -58,7 +58,14 @@ func (pp PprofProfile) Transform(ctx context.Context, cfg *transform.Config) []b
 	valueFieldNames := make([]string, len(pp.Profile.SampleType))
 	for i, sampleType := range pp.Profile.SampleType {
 		sampleUnit := normalizeUnit(sampleType.Unit)
-		valueFieldNames[i] = sampleType.Type + "." + sampleUnit
+		// Go profiles report samples.count, Node.js profiles report sample.count.
+		// We use samples.count for both so we can aggregate on one field.
+		if sampleType.Type == "sample" || sampleType.Type == "samples" {
+			valueFieldNames[i] = "samples.count"
+		} else {
+			valueFieldNames[i] = sampleType.Type + "." + sampleUnit
+		}
+
 	}
 
 	// Generate a unique profile ID shared by all samples in the profile.
@@ -148,6 +155,9 @@ func normalizeUnit(unit string) string {
 	switch unit {
 	case "nanoseconds":
 		unit = "ns"
+
+	case "microseconds":
+		unit = "us"
 	}
 	return unit
 }
diff --git a/model/profile/_meta/fields.yml b/model/profile/_meta/fields.yml
@@ -619,6 +619,15 @@
               count: 1
               description: >
                 Amount of CPU time profiled, in nanoseconds.
+        
+        - name: wall
+          type: group
+          fields:
+            - name: us
+              type: long
+              count: 1
+              description: >
+                Amount of wall time profiled, in microseconds.
 
         - name: samples
           type: group
diff --git a/model/profile_test.go b/model/profile_test.go
@@ -46,11 +46,13 @@ func TestPprofProfileTransform(t *testing.T) {
 			TimeNanos:     timestamp.UnixNano(),
 			DurationNanos: int64(10 * time.Second),
 			SampleType: []*pprof_profile.ValueType{
+				{Type: "sample", Unit: "count"},
 				{Type: "cpu", Unit: "nanoseconds"},
+				{Type: "wall", Unit: "microseconds"},
 				{Type: "inuse_space", Unit: "bytes"},
 			},
 			Sample: []*pprof_profile.Sample{{
-				Value: []int64{123, 456},
+				Value: []int64{1, 123, 789, 456},
 				Label: map[string][]string{
 					"key1": []string{"abc", "def"},
 					"key2": []string{"ghi"},
@@ -66,7 +68,7 @@ func TestPprofProfileTransform(t *testing.T) {
 					}},
 				}},
 			}, {
-				Value: []int64{123, 456},
+				Value: []int64{1, 123, 789, 456},
 				Label: map[string][]string{
 					"key1": []string{"abc", "def"},
 					"key2": []string{"ghi"},
@@ -112,7 +114,9 @@ func TestPprofProfileTransform(t *testing.T) {
 				"id":                "random",
 				"duration":          int64(10 * time.Second),
 				"cpu.ns":            int64(123),
+				"wall.us":           int64(789),
 				"inuse_space.bytes": int64(456),
+				"samples.count":     int64(1),
 				"top": common.MapStr{
 					"function": "foo",
 					"filename": "foo.go",
