feat: http client integration #876

aldy505 · 2024-08-27T02:04:00Z

An effort to implement this: https://develop.sentry.dev/sdk/telemetry/traces/modules/requests/

Since we already have tracing without performance, this should be good to go.

codecov · 2024-08-27T02:07:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.41%. Comparing base (9b8b7be) to head (2cb97af).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #876      +/-   ##
==========================================
+ Coverage   83.21%   83.41%   +0.20%     
==========================================
  Files          55       56       +1     
  Lines        5897     5970      +73     
==========================================
+ Hits         4907     4980      +73     
  Misses        820      820              
  Partials      170      170

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

ribice · 2024-09-03T10:06:14Z

@aldy505 We should document this (in _examples, and perhaps sentry-docs?), and also update changelog accordingly.

ribice · 2024-09-03T10:09:02Z

httpclient/sentryhttpclient.go

+
+	span := sentry.StartSpan(ctx, "http.client", sentry.WithTransactionName(fmt.Sprintf("%s %s", request.Method, cleanRequestURL)))
+
+	for k, v := range s.tags {


Could we just set the span.Tags instead of ranging through these, and setting one by one?

This is the 'right' way to do it, but it involves checking for nil map and dealing with mutex.

Lol good catch. I was copying directly from this PR aldy505/sentry-integration#1

cleptric · 2024-09-03T16:31:15Z

httpclient/sentryhttpclient.go

+	span := sentry.StartSpan(ctx, "http.client", sentry.WithTransactionName(fmt.Sprintf("%s %s", request.Method, cleanRequestURL)))
+	span.Tags = s.tags
+	defer span.Finish()


We do not want to always start transactions here. If one already exists, start a child span.

Just to be clear: http.client spans should only created if there is any parent span?

Yes, Sentry does not work well with these kind of single span transactions. We can revisit this once span streaming is fully supported in the product, but this will take a few months.

https://sentry.io/insights/http/ should also work with these spans fwiw, docs are here.

*which you already mentioned in the PR description, nvm

Another question (unrelated): Does that also affects all the span op within the insights module? Meaning not only http.client, but db.sql and messaging.* also counts?

I guess technically we extract all the required fields from a transaction and store it into the span data set, though this is not how these modules where initially designed to work.

aldy505 · 2024-09-21T03:07:31Z

httpclient/sentryhttpclient.go

+	// Only create the `http.client` span only if there is a parent span.
+	parentSpan := sentry.GetSpanFromContext(request.Context())
+	if parentSpan == nil {
+		return s.originalRoundTripper.RoundTrip(request)
+	}


A quick note why I prefer this instead of creating a sentry.WithOnlyIfParentExists() (a SpanOption type):

I used the JS SDK a lot at work lately, and I've been wondering the entire week, on their startSpan function, they have this as an option: https://github.com/getsentry/sentry-javascript/blob/216aaeba1ee27cce8a4876e1f9212ba374eb30b3/packages/types/src/startSpanOptions.ts#L14-L15

Should the Go SDK move forward with that, as a SpanOption or not?

We could to the SpanOption thing, but it feels really weird since the way Go SDK handles scopes/hubs with span is to add the span pointer into the scope. See

sentry-go/tracing.go

Lines 196 to 199 in a6acd05

if clientOptions.EnableTracing {

hub := hubFromContext(ctx)

hub.Scope().SetSpan(&span)

}

Although we could just not call the scope.SetSpan() function, I don't know about the behavior if this span that we're creating will ever have a child span being created manually by the user.

cleptric · 2024-10-29T07:50:04Z

httpclient/sentryhttpclient.go

+	// Always add `Baggage` and `Sentry-Trace` headers.
+	request.Header.Add("Baggage", span.ToBaggage())
+	request.Header.Add("Sentry-Trace", span.ToSentryTrace())


To support the recently added "Tracing without Performance" feature, we should use hub.GetTraceparent() and hub.GetBaggage()

cleptric · 2024-10-29T07:52:30Z

httpclient/sentryhttpclient.go

+	cleanRequestURL := request.URL.Redacted()
+
+	span := parentSpan.StartChild("http.client", sentry.WithTransactionName(fmt.Sprintf("%s %s", request.Method, cleanRequestURL)))
+	span.Tags = s.tags


Why are we setting span tags here?

Is it not ideal? Should I remove it?

What info is in there?

Decided to just remove it.

cleptric · 2024-10-29T07:53:59Z

httpclient/sentryhttpclient.go

+	tags map[string]string
+}
+
+func (s *SentryRoundTripper) RoundTrip(request *http.Request) (*http.Response, error) {


We need to add a new ClientOption for https://develop.sentry.dev/sdk/telemetry/traces/#tracepropagationtargets

When I wrote this, the docs said trace propagation targets is only for avoiding CORS-related issue, and since the dotnet SDK does not have that option too, I don't implement it here.

But is my assumption wrong here? Should all SDK implements trace propagation targets then?

cleptric · 2024-10-29T07:54:15Z

httpclient/sentryhttpclient.go

+	request.Header.Add("Baggage", span.ToBaggage())
+	request.Header.Add("Sentry-Trace", span.ToSentryTrace())
+
+	response, err := s.originalRoundTripper.RoundTrip(request)


We also want to handle the err case

cleptric · 2024-11-06T14:39:52Z

client.go

+	// Control with URLs trace propagation should be enabled. Does not support regex patterns.
+	TracePropagationTargets []string
+	// When set to true, the SDK will start a span for outgoing HTTP OPTIONS requests.
+	TraceOptionsRequests bool


Why did you add this option?

Saw it on the dev docs. Should I not implement that?

Here: https://develop.sentry.dev/sdk/telemetry/traces/#traceoptionsrequests

When set to true transactions should be created for HTTP OPTIONS requests.

This option does not apply to outgoing HTTP requests.

Okay. Will update that later.

aldy505 added 2 commits August 27, 2024 09:01

feat: http client integration

6b48923

chore(httpclient): variable naming according to linter

fd66575

cleptric added the Type: Feature label Sep 3, 2024

cleptric requested a review from ribice September 3, 2024 09:24

ribice reviewed Sep 3, 2024

View reviewed changes

aldy505 added 4 commits September 3, 2024 20:44

Merge branch 'master' into feat/httpclient

439e98b

chore: add changelog entry

5f4c5ae

fix(httpclient): dont iterate over map

5214ea5

feat(examples): add httpclient

ed105c1

aldy505 requested a review from ribice September 3, 2024 14:04

Merge branch 'master' into feat/httpclient

4e55daa

cleptric requested changes Sep 3, 2024

View reviewed changes

aldy505 added 2 commits September 4, 2024 08:04

feat(spans): only start 'http.client' op as a child span

15aa59a

chore: lint

099dad4

aldy505 requested a review from cleptric September 4, 2024 01:06

Merge branch 'master' into feat/httpclient

7d9555d

aldy505 commented Sep 21, 2024

View reviewed changes

aldy505 added 2 commits October 18, 2024 17:23

chore: remove GetSpanFromContext and replace it with SpanFromContext

f018dde

Merge branch 'master' into feat/httpclient

d6f2663

cleptric reviewed Oct 29, 2024

View reviewed changes

aldy505 added 3 commits November 2, 2024 18:53

feat(httpclient): use baggage and traceparent from hub

6af10bf

Merge remote-tracking branch 'origin/master' into feat/httpclient

c5ad7e4

feat(httpclient): trace propagation targets

081fc0b

aldy505 requested a review from cleptric November 6, 2024 13:59

cleptric reviewed Nov 6, 2024

View reviewed changes

chore: remove trace options request

a3a6367

aldy505 requested a review from cleptric November 16, 2024 11:02

Merge branch 'master' into feat/httpclient

2cb97af

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: http client integration #876

feat: http client integration #876

aldy505 commented Aug 27, 2024

codecov bot commented Aug 27, 2024 •

edited

Loading

ribice commented Sep 3, 2024

ribice Sep 3, 2024

aldy505 Sep 3, 2024

cleptric Sep 3, 2024

aldy505 Sep 3, 2024

cleptric Sep 3, 2024

aldy505 Sep 3, 2024

cleptric Sep 3, 2024

cleptric Sep 3, 2024

aldy505 Sep 4, 2024

cleptric Sep 4, 2024

aldy505 Sep 21, 2024

cleptric Oct 29, 2024

cleptric Oct 29, 2024

aldy505 Nov 2, 2024

cleptric Nov 4, 2024

aldy505 Nov 6, 2024

cleptric Oct 29, 2024

aldy505 Nov 2, 2024

cleptric Nov 4, 2024

cleptric Oct 29, 2024

cleptric Nov 6, 2024

aldy505 Nov 6, 2024

cleptric Nov 6, 2024

aldy505 Nov 6, 2024

cleptric Nov 7, 2024

aldy505 Nov 8, 2024


		span := sentry.StartSpan(ctx, "http.client", sentry.WithTransactionName(fmt.Sprintf("%s %s", request.Method, cleanRequestURL)))

		for k, v := range s.tags {

	if clientOptions.EnableTracing {
	hub := hubFromContext(ctx)
	hub.Scope().SetSpan(&span)
	}

feat: http client integration #876

Are you sure you want to change the base?

feat: http client integration #876

Conversation

aldy505 commented Aug 27, 2024

codecov bot commented Aug 27, 2024 • edited Loading

Codecov Report

ribice commented Sep 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 27, 2024 •

edited

Loading