feat: Custom measurements API

Samples/iOS-Swift/iOS-Swift/ViewController.swift

@@ -141,6 +141,13 @@ class ViewController: UIViewController {
 
     @IBAction func captureTransaction(_ sender: Any) {
         let transaction = SentrySDK.startTransaction(name: "Some Transaction", operation: "Some Operation")
+
+        transaction.setMeasurement(name: "custom", value: 44, customUnit: "custom-unit")
+        transaction.setMeasurement(name: "none", value: 55)
+        transaction.setMeasurement(name: "duration", value: 1.23, durationUnit: .milliSecond)
+        transaction.setMeasurement(name: "information", value: 134.3, informationUnit: .gigabyte)
+        transaction.setMeasurement(name: "fraction", value: 9.3, fractionUnit: .percent)
+
         let span = transaction.startChild(operation: "user", description: "calls out")
 
         DispatchQueue.main.asyncAfter(deadline: .now() + 0.1, execute: {

Sources/Sentry/Public/SentryDefines.h

@@ -142,3 +142,84 @@ typedef NS_ENUM(NSInteger, SentryTransactionNameSource) {
     kSentryTransactionNameSourceComponent,
     kSentryTransactionNameSourceTask
 };
+
+/**
+ * A time duration.
+ */
+typedef NS_ENUM(NSInteger, SentryDurationUnit) {
+    /** Nanosecond (`"nanosecond"`), 10^-9 seconds. */
+    kSentryDurationUnitNanoSecond = 0,
+    /** Microsecond (`"microsecond"`), 10^-6 seconds. */
+    kSentryDurationUnitMicroSecond,
+    /** Millisecond (`"millisecond"`), 10^-3 seconds. */
+    kSentryDurationUnitMilliSecond,
+    /** Full second (`"second"`). */
+    kSentryDurationUnitSecond,
+    /** Minute (`"minute"`), 60 seconds. */
+    kSentryDurationUnitMinute,
+    /** Hour (`"hour"`), 3600 seconds. */
+    kSentryDurationUnitHour,
+    /** Day (`"day"`), 86,400 seconds. */
+    kSentryDurationUnitDay,
+    /** Week (`"week"`), 604,800 seconds. */
+    kSentryDurationUnitWeek
+} NS_SWIFT_NAME(DurationUnit);
+
+/**
+ * Size of information derived from bytes.
+ */
+typedef NS_ENUM(NSInteger, SentryInformationUnit) {
+    /** Bit (`"bit"`), corresponding to 1/8 of a byte. */
+    kSentryInformationUnitBit,
+
+    /** Byte (`"byte"`). */
+    kSentryInformationUnitByte,
+
+    /** Kilobyte (`"kilobyte"`), 10^3 bytes. */
+    kSentryInformationUnitKilobyte,
+
+    /** Kibibyte (`"kibibyte"`), 2^10 bytes. */
+    kSentryInformationUnitKibibyte,
+
+    /** Megabyte (`"megabyte"`), 10^6 bytes. */
+    kSentryInformationUnitMegabyte,
+
+    /** Mebibyte (`"mebibyte"`), 2^20 bytes. */
+    kSentryInformationUnitMebibyte,
+
+    /** Gigabyte (`"gigabyte"`), 10^9 bytes. */
+    kSentryInformationUnitGigabyte,
+
+    /** Gibibyte (`"gibibyte"`), 2^30 bytes. */
+    kSentryInformationUnitGibibyte,
+
+    /** Terabyte (`"terabyte"`), 10^12 bytes. */
+    kSentryInformationUnitTerabyte,
+
+    /** Tebibyte (`"tebibyte"`), 2^40 bytes. */
+    kSentryInformationUnitTebibyte,
+
+    /** Petabyte (`"petabyte"`), 10^15 bytes. */
+    kSentryInformationUnitPetabyte,
+
+    /** Pebibyte (`"pebibyte"`), 2^50 bytes. */
+    kSentryInformationUnitPebibyte,
+
+    /** Exabyte (`"exabyte"`), 10^18 bytes. */
+    kSentryInformationUnitExabyte,
+
+    /** Exbibyte (`"exbibyte"`), 2^60 bytes. */
+    kSentryInformationUnitExbibyte
+} NS_SWIFT_NAME(InformationUnit);
+
+/**
+ * Fractions such as percentages.
+ */
+typedef NS_ENUM(NSInteger, SentryFractionUnit) {
+
+    /** Floating point fraction of `1`. */
+    kSentryFractionUnitRatio = 0,
+
+    /** Ratio expressed as a fraction of `100`. `100%` equals a ratio of `1.0`. */
+    kSentryFractionUnitPercent
+} NS_SWIFT_NAME(FractionUnit);

Sources/Sentry/Public/SentrySpanProtocol.h

@@ -87,6 +87,28 @@ NS_SWIFT_NAME(Span)
  */
 - (void)removeTagForKey:(NSString *)key NS_SWIFT_NAME(removeTag(key:));
 
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value NS_SWIFT_NAME(setMeasurement(name:value:));
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          durationUnit:(SentryDurationUnit)durationUnit
+    NS_SWIFT_NAME(setMeasurement(name:value:durationUnit:));
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+       informationUnit:(SentryInformationUnit)informationUnit
+    NS_SWIFT_NAME(setMeasurement(name:value:informationUnit:));
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          fractionUnit:(SentryFractionUnit)fractionUnit
+    NS_SWIFT_NAME(setMeasurement(name:value:fractionUnit:));
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+            customUnit:(NSString *)customUnit NS_SWIFT_NAME(setMeasurement(name:value:customUnit:));
+
 /**
  * Finishes the span by setting the end time.
  */

Sources/Sentry/SentryNoOpSpan.m

@@ -64,6 +64,32 @@ - (void)removeTagForKey:(NSString *)key
 {
 }
 
+- (void)setMeasurement:(NSString *)name value:(NSNumber *)value
+{
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          durationUnit:(SentryDurationUnit)durationUnit
+{
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+       informationUnit:(SentryInformationUnit)informationUnit
+{
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          fractionUnit:(SentryFractionUnit)fractionUnit
+{
+}
+
+- (void)setMeasurement:(NSString *)name value:(NSNumber *)value customUnit:(NSString *)customUnit
+{
+}
+
 - (NSDictionary<NSString *, id> *)tags
 {
     return @{};

Sources/Sentry/SentrySpan.m

@@ -89,6 +89,32 @@ - (void)removeTagForKey:(NSString *)key
     }
 }
 
+- (void)setMeasurement:(NSString *)name value:(NSNumber *)value
+{
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          durationUnit:(SentryDurationUnit)durationUnit
+{
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+       informationUnit:(SentryInformationUnit)informationUnit
+{
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          fractionUnit:(SentryFractionUnit)fractionUnit
+{
+}
+
+- (void)setMeasurement:(NSString *)name value:(NSNumber *)value customUnit:(NSString *)customUnit
+{
+}
+
 - (NSDictionary<NSString *, id> *)tags
 {
     @synchronized(_tags) {

Sources/Sentry/SentryTracer.m

@@ -61,6 +61,7 @@ @implementation SentryTracer {
     SentryAppStartMeasurement *appStartMeasurement;
     NSMutableDictionary<NSString *, id> *_tags;
     NSMutableDictionary<NSString *, id> *_data;
+    NSMutableDictionary<NSString *, id> *_measurements;
     dispatch_block_t _idleTimeoutBlock;
     NSMutableArray<id<SentrySpan>> *_children;
 
@@ -160,6 +161,7 @@ - (instancetype)initWithTransactionContext:(SentryTransactionContext *)transacti
         _waitForChildren = waitForChildren;
         _tags = [[NSMutableDictionary alloc] init];
         _data = [[NSMutableDictionary alloc] init];
+        _measurements = [[NSMutableDictionary alloc] init];
         self.finishStatus = kSentrySpanStatusUndefined;
         self.idleTimeout = idleTimeout;
         self.dispatchQueueWrapper = dispatchQueueWrapper;
@@ -395,6 +397,106 @@ - (void)removeTagForKey:(NSString *)key
     }
 }
 
+- (void)setMeasurement:(NSString *)name value:(NSNumber *)value
+{
+    _measurements[name] = @{ @"value" : value, @"unit" : @"none" };
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          durationUnit:(SentryDurationUnit)durationUnit
+{
+    _measurements[name] =
+        @{ @"value" : value, @"unit" : [self stringForDurationUnit:durationUnit] };
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+       informationUnit:(SentryInformationUnit)informationUnit
+{
+    _measurements[name] =
+        @{ @"value" : value, @"unit" : [self stringForInformationUnit:informationUnit] };
+}
+
+- (void)setMeasurement:(NSString *)name
+                 value:(NSNumber *)value
+          fractionUnit:(SentryFractionUnit)fractionUnit
+{
+    _measurements[name] =
+        @{ @"value" : value, @"unit" : [self stringForFractionUnit:fractionUnit] };
+}
+
+- (void)setMeasurement:(NSString *)name value:(NSNumber *)value customUnit:(NSString *)customUnit
+{
+    _measurements[name] = @{ @"value" : value, @"unit" : customUnit };
+}
+
+- (NSString *)stringForDurationUnit:(SentryDurationUnit)duration
+{
+    switch (duration) {
+    case kSentryDurationUnitNanoSecond:
+        return @"nanosecond";
+    case kSentryDurationUnitMicroSecond:
+        return @"microsecond";
+    case kSentryDurationUnitMilliSecond:
+        return @"millisecond";
+    case kSentryDurationUnitSecond:
+        return @"second";
+    case kSentryDurationUnitMinute:
+        return @"minute";
+    case kSentryDurationUnitHour:
+        return @"hour";
+    case kSentryDurationUnitDay:
+        return @"day";
+    case kSentryDurationUnitWeek:
+        return @"week";
+    }
+}
+
+- (NSString *)stringForInformationUnit:(SentryInformationUnit)informationUnit
+{
+    switch (informationUnit) {
+    case kSentryInformationUnitBit:
+        return @"bit";
+    case kSentryInformationUnitByte:
+        return @"byte";
+    case kSentryInformationUnitKilobyte:
+        return @"kilobyte";
+    case kSentryInformationUnitKibibyte:
+        return @"kibibyte";
+    case kSentryInformationUnitMegabyte:
+        return @"megabyte";
+    case kSentryInformationUnitMebibyte:
+        return @"mebibyte";
+    case kSentryInformationUnitGigabyte:
+        return @"gigabyte";
+    case kSentryInformationUnitGibibyte:
+        return @"gibibyte";
+    case kSentryInformationUnitTerabyte:
+        return @"terabyte";
+    case kSentryInformationUnitTebibyte:
+        return @"tebibyte";
+    case kSentryInformationUnitPetabyte:
+        return @"petabyte";
+    case kSentryInformationUnitPebibyte:
+        return @"pebibyte";
+    case kSentryInformationUnitExabyte:
+        return @"exabyte";
+    case kSentryInformationUnitExbibyte:
+        return @"exbibyte";
+    }
+}
+
+- (NSString *)stringForFractionUnit:(SentryFractionUnit)fraction
+{
+    switch (fraction) {
+    case kSentryFractionUnitRatio:
+        return @"ratio";
+    case kSentryFractionUnitPercent:
+        return @"percent";
+    }
+}
+
 - (SentryTraceHeader *)toTraceHeader
 {
     return [self.rootSpan toTraceHeader];
@@ -727,6 +829,10 @@ - (void)addMeasurements:(SentryTransaction *)transaction
         }
     }
 #endif
+
+    for (NSString *key in _measurements) {
+        [transaction setMeasurementValue:_measurements[key] forKey:key];
+    }
 }
 
 - (id<SentrySpan>)buildSpan:(SentrySpanId *)parentId