-
Notifications
You must be signed in to change notification settings - Fork 211
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.
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
feat: http client integration #876
Open
aldy505
wants to merge
10
commits into
getsentry:master
Choose a base branch
from
aldy505:feat/httpclient
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
6b48923
feat: http client integration
aldy505 fd66575
chore(httpclient): variable naming according to linter
aldy505 439e98b
Merge branch 'master' into feat/httpclient
aldy505 5f4c5ae
chore: add changelog entry
aldy505 5214ea5
fix(httpclient): dont iterate over map
aldy505 ed105c1
feat(examples): add httpclient
aldy505 4e55daa
Merge branch 'master' into feat/httpclient
ribice 15aa59a
feat(spans): only start 'http.client' op as a child span
aldy505 099dad4
chore: lint
aldy505 7d9555d
Merge branch 'master' into feat/httpclient
aldy505 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
package main | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"io" | ||
"net/http" | ||
|
||
"github.com/getsentry/sentry-go" | ||
sentryhttpclient "github.com/getsentry/sentry-go/httpclient" | ||
) | ||
|
||
func main() { | ||
_ = sentry.Init(sentry.ClientOptions{ | ||
Dsn: "", | ||
EnableTracing: true, | ||
TracesSampleRate: 1.0, | ||
BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event { | ||
fmt.Println(event) | ||
return event | ||
}, | ||
BeforeSendTransaction: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event { | ||
fmt.Println(event) | ||
return event | ||
}, | ||
Debug: true, | ||
}) | ||
|
||
// With custom HTTP client | ||
ctx := sentry.SetHubOnContext(context.Background(), sentry.CurrentHub().Clone()) | ||
httpClient := &http.Client{ | ||
Transport: sentryhttpclient.NewSentryRoundTripper(nil), | ||
} | ||
|
||
err := getExamplePage(ctx, httpClient) | ||
if err != nil { | ||
panic(err) | ||
} | ||
|
||
// With Sentry's HTTP client | ||
err = getExamplePage(ctx, sentryhttpclient.SentryHTTPClient) | ||
if err != nil { | ||
panic(err) | ||
} | ||
} | ||
|
||
func getExamplePage(ctx context.Context, httpClient *http.Client) error { | ||
span := sentry.StartSpan(ctx, "getExamplePage") | ||
ctx = span.Context() | ||
defer span.Finish() | ||
|
||
request, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://example.com", nil) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
response, err := httpClient.Do(request) | ||
if err != nil { | ||
return err | ||
} | ||
defer func() { | ||
if response.Body != nil { | ||
_ = response.Body.Close() | ||
} | ||
}() | ||
|
||
body, err := io.ReadAll(response.Body) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
fmt.Println(string(body)) | ||
|
||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
// Package sentryhttpclient provides Sentry integration for Requests modules to enable distributed tracing between services. | ||
// It is compatible with `net/http.RoundTripper`. | ||
// | ||
// import sentryhttpclient "github.com/getsentry/sentry-go/httpclient" | ||
// | ||
// roundTrippper := sentryhttpclient.NewSentryRoundTripper(nil, nil) | ||
// client := &http.Client{ | ||
// Transport: roundTripper, | ||
// } | ||
// | ||
// request, err := client.Do(request) | ||
package sentryhttpclient | ||
|
||
import ( | ||
"fmt" | ||
"net/http" | ||
|
||
"github.com/getsentry/sentry-go" | ||
) | ||
|
||
// SentryRoundTripTracerOption provides a specific type in which defines the option for SentryRoundTripper. | ||
type SentryRoundTripTracerOption func(*SentryRoundTripper) | ||
|
||
// WithTags allows the RoundTripper to includes additional tags. | ||
func WithTags(tags map[string]string) SentryRoundTripTracerOption { | ||
return func(t *SentryRoundTripper) { | ||
for k, v := range tags { | ||
t.tags[k] = v | ||
} | ||
} | ||
} | ||
|
||
// WithTag allows the RoundTripper to includes additional tag. | ||
func WithTag(key, value string) SentryRoundTripTracerOption { | ||
return func(t *SentryRoundTripper) { | ||
t.tags[key] = value | ||
} | ||
} | ||
|
||
// NewSentryRoundTripper provides a wrapper to existing http.RoundTripper to have required span data and trace headers for outgoing HTTP requests. | ||
// | ||
// - If `nil` is passed to `originalRoundTripper`, it will use http.DefaultTransport instead. | ||
func NewSentryRoundTripper(originalRoundTripper http.RoundTripper, opts ...SentryRoundTripTracerOption) http.RoundTripper { | ||
if originalRoundTripper == nil { | ||
originalRoundTripper = http.DefaultTransport | ||
} | ||
|
||
t := &SentryRoundTripper{ | ||
originalRoundTripper: originalRoundTripper, | ||
tags: make(map[string]string), | ||
} | ||
|
||
for _, opt := range opts { | ||
if opt != nil { | ||
opt(t) | ||
} | ||
} | ||
|
||
return t | ||
} | ||
|
||
// SentryRoundTripper provides a http.RoundTripper implementation for Sentry Requests module. | ||
type SentryRoundTripper struct { | ||
originalRoundTripper http.RoundTripper | ||
|
||
tags map[string]string | ||
} | ||
|
||
func (s *SentryRoundTripper) RoundTrip(request *http.Request) (*http.Response, error) { | ||
// 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) | ||
} | ||
|
||
cleanRequestURL := request.URL.Redacted() | ||
|
||
span := parentSpan.StartChild("http.client", sentry.WithTransactionName(fmt.Sprintf("%s %s", request.Method, cleanRequestURL))) | ||
span.Tags = s.tags | ||
defer span.Finish() | ||
|
||
span.SetData("http.query", request.URL.Query().Encode()) | ||
span.SetData("http.fragment", request.URL.Fragment) | ||
span.SetData("http.request.method", request.Method) | ||
span.SetData("server.address", request.URL.Hostname()) | ||
span.SetData("server.port", request.URL.Port()) | ||
|
||
// Always add `Baggage` and `Sentry-Trace` headers. | ||
request.Header.Add("Baggage", span.ToBaggage()) | ||
request.Header.Add("Sentry-Trace", span.ToSentryTrace()) | ||
|
||
response, err := s.originalRoundTripper.RoundTrip(request) | ||
|
||
if response != nil { | ||
span.Status = sentry.HTTPtoSpanStatus(response.StatusCode) | ||
span.SetData("http.response.status_code", response.StatusCode) | ||
span.SetData("http.response_content_length", response.ContentLength) | ||
} | ||
|
||
return response, err | ||
} | ||
|
||
// SentryHTTPClient provides a default HTTP client with SentryRoundTripper included. | ||
// This can be used directly to perform HTTP request. | ||
var SentryHTTPClient = &http.Client{ | ||
Transport: NewSentryRoundTripper(http.DefaultTransport), | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A quick note why I prefer this instead of creating a
sentry.WithOnlyIfParentExists()
(aSpanOption
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-L15Should 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. Seesentry-go/tracing.go
Lines 196 to 199 in a6acd05
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.