Skip to content

ENG-37132: Adding bodyAttribute functions to support already truncated bodies #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanericson merged 2 commits into from
Nov 11, 2023
Merged

ENG-37132: Adding bodyAttribute functions to support already truncated bodies #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f98475
ENG-37132: Adding bodyAttribute functions to support already truncate…
puneet-traceable Nov 10, 2023
e3beab5
adding tests and refactoring
puneet-traceable Nov 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions sdk/instrumentation/bodyattribute/bodyattribute.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,55 @@ func SetTruncatedBodyAttribute(attrName string, body []byte, bodyMaxSize int, sp
}

if bodyLen <= bodyMaxSize {
span.SetAttribute(attrName, string(body))
SetBodyAttribute(attrName, body, false, span)
return
}

truncatedBody := body[:bodyMaxSize]
span.SetAttribute(fmt.Sprintf("%s.truncated", attrName), true)
span.SetAttribute(attrName, string(truncatedBody))
SetBodyAttribute(attrName, body[:bodyMaxSize], true, span)
}

// SetTruncatedEncodedBodyAttribute is like SetTruncatedBodyAttribute above but also base64 encodes the
// body. This is usually due to non utf8 bytes in the body eg. for multipart/form-data content type.
// The body attribute name has a ".base64" suffix.
func SetTruncatedEncodedBodyAttribute(attrName string, body []byte, bodyMaxSize int, span sdk.Span) {
bodyLen := len(body)
if bodyLen == 0 {
if len(body) == 0 {
Copy link
Copy Markdown
Collaborator

@tim-mwangi tim-mwangi Nov 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not use the variable bodyLen?

Copy link
Copy Markdown
Contributor Author

@puneet-traceable puneet-traceable Nov 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will fix it, missed it in a revert.

return
}

if bodyLen <= bodyMaxSize {
span.SetAttribute(attrName+".base64", base64.RawStdEncoding.EncodeToString(body))
SetEncodedBodyAttribute(attrName, body, false, span)
return
}

SetEncodedBodyAttribute(attrName, body[:bodyMaxSize], true, span)
}

// SetBodyAttribute sets the body as a span attribute.
// also sets truncated attribute if truncated is true
func SetBodyAttribute(attrName string, body []byte, truncated bool, span sdk.Span) {
if len(body) == 0 {
return
}

truncatedBody := body[:bodyMaxSize]
span.SetAttribute(fmt.Sprintf("%s.truncated", attrName), true)
span.SetAttribute(attrName+".base64", base64.RawStdEncoding.EncodeToString(truncatedBody))
span.SetAttribute(attrName, string(body))
// if already truncated then set attribute
if truncated {
span.SetAttribute(fmt.Sprintf("%s.truncated", attrName), true)
}
}

// SetEncodedBodyAttribute is like SetBodyAttribute above but also base64 encodes the
// body. This is usually due to non utf8 bytes in the body eg. for multipart/form-data content type.
// The body attribute name has a ".base64" suffix.
func SetEncodedBodyAttribute(attrName string, body []byte, truncated bool, span sdk.Span) {
if len(body) == 0 {
return
}

span.SetAttribute(attrName+".base64", base64.RawStdEncoding.EncodeToString(body))
// if already truncated then set attribute
if truncated {
span.SetAttribute(fmt.Sprintf("%s.truncated", attrName), true)
}
}
148 changes: 148 additions & 0 deletions sdk/instrumentation/bodyattribute/bodyattribute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,151 @@ func TestSetTruncatedEncodedBodyAttributeEmptyBody(t *testing.T) {
assert.Nil(t, s.ReadAttribute("http.request.body.base64"))
assert.Zero(t, s.RemainingAttributes())
}

func TestSetBodyAttribute(t *testing.T) {
testBody := "test1test2"
type args struct {
attrName string
body []byte
truncated bool
span *mock.Span
}
tests := []struct {
name string
args args
expectedAssertions func(t *testing.T, gotSpan *mock.Span)
}{
{
name: "empty body, truncated",
args: args{
attrName: "http.request.body",
body: []byte(""),
truncated: true,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Nil(t, gotSpan.ReadAttribute("http.request.body"))
assert.Zero(t, gotSpan.RemainingAttributes())
},
},
{
name: "empty body, not truncated",
args: args{
attrName: "http.request.body",
body: []byte(""),
truncated: false,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Nil(t, gotSpan.ReadAttribute("http.request.body"))
assert.Zero(t, gotSpan.RemainingAttributes())
},
},
{
name: "non empty body, not truncated",
args: args{
attrName: "http.request.body",
body: []byte(testBody),
truncated: false,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Equal(t, testBody, gotSpan.ReadAttribute("http.request.body"))
assert.Zero(t, gotSpan.RemainingAttributes())
},
},
{
name: "non empty body, truncated",
args: args{
attrName: "http.request.body",
body: []byte(testBody),
truncated: true,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Equal(t, testBody, gotSpan.ReadAttribute("http.request.body"))
assert.True(t, (gotSpan.ReadAttribute("http.request.body.truncated")).(bool))
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
SetBodyAttribute(tt.args.attrName, tt.args.body, tt.args.truncated, tt.args.span)
tt.expectedAssertions(t, tt.args.span)
})
}
}

func TestSetEncodedBodyAttribute(t *testing.T) {
testBody := "test1test2"
type args struct {
attrName string
body []byte
truncated bool
span *mock.Span
}
tests := []struct {
name string
args args
expectedAssertions func(t *testing.T, gotSpan *mock.Span)
}{
{
name: "empty body, truncated",
args: args{
attrName: "http.request.body",
body: []byte(""),
truncated: true,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Nil(t, gotSpan.ReadAttribute("http.request.body.base64"))
assert.Zero(t, gotSpan.RemainingAttributes())
},
},
{
name: "empty body, not truncated",
args: args{
attrName: "http.request.body",
body: []byte(""),
truncated: false,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Nil(t, gotSpan.ReadAttribute("http.request.body.base64"))
assert.Zero(t, gotSpan.RemainingAttributes())
},
},
{
name: "non empty body, not truncated",
args: args{
attrName: "http.request.body",
body: []byte(testBody),
truncated: false,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Equal(t, base64.RawStdEncoding.EncodeToString([]byte(testBody)), gotSpan.ReadAttribute("http.request.body.base64"))
assert.Zero(t, gotSpan.RemainingAttributes())
},
},
{
name: "non empty body, truncated",
args: args{
attrName: "http.request.body",
body: []byte(testBody),
truncated: true,
span: mock.NewSpan(),
},
expectedAssertions: func(t *testing.T, gotSpan *mock.Span) {
assert.Equal(t, base64.RawStdEncoding.EncodeToString([]byte(testBody)), gotSpan.ReadAttribute("http.request.body.base64"))
assert.True(t, (gotSpan.ReadAttribute("http.request.body.truncated")).(bool))
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
SetEncodedBodyAttribute(tt.args.attrName, tt.args.body, tt.args.truncated, tt.args.span)
tt.expectedAssertions(t, tt.args.span)
})
}
}