[Heartbeat] Added synthetics step status field (#24206)

Resolves: #24141 Added synthetics.step.status field and relevant mapping, status originally exists in synthetics.payload.status.
elastic · Mar 3, 2021 · 98a1cf7 · 98a1cf7
1 parent 024dd5c
commit 98a1cf7
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 19 deletions.
diff --git a/heartbeat/_meta/fields.common.yml b/heartbeat/_meta/fields.common.yml
@@ -156,6 +156,8 @@
               type: text
             - name: index
               type: integer
+            - name: status
+              type: keyword
         - name: journey
           type: group
           fields:

diff --git a/heartbeat/docs/fields.asciidoc b/heartbeat/docs/fields.asciidoc
@@ -9783,6 +9783,13 @@ type: integer
 
 --
 
+*`synthetics.step.status`*::
++
+--
+type: keyword
+
+--
+
 
 *`synthetics.journey.name`*::
 +

diff --git a/heartbeat/include/fields.go b/heartbeat/include/fields.go
diff --git a/x-pack/heartbeat/include/fields.go b/x-pack/heartbeat/include/fields.go
diff --git a/x-pack/heartbeat/monitors/browser/synthexec/enrich_test.go b/x-pack/heartbeat/monitors/browser/synthexec/enrich_test.go
@@ -49,12 +49,12 @@ func TestJourneyEnricher(t *testing.T) {
 		Journey:              journey,
 		Payload:              common.MapStr{},
 	}
-	makeStepEvent := func(typ string, ts float64, name string, index int, urlstr string, err *SynthError) *SynthEvent {
+	makeStepEvent := func(typ string, ts float64, name string, index int, status string, urlstr string, err *SynthError) *SynthEvent {
 		return &SynthEvent{
 			Type:                 typ,
 			TimestampEpochMicros: 1000 + ts,
 			PackageVersion:       "1.0.0",
-			Step:                 &Step{Name: name, Index: index},
+			Step:                 &Step{Name: name, Index: index, Status: status},
 			Error:                err,
 			Payload:              common.MapStr{},
 			URL:                  urlstr,
@@ -66,12 +66,12 @@ func TestJourneyEnricher(t *testing.T) {
 
 	synthEvents := []*SynthEvent{
 		journeyStart,
-		makeStepEvent("step/start", 10, "Step1", 1, "", nil),
-		makeStepEvent("step/end", 20, "Step1", 1, url1, nil),
-		makeStepEvent("step/start", 21, "Step2", 1, "", nil),
-		makeStepEvent("step/end", 30, "Step2", 1, url2, syntherr),
-		makeStepEvent("step/start", 31, "Step3", 1, "", nil),
-		makeStepEvent("step/end", 40, "Step3", 1, url3, otherErr),
+		makeStepEvent("step/start", 10, "Step1", 1, "succeeded", "", nil),
+		makeStepEvent("step/end", 20, "Step1", 1, "", url1, nil),
+		makeStepEvent("step/start", 21, "Step2", 1, "", "", nil),
+		makeStepEvent("step/end", 30, "Step2", 1, "failed", url2, syntherr),
+		makeStepEvent("step/start", 31, "Step3", 1, "", "", nil),
+		makeStepEvent("step/end", 40, "Step3", 1, "", url3, otherErr),
 		journeyEnd,
 	}
 

diff --git a/x-pack/heartbeat/monitors/browser/synthexec/execmultiplexer_test.go b/x-pack/heartbeat/monitors/browser/synthexec/execmultiplexer_test.go
@@ -33,8 +33,9 @@ func TestExecMultiplexer(t *testing.T) {
 
 		for sIdx := 0; sIdx < 3; sIdx++ {
 			step := &Step{
-				Name:  fmt.Sprintf("S%d", sIdx),
-				Index: sIdx,
+				Name:   fmt.Sprintf("S%d", sIdx),
+				Index:  sIdx,
+				Status: "failed",
 			}
 
 			testEvents = append(testEvents, &SynthEvent{

diff --git a/x-pack/heartbeat/monitors/browser/synthexec/synthexec.go b/x-pack/heartbeat/monitors/browser/synthexec/synthexec.go
@@ -244,6 +244,7 @@ func jsonToSynthEvent(bytes []byte, text string) (res *SynthEvent, err error) {
 
 	res = &SynthEvent{}
 	err = json.Unmarshal(bytes, res)
+
 	if err != nil {
 		return nil, err
 	}

diff --git a/x-pack/heartbeat/monitors/browser/synthexec/synthexec_test.go b/x-pack/heartbeat/monitors/browser/synthexec/synthexec_test.go
@@ -55,7 +55,7 @@ func TestJsonToSynthEvent(t *testing.T) {
 		},
 		{
 			name: "a valid line",
-			line: `{"@timestamp":7165676811882692608,"type":"step/end","journey":{"name":"inline","id":"inline"},"step":{"name":"Go to home page","index":0},"payload":{"source":"async ({page, params}) => {await page.goto('http://www.elastic.co')}","duration_ms":3472,"url":"https://www.elastic.co/","status":"succeeded"},"url":"https://www.elastic.co/","package_version":"0.0.1"}`,
+			line: `{"@timestamp":7165676811882692608,"type":"step/end","journey":{"name":"inline","id":"inline"},"step":{"name":"Go to home page","index":0,"status":"succeeded"},"payload":{"source":"async ({page, params}) => {await page.goto('http://www.elastic.co')}","duration_ms":3472,"url":"https://www.elastic.co/","status":"succeeded"},"url":"https://www.elastic.co/","package_version":"0.0.1"}`,
 			synthEvent: &SynthEvent{
 				TimestampEpochMicros: 7165676811882692608,
 				Type:                 "step/end",
@@ -64,8 +64,9 @@ func TestJsonToSynthEvent(t *testing.T) {
 					Id:   "inline",
 				},
 				Step: &Step{
-					Name:  "Go to home page",
-					Index: 0,
+					Name:   "Go to home page",
+					Index:  0,
+					Status: "succeeded",
 				},
 				Payload: map[string]interface{}{
 					"source":      "async ({page, params}) => {await page.goto('http://www.elastic.co')}",

diff --git a/x-pack/heartbeat/monitors/browser/synthexec/synthtypes.go b/x-pack/heartbeat/monitors/browser/synthexec/synthtypes.go
@@ -95,14 +95,16 @@ func (se *SynthError) toMap() common.MapStr {
 }
 
 type Step struct {
-	Name  string `json:"name"`
-	Index int    `json:"index"`
+	Name   string `json:"name"`
+	Index  int    `json:"index"`
+	Status string `json:"status"`
 }
 
 func (s *Step) ToMap() common.MapStr {
 	return common.MapStr{
-		"name":  s.Name,
-		"index": s.Index,
+		"name":   s.Name,
+		"index":  s.Index,
+		"status": s.Status,
 	}
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -9783,6 +9783,13 @@ type: integer @@
     --
+    *`synthetics.step.status`*::
+    +
+    --
+    type: keyword
+    --
     *`synthetics.journey.name`*::
     +
@@ Expand Down @@