feat: Add transaction to baggage and trace headers (#1992)

Added the transaction name to http baggage header and to envelope trace header.

CHANGELOG.md

@@ -11,6 +11,7 @@
 ### Features
 
 - Read free_memory when the event is captured, not only at SDK startup (#1962)
+- Add transaction to baggage and trace headers (#1992)
 - Provide private access to SentryOptions for hybrid SDKs (#1991)
 
 ### Fixes

Sources/Sentry/SentryBaggage.m

@@ -14,6 +14,7 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                       publicKey:(NSString *)publicKey
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
+                    transaction:(nullable NSString *)transaction
                     userSegment:(nullable NSString *)userSegment
                      sampleRate:(nullable NSString *)sampleRate
 {
@@ -23,6 +24,7 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
         _publicKey = publicKey;
         _releaseName = releaseName;
         _environment = environment;
+        _transaction = transaction;
         _userSegment = userSegment;
         _sampleRate = sampleRate;
     }
@@ -49,6 +51,9 @@ - (NSString *)toHTTPHeaderWithOriginalBaggage:(NSDictionary *_Nullable)originalB
     if (_environment != nil)
         [information setValue:_environment forKey:@"sentry-environment"];
 
+    if (_transaction != nil)
+        [information setValue:_transaction forKey:@"sentry-transaction"];
+
     if (_userSegment != nil)
         [information setValue:_userSegment forKey:@"sentry-user_segment"];
 

Sources/Sentry/SentryTraceContext.m

@@ -17,6 +17,7 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                       publicKey:(NSString *)publicKey
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
+                    transaction:(nullable NSString *)transaction
                     userSegment:(nullable NSString *)userSegment
                      sampleRate:(nullable NSString *)sampleRate
 {
@@ -25,6 +26,7 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
         _publicKey = publicKey;
         _environment = environment;
         _releaseName = releaseName;
+        _transaction = transaction;
         _userSegment = userSegment;
         _sampleRate = sampleRate;
     }
@@ -63,6 +65,7 @@ - (nullable instancetype)initWithTracer:(SentryTracer *)tracer
                        publicKey:options.parsedDsn.url.user
                      releaseName:options.releaseName
                      environment:options.environment
+                     transaction:tracer.name
                      userSegment:userSegment
                       sampleRate:sampleRate];
 }
@@ -87,6 +90,7 @@ - (nullable instancetype)initWithDict:(NSDictionary<NSString *, id> *)dictionary
                        publicKey:publicKey
                      releaseName:dictionary[@"release"]
                      environment:dictionary[@"environment"]
+                     transaction:dictionary[@"transaction"]
                      userSegment:userSegment
                       sampleRate:dictionary[@"sample_rate"]];
 }
@@ -97,6 +101,7 @@ - (SentryBaggage *)toBaggage
                                                          publicKey:_publicKey
                                                        releaseName:_releaseName
                                                        environment:_environment
+                                                       transaction:_transaction
                                                        userSegment:_userSegment
                                                         sampleRate:_sampleRate];
     return result;
@@ -113,6 +118,9 @@ - (SentryBaggage *)toBaggage
     if (_environment != nil)
         [result setValue:_environment forKey:@"environment"];
 
+    if (_transaction != nil)
+        [result setValue:_transaction forKey:@"transaction"];
+
     if (_userSegment != nil)
         [result setValue:_userSegment forKey:@"user_segment"];
 

Sources/Sentry/include/SentryBaggage.h

@@ -53,6 +53,7 @@ static NSString *const SENTRY_BAGGAGE_HEADER = @"baggage";
                       publicKey:(NSString *)publicKey
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
+                    transaction:(nullable NSString *)transaction
                     userSegment:(nullable NSString *)userSegment
                      sampleRate:(nullable NSString *)sampleRate;
 

Sources/Sentry/include/SentryTraceContext.h

@@ -29,6 +29,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nullable, nonatomic, readonly) NSString *environment;
 
+/**
+ * The transaction name set on the scope.
+ */
+@property (nullable, nonatomic, readonly) NSString *transaction;
+
 /**
  * A subset of the scope's user context.
  */
@@ -46,6 +51,7 @@ NS_ASSUME_NONNULL_BEGIN
                       publicKey:(NSString *)publicKey
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
+                    transaction:(nullable NSString *)transaction
                     userSegment:(nullable NSString *)userSegment
                      sampleRate:(nullable NSString *)sampleRate;
 

Tests/SentryTests/Helper/SentrySerializationTests.swift

@@ -4,7 +4,7 @@ class SentrySerializationTests: XCTestCase {
 
     private class Fixture {
         static var invalidData = "hi".data(using: .utf8)!
-        static var traceContext = SentryTraceContext(trace: SentryId(), publicKey: "PUBLIC_KEY", releaseName: "RELEASE_NAME", environment: "TEST", userSegment: "some segment", sampleRate: "0.25")
+        static var traceContext = SentryTraceContext(trace: SentryId(), publicKey: "PUBLIC_KEY", releaseName: "RELEASE_NAME", environment: "TEST", transaction: "transaction", userSegment: "some segment", sampleRate: "0.25")
     }
 
     func testSentryEnvelopeSerializer_WithSingleEvent() {
@@ -111,7 +111,7 @@ class SentrySerializationTests: XCTestCase {
     }
 
     func testSentryEnvelopeSerializer_TraceStateWithoutUser() {
-        let trace = SentryTraceContext(trace: SentryId(), publicKey: "PUBLIC_KEY", releaseName: "RELEASE_NAME", environment: "TEST", userSegment: nil, sampleRate: nil)
+        let trace = SentryTraceContext(trace: SentryId(), publicKey: "PUBLIC_KEY", releaseName: "RELEASE_NAME", environment: "TEST", transaction: "transaction", userSegment: nil, sampleRate: nil)
 
         let envelopeHeader = SentryEnvelopeHeader(id: nil, traceContext: trace)
         let envelope = SentryEnvelope(header: envelopeHeader, singleItem: createItemWithEmptyAttachment())

Tests/SentryTests/Protocol/SentryEnvelopeTests.swift

@@ -159,7 +159,7 @@ class SentryEnvelopeTests: XCTestCase {
 
     func testInitSentryEnvelopeHeader_SetIdAndTraceState() {
         let eventId = SentryId()
-        let traceContext = SentryTraceContext(trace: SentryId(), publicKey: "publicKey", releaseName: "releaseName", environment: "environment", userSegment: nil, sampleRate: nil)
+        let traceContext = SentryTraceContext(trace: SentryId(), publicKey: "publicKey", releaseName: "releaseName", environment: "environment", transaction: "transaction", userSegment: nil, sampleRate: nil)
 
         let envelopeHeader = SentryEnvelopeHeader(id: eventId, traceContext: traceContext)
         XCTAssertEqual(eventId, envelopeHeader.eventId)

Tests/SentryTests/Transaction/SentryBaggageTests.swift

@@ -5,9 +5,9 @@ import XCTest
 class SentryBaggageTests: XCTestCase {
 
     func test_baggageToHeader() {
-        let header = SentryBaggage(trace: SentryId.empty, publicKey: "publicKey", releaseName: "release name", environment: "teste", userSegment: "test user", sampleRate: "0.49").toHTTPHeader()
+        let header = SentryBaggage(trace: SentryId.empty, publicKey: "publicKey", releaseName: "release name", environment: "teste", transaction: "transaction", userSegment: "test user", sampleRate: "0.49").toHTTPHeader()
 
-        XCTAssertEqual(header, "sentry-environment=teste,sentry-public_key=publicKey,sentry-release=release%20name,sentry-sample_rate=0.49,sentry-trace_id=00000000000000000000000000000000,sentry-user_segment=test%20user")
+        XCTAssertEqual(header, "sentry-environment=teste,sentry-public_key=publicKey,sentry-release=release%20name,sentry-sample_rate=0.49,sentry-trace_id=00000000000000000000000000000000,sentry-transaction=transaction,sentry-user_segment=test%20user")
     }
 
     func test_baggageToHeader_AppendToOriginal() {
@@ -17,7 +17,7 @@ class SentryBaggageTests: XCTestCase {
     }
 
     func test_baggageToHeader_onlyTrace_ignoreNils() {
-        let header = SentryBaggage(trace: SentryId.empty, publicKey: "publicKey", releaseName: nil, environment: nil, userSegment: nil, sampleRate: nil).toHTTPHeader()
+        let header = SentryBaggage(trace: SentryId.empty, publicKey: "publicKey", releaseName: nil, environment: nil, transaction: nil, userSegment: nil, sampleRate: nil).toHTTPHeader()
 
         XCTAssertEqual(header, "sentry-public_key=publicKey,sentry-trace_id=00000000000000000000000000000000")
     }

Tests/SentryTests/Transaction/SentryTraceStateTests.swift

@@ -54,6 +54,7 @@ class SentryTraceContextTests: XCTestCase {
             publicKey: fixture.publicKey,
             releaseName: fixture.releaseName,
             environment: fixture.environment,
+            transaction: fixture.transactionName,
             userSegment: fixture.userSegment,
             sampleRate: fixture.sampleRate)
 
@@ -92,6 +93,7 @@ class SentryTraceContextTests: XCTestCase {
             publicKey: fixture.publicKey,
             releaseName: fixture.releaseName,
             environment: fixture.environment,
+            transaction: fixture.transactionName,
             userSegment: fixture.userSegment,
             sampleRate: fixture.sampleRate)
 
@@ -110,6 +112,7 @@ class SentryTraceContextTests: XCTestCase {
         XCTAssertEqual(traceContext.publicKey, fixture.publicKey)
         XCTAssertEqual(traceContext.releaseName, fixture.releaseName)
         XCTAssertEqual(traceContext.environment, fixture.environment)
+        XCTAssertEqual(traceContext.transaction, fixture.transactionName)
         XCTAssertEqual(traceContext.userSegment, fixture.userSegment)
     }