Add field for span http request body to IntakeV2 (#366)

JonasKunz · web-flow · commit 560cc4b604ed · 2024-12-20T21:16:50.000Z
* Added intakeV2 context.http.request.body field

* Added body to existing modeljson test

* Switch body from string to any value (string or dictionary)

* Switch field order for lint
diff --git a/input/elasticapm/docs/spec/v2/span.json b/input/elasticapm/docs/spec/v2/span.json
@@ -188,6 +188,9 @@
                 "object"
               ],
               "properties": {
+                "body": {
+                  "description": "The http request body usually as a string, but may be a dictionary for multipart/form-data content"
+                },
                 "id": {
                   "description": "ID holds the unique identifier for the http request.",
                   "type": [
diff --git a/input/elasticapm/internal/modeldecoder/v2/decoder.go b/input/elasticapm/internal/modeldecoder/v2/decoder.go
@@ -1071,14 +1071,19 @@ func mapToSpanModel(from *span, event *modelpb.APMEvent) {
 			}
 			event.Http.Request.Method = from.Context.HTTP.Method.Val
 		}
-		if from.Context.HTTP.Request.ID.IsSet() {
+		if from.Context.HTTP.Request.IsSet() {
 			if event.Http == nil {
 				event.Http = &modelpb.HTTP{}
 			}
 			if event.Http.Request == nil {
 				event.Http.Request = &modelpb.HTTPRequest{}
 			}
-			event.Http.Request.Id = from.Context.HTTP.Request.ID.Val
+			if from.Context.HTTP.Request.ID.IsSet() {
+				event.Http.Request.Id = from.Context.HTTP.Request.ID.Val
+			}
+			if from.Context.HTTP.Request.Body.IsSet() {
+				event.Http.Request.Body = modeldecoderutil.ToValue(from.Context.HTTP.Request.Body.Val)
+			}
 		}
 		if from.Context.HTTP.Response.IsSet() {
 			if event.Http == nil {
diff --git a/input/elasticapm/internal/modeldecoder/v2/model.go b/input/elasticapm/internal/modeldecoder/v2/model.go
@@ -843,6 +843,8 @@ type spanContextHTTP struct {
 }
 
 type spanContextHTTPRequest struct {
+	// The http request body usually as a string, but may be a dictionary for multipart/form-data content
+	Body nullable.Interface `json:"body"`
 	// ID holds the unique identifier for the http request.
 	ID nullable.String `json:"id"`
 }
diff --git a/input/elasticapm/internal/modeldecoder/v2/model_generated.go b/input/elasticapm/internal/modeldecoder/v2/model_generated.go
diff --git a/input/elasticapm/internal/modeldecoder/v2/span_test.go b/input/elasticapm/internal/modeldecoder/v2/span_test.go
@@ -25,6 +25,8 @@ import (
 	"testing"
 	"time"
 
+	"google.golang.org/protobuf/types/known/structpb"
+
 	"github.com/google/go-cmp/cmp"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -258,14 +260,22 @@ func TestDecodeMapToSpanModel(t *testing.T) {
 		}
 	})
 
-	t.Run("http-request", func(t *testing.T) {
+	t.Run("http-request-id", func(t *testing.T) {
 		var input span
 		input.Context.HTTP.Request.ID.Set("some-request-id")
 		var out modelpb.APMEvent
 		mapToSpanModel(&input, &out)
 		assert.Equal(t, "some-request-id", out.Http.Request.Id)
 	})
 
+	t.Run("http-request-body", func(t *testing.T) {
+		var input span
+		input.Context.HTTP.Request.Body.Set("some-request-body")
+		var out modelpb.APMEvent
+		mapToSpanModel(&input, &out)
+		assert.Equal(t, structpb.NewStringValue("some-request-body"), out.Http.Request.Body)
+	})
+
 	t.Run("http-headers", func(t *testing.T) {
 		var input span
 		input.Context.HTTP.Response.Headers.Set(http.Header{"a": []string{"b", "c"}})
diff --git a/model/modeljson/http.pb.json_test.go b/model/modeljson/http.pb.json_test.go
@@ -20,6 +20,8 @@ package modeljson
 import (
 	"testing"
 
+	"google.golang.org/protobuf/types/known/structpb"
+
 	modeljson "github.com/elastic/apm-data/model/modeljson/internal"
 	"github.com/elastic/apm-data/model/modelpb"
 	"github.com/google/go-cmp/cmp"
@@ -51,6 +53,7 @@ func TestHTTPToModelJSON(t *testing.T) {
 					Id:       "id",
 					Method:   "method",
 					Referrer: "referrer",
+					Body:     structpb.NewStringValue("request-body"),
 				},
 			},
 			expected: &modeljson.HTTP{
@@ -61,6 +64,9 @@ func TestHTTPToModelJSON(t *testing.T) {
 					ID:       "id",
 					Method:   "method",
 					Referrer: "referrer",
+					Body: &modeljson.HTTPRequestBody{
+						Original: "request-body",
+					},
 				},
 			},
 		},

Original file line number	Diff line number	Diff line change
`@@ -1071,14 +1071,19 @@ func mapToSpanModel(from span, event modelpb.APMEvent) {`
`1071`	`1071`	`}`
`1072`	`1072`	`event.Http.Request.Method = from.Context.HTTP.Method.Val`
`1073`	`1073`	`}`
`1074`		`- if from.Context.HTTP.Request.ID.IsSet() {`
	`1074`	`+ if from.Context.HTTP.Request.IsSet() {`
`1075`	`1075`	`if event.Http == nil {`
`1076`	`1076`	`event.Http = &modelpb.HTTP{}`
`1077`	`1077`	`}`
`1078`	`1078`	`if event.Http.Request == nil {`
`1079`	`1079`	`event.Http.Request = &modelpb.HTTPRequest{}`
`1080`	`1080`	`}`
`1081`		`- event.Http.Request.Id = from.Context.HTTP.Request.ID.Val`
	`1081`	`+ if from.Context.HTTP.Request.ID.IsSet() {`
	`1082`	`+ event.Http.Request.Id = from.Context.HTTP.Request.ID.Val`
	`1083`	`+ }`
	`1084`	`+ if from.Context.HTTP.Request.Body.IsSet() {`
	`1085`	`+ event.Http.Request.Body = modeldecoderutil.ToValue(from.Context.HTTP.Request.Body.Val)`
	`1086`	`+ }`
`1082`	`1087`	`}`
`1083`	`1088`	`if from.Context.HTTP.Response.IsSet() {`
`1084`	`1089`	`if event.Http == nil {`
Original file line number	Diff line number	Diff line change
`@@ -843,6 +843,8 @@ type spanContextHTTP struct {`
`843`	`843`	`}`
`844`	`844`
`845`	`845`	`type spanContextHTTPRequest struct {`
	`846`	`+ // The http request body usually as a string, but may be a dictionary for multipart/form-data content`
	`847`	+ Body nullable.Interface `json:"body"`
`846`	`848`	`// ID holds the unique identifier for the http request.`
`847`	`849`	ID nullable.String `json:"id"`
`848`	`850`	`}`