feat: add new envelope transport #1094

giortzisg · 2025-09-24T11:22:19Z

Description

Create the new transport that accepts envelopes and not events. For now only the implementation for the new transport is added, without deprecating the old one. The PR also includes some misc changes:

creating an envelope convertible interface, to accept a generic type of events/logs/transactions, etc..
moving the dsn internally under the protocol folder and re exporting everything on the top level to avoid cyclic imports when using the new transport.

Issues

resolves: Create new transport that accepts envelopes #1092
resolves: GO-84

Note

Introduce envelope-first Sync/Async HTTP transports, centralize DSN and envelope types under internal/protocol, and adapt SDK to use them with minimal API surface changes.

Transport (new):
- Add internal/http transports: AsyncTransport and SyncTransport that send protocol.Envelopes, with queueing, flush/close, rate limiting, proxy/TLS config, headers, and keep-alive handling.
Protocol (new):
- Add internal/protocol: Dsn, Envelope (+ items, header), SdkInfo, and interfaces (EnvelopeConvertible, TelemetryTransport).
- Provide DSN parsing, request headers, API URL, JSON marshal/unmarshal.
SDK integration/refactor:
- Wrap and re-export Dsn and DsnParseError in top-level sentry; NewDsn delegates to protocol; RequestHeaders() uses SDK version; minor typo fix in comment.
- Add Event.ToEnvelope/ToEnvelopeWithTime; include DSC trace info and attachments; fallback JSON marshal path preserved.
- Update DynamicSamplingContext and transport.go to use DSN getters (GetPublicKey, etc.) and scheme constants from protocol in NewRequest.
Tests:
- Add comprehensive tests for protocol DSN/envelope, new transports (queueing, flush, rate limits, errors, keep-alive, proxies/TLS, concurrency, goroutine leaks), and wrapper behavior; expand request and event tests.

^{Written by Cursor Bugbot for commit 1ed184b. This will update automatically on new commits. Configure here.}

linear · 2025-09-24T11:22:22Z

GO-84 Create new transport that accepts envelopes

codecov · 2025-09-24T11:24:49Z

Codecov Report

❌ Patch coverage is 85.00000% with 93 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.65%. Comparing base (2dc3b97) to head (871ade0).

Files with missing lines	Patch %	Lines
internal/http/transport.go	86.23%	33 Missing and 12 partials ⚠️
internal/protocol/envelope.go	63.73%	22 Missing and 11 partials ⚠️
interfaces.go	82.75%	7 Missing and 3 partials ⚠️
internal/protocol/dsn.go	97.69%	2 Missing and 1 partial ⚠️
transport.go	71.42%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1094      +/-   ##
==========================================
- Coverage   86.99%   86.65%   -0.34%     
==========================================
  Files          55       59       +4     
  Lines        6076     6559     +483     
==========================================
+ Hits         5286     5684     +398     
- Misses        645      705      +60     
- Partials      145      170      +25

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

semgrep-code-getsentry · 2025-09-26T08:31:06Z

internal/http/transport.go

+		return &tls.Config{
+			RootCAs: options.CaCerts,
+		}


MinVersion is missing from this TLS configuration. By default, as of Go 1.22, TLS 1.2 is currently used as the minimum. General purpose web applications should default to TLS 1.3 with all other protocols disabled. Only where it is known that a web server must support legacy clients with unsupported an insecure browsers (such as Internet Explorer 10), it may be necessary to enable TLS 1.0 to provide support. Add `MinVersion: tls.VersionTLS13' to the TLS configuration to bump the minimum version to TLS 1.3.

🧼 Fixed in commit 871ade0 🧼

can we address this?

Since go uses tls1.2 we should be good to this as the min version. We already inherit the min version of the runtime anyways.

sl0thentr0py

ideally we'd also abstract the older event types as envelope items, but I'll leave it upto you if you want to do that now or separately later

dsn.go

interfaces.go

lcian

Left some mostly minor comments, looks good overall. Haven't looked at the tests yet.

lcian · 2025-10-07T13:11:26Z

internal/http/transport.go

+func (t *SyncTransport) Close() {}
+
+func (t *SyncTransport) SendEvent(event protocol.EnvelopeConvertible) {
+	if envelope, err := event.ToEnvelope(t.dsn); err == nil && envelope != nil {


If this errors, we should log it. We're not logging it right now. Same for other uses of this function.

lcian · 2025-10-07T13:20:01Z

internal/http/transport.go

+}
+
+func getSentryRequestFromEnvelope(ctx context.Context, dsn *protocol.Dsn, envelope *protocol.Envelope) (r *http.Request, err error) {
+	defer func() {


lcian · 2025-10-07T13:23:39Z

internal/http/transport.go

+		case protocol.EnvelopeItemTypeAttachment:
+			continue
+		default:
+			return ratelimit.CategoryAll


In theory an envelope can contain multiple items, here we're only considering the first we find a match for.

Also I'm thinking this should live in internal/ratelimit/category.go, if it's possible with the imports

lcian · 2025-10-07T13:26:50Z

internal/http/transport.go

+
+	dsn, err := protocol.NewDsn(options.Dsn)
+	if err != nil {
+		debuglog.Printf("failed to create transport: invalid dsn: %v\n", err)


Suggested change

debuglog.Printf("failed to create transport: invalid dsn: %v\n", err)

debuglog.Printf("transport is disabled: invalid dsn: %v\n", err)

lcian · 2025-10-07T13:31:20Z

internal/http/transport.go

+	if response.StatusCode >= 400 && response.StatusCode <= 599 {
+		b, err := io.ReadAll(response.Body)
+		if err != nil {
+			debuglog.Printf("Error while reading response code: %v", err)


Suggested change

debuglog.Printf("Error while reading response code: %v", err)

debuglog.Printf("Error while reading response body: %v", err)

lcian · 2025-10-07T13:58:19Z

internal/http/transport.go

+	}
+
+	if response.StatusCode >= 500 {
+		debuglog.Printf("Server error %d - will retry", response.StatusCode)


will retry

Chat, is this real? I believe we just fail to send and that's it.

lcian · 2025-10-07T14:10:18Z

internal/http/transport.go

+func (t *AsyncTransport) sendEnvelopeHTTP(envelope *protocol.Envelope) bool {
+	category := categoryFromEnvelope(envelope)
+	if t.isRateLimited(category) {
+		return false


This way we consider being rate limited an error, see above where we do
atomic.AddInt64(&t.errorCount, 1)
if this fun returns false.
Is this what we want?

I guess this stuff will be replaced with client reports anyways so it's also okay to leave it as is for now.

lcian · 2025-10-07T14:23:19Z

internal/protocol/interfaces.go

+	// SendEvent sends an event to Sentry. Returns immediately with
+	// backpressure error if the queue is full.


false, it cannot error

lcian · 2025-10-07T14:30:27Z

internal/protocol/envelope.go

+	// This means that SDK information can be carried for minidumps, session data and other submissions.
+	Sdk *SdkInfo `json:"sdk,omitempty"`
+
+	// Trace contains trace context information for distributed tracing


Suggested change

// Trace contains trace context information for distributed tracing

// Trace contains the [Dynamic Sampling Context](https://develop.sentry.dev/sdk/telemetry/traces/dynamic-sampling-context/)

lcian · 2025-10-07T14:33:54Z

internal/protocol/envelope.go

+	return len(data), nil
+}
+
+// MarshalJSON converts the EnvelopeHeader to JSON and ensures it's a single line.


ensures it's a single line

does it?

add new transport

0c154b8

giortzisg added 5 commits September 25, 2025 09:26

fix lint

fc93d2c

fix tests

3c7498e

modify envelope serialization and tests

0a406ba

change transport opts

6f9c638

remove transport.Configure

bf26d59

semgrep-code-getsentry bot reviewed Sep 26, 2025

View reviewed changes

giortzisg added 3 commits September 26, 2025 11:16

add proper await on queue flush

c7205ca

add test for marshall fallback

8c8a4bd

fix tests

4228142

giortzisg force-pushed the feat/transport-envelope branch from 3ce9dee to 4228142 Compare September 29, 2025 14:02

add sendEvent

803349d

giortzisg marked this pull request as ready for review September 29, 2025 14:27

giortzisg requested review from sl0thentr0py and cleptric September 29, 2025 14:28

This comment was marked as outdated.

Sign in to view

giortzisg added 3 commits September 30, 2025 11:23

fix dsn exporting

51f0373

enhance transport test suite

58a7b02

change backpressure test

1ed184b

sl0thentr0py approved these changes Sep 30, 2025

View reviewed changes

dsn.go Show resolved Hide resolved

interfaces.go Show resolved Hide resolved

giortzisg added 3 commits October 6, 2025 16:54

Merge branch 'master' into feat/transport-envelope

7a2f452

specify min tls version

a146a1e

use global debuglog

871ade0

lcian reviewed Oct 7, 2025

View reviewed changes

	debuglog.Printf("failed to create transport: invalid dsn: %v\n", err)
	debuglog.Printf("transport is disabled: invalid dsn: %v\n", err)

	debuglog.Printf("Error while reading response code: %v", err)
	debuglog.Printf("Error while reading response body: %v", err)

		// SendEvent sends an event to Sentry. Returns immediately with
		// backpressure error if the queue is full.

	// Trace contains trace context information for distributed tracing
	// Trace contains the [Dynamic Sampling Context](https://develop.sentry.dev/sdk/telemetry/traces/dynamic-sampling-context/)

feat: add new envelope transport #1094

Are you sure you want to change the base?

feat: add new envelope transport #1094

Uh oh!

Conversation

giortzisg commented Sep 24, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues

Uh oh!

linear bot commented Sep 24, 2025

Uh oh!

codecov bot commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

semgrep-code-getsentry bot Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

sl0thentr0py left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lcian left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lcian Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

giortzisg commented Sep 24, 2025 •

edited by cursor bot

Loading

codecov bot commented Sep 24, 2025 •

edited

Loading

semgrep-code-getsentry bot Sep 26, 2025 •

edited

Loading

lcian Oct 7, 2025 •

edited

Loading