Skip to content
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

contrib/net/http: Make DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING false by default #3010

Merged
merged 4 commits into from
Dec 9, 2024
Merged

contrib/net/http: Make DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING false by default #3010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b820f28
disable by default
mtoffl01 Dec 5, 2024
2baf82f
update grpc tests (which for some reason check http.url tag on http.c…
mtoffl01 Dec 5, 2024
a5b4b0e
Merge branch 'main' into mtoff/disalbe-client-querystring
darccio Dec 9, 2024
76a4875
Merge branch 'main' into mtoff/disalbe-client-querystring
mtoffl01 Dec 9, 2024
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
8 changes: 4 additions & 4 deletions contrib/google.golang.org/api/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ func TestBooks(t *testing.T) {
assert.Equal(t, "books.bookshelves.list", s0.Tag(ext.ResourceName))
assert.Equal(t, "400", s0.Tag(ext.HTTPCode))
assert.Equal(t, "GET", s0.Tag(ext.HTTPMethod))
assert.Equal(t, svc.BasePath+"books/v1/users/montana.banana/bookshelves?alt=json&prettyPrint=false", s0.Tag(ext.HTTPURL))
assert.Equal(t, svc.BasePath+"books/v1/users/montana.banana/bookshelves", s0.Tag(ext.HTTPURL))
assert.Equal(t, "google.golang.org/api", s0.Tag(ext.Component))
assert.Equal(t, ext.SpanKindClient, s0.Tag(ext.SpanKind))
}
Expand All @@ -88,7 +88,7 @@ func TestCivicInfo(t *testing.T) {
assert.Equal(t, "civicinfo.representatives.representativeInfoByAddress", s0.Tag(ext.ResourceName))
assert.Equal(t, "400", s0.Tag(ext.HTTPCode))
assert.Equal(t, "GET", s0.Tag(ext.HTTPMethod))
assert.Equal(t, svc.BasePath+"civicinfo/v2/representatives?alt=json&prettyPrint=false", s0.Tag(ext.HTTPURL))
assert.Equal(t, svc.BasePath+"civicinfo/v2/representatives", s0.Tag(ext.HTTPURL))
assert.Equal(t, "google.golang.org/api", s0.Tag(ext.Component))
assert.Equal(t, ext.SpanKindClient, s0.Tag(ext.SpanKind))
}
Expand All @@ -115,7 +115,7 @@ func TestURLShortener(t *testing.T) {
assert.Equal(t, "urlshortener.url.list", s0.Tag(ext.ResourceName))
assert.Equal(t, "400", s0.Tag(ext.HTTPCode))
assert.Equal(t, "GET", s0.Tag(ext.HTTPMethod))
assert.Equal(t, "https://www.googleapis.com/urlshortener/v1/url/history?alt=json&prettyPrint=false", s0.Tag(ext.HTTPURL))
assert.Equal(t, "https://www.googleapis.com/urlshortener/v1/url/history", s0.Tag(ext.HTTPURL))
assert.Equal(t, "google.golang.org/api", s0.Tag(ext.Component))
assert.Equal(t, ext.SpanKindClient, s0.Tag(ext.SpanKind))
}
Expand All @@ -140,7 +140,7 @@ func TestWithEndpointMetadataDisabled(t *testing.T) {
assert.Equal(t, "GET civicinfo.googleapis.com", s0.Tag(ext.ResourceName))
assert.Equal(t, "400", s0.Tag(ext.HTTPCode))
assert.Equal(t, "GET", s0.Tag(ext.HTTPMethod))
assert.Equal(t, svc.BasePath+"civicinfo/v2/representatives?alt=json&prettyPrint=false", s0.Tag(ext.HTTPURL))
assert.Equal(t, svc.BasePath+"civicinfo/v2/representatives", s0.Tag(ext.HTTPURL))
assert.Equal(t, "google.golang.org/api", s0.Tag(ext.Component))
assert.Equal(t, ext.SpanKindClient, s0.Tag(ext.SpanKind))
}
Expand Down
2 changes: 1 addition & 1 deletion contrib/net/http/option.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ func newRoundTripperConfig() *roundTripperConfig {
propagation: true,
spanNamer: defaultSpanNamer,
ignoreRequest: func(_ *http.Request) bool { return false },
queryString: internal.BoolEnv(envClientQueryStringEnabled, true),
queryString: internal.BoolEnv(envClientQueryStringEnabled, false),
isStatusError: isClientError,
}
v := os.Getenv(envClientErrorStatuses)
Expand Down
18 changes: 8 additions & 10 deletions contrib/net/http/roundtripper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,19 +579,19 @@ func TestClientQueryString(t *testing.T) {
client := &http.Client{
Transport: rt,
}
resp, err := client.Get(s.URL + "/hello/world?querystring=xyz")
resp, err := client.Get(s.URL + "/hello/world?API_KEY=1234")
assert.Nil(t, err)
defer resp.Body.Close()
spans := mt.FinishedSpans()
assert.Len(t, spans, 1)

assert.Regexp(t, regexp.MustCompile(`^http://.*?/hello/world\?querystring=xyz$`), spans[0].Tag(ext.HTTPURL))
assert.Regexp(t, regexp.MustCompile(`^http://.*?/hello/world$`), spans[0].Tag(ext.HTTPURL))
})
t.Run("false", func(t *testing.T) {
t.Run("true", func(t *testing.T) {
mt := mocktracer.Start()
defer mt.Stop()

os.Setenv("DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING", "false")
os.Setenv("DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING", "true")
defer os.Unsetenv("DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING")

rt := WrapRoundTripper(http.DefaultTransport)
Expand All @@ -604,29 +604,27 @@ func TestClientQueryString(t *testing.T) {
spans := mt.FinishedSpans()
assert.Len(t, spans, 1)

assert.Regexp(t, regexp.MustCompile(`^http://.*?/hello/world$`), spans[0].Tag(ext.HTTPURL))
assert.Regexp(t, regexp.MustCompile(`^http://.*?/hello/world\?querystring=xyz$`), spans[0].Tag(ext.HTTPURL))
})
// DD_TRACE_HTTP_URL_QUERY_STRING_DISABLED applies only to server spans, not client
t.Run("Not impacted by DD_TRACE_HTTP_URL_QUERY_STRING_DISABLED", func(t *testing.T) {
mt := mocktracer.Start()
defer mt.Stop()

os.Setenv("DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING", "true")
os.Setenv("DD_TRACE_HTTP_URL_QUERY_STRING_DISABLED", "true")
defer os.Unsetenv("DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING")
os.Setenv("DD_TRACE_HTTP_URL_QUERY_STRING_DISABLED", "false")
defer os.Unsetenv("DD_TRACE_HTTP_URL_QUERY_STRING_DISABLED")

rt := WrapRoundTripper(http.DefaultTransport)
client := &http.Client{
Transport: rt,
}
resp, err := client.Get(s.URL + "/hello/world?querystring=xyz")
resp, err := client.Get(s.URL + "/hello/world?API_KEY=1234")
assert.Nil(t, err)
defer resp.Body.Close()
spans := mt.FinishedSpans()
assert.Len(t, spans, 1)

assert.Contains(t, spans[0].Tag(ext.HTTPURL), "/hello/world?querystring=xyz")
assert.Regexp(t, regexp.MustCompile(`^http://.*?/hello/world$`), spans[0].Tag(ext.HTTPURL))
})
}

Expand Down
Loading