Add API to track events with properties and measurements

Author: Benjamin Scholtysik (Reimold)

Classes/Telemetry/BITEventData.h

@@ -4,5 +4,6 @@
 
 @property (nonatomic, copy, readonly) NSString *envelopeTypeName;
 @property (nonatomic, copy, readonly) NSString *dataTypeName;
+@property (nonatomic, strong) NSDictionary *measurements;
 
 @end

Classes/Telemetry/BITEventData.m

@@ -5,13 +5,17 @@ @implementation BITEventData
 @synthesize envelopeTypeName = _envelopeTypeName;
 @synthesize dataTypeName = _dataTypeName;
 @synthesize version = _version;
+@synthesize properties = _properties;
+@synthesize measurements = _measurements;
 
 /// Initializes a new instance of the class.
 - (instancetype)init {
   if (self = [super init]) {
     _envelopeTypeName = @"Microsoft.ApplicationInsights.Event";
     _dataTypeName = @"EventData";
     _version = @2;
+    _properties = [NSDictionary new];
+    _measurements = [NSDictionary new];
   }
   return self;
 }
@@ -25,6 +29,13 @@ - (NSDictionary *)serializeToDictionary {
   if (self.name != nil) {
     [dict setObject:self.name forKey:@"name"];
   }
+  if (self.properties !=nil) {
+    [dict setObject:self.properties forKey:@"properties"];
+  }
+  if (self.measurements) {
+    [dict setObject:self.measurements forKey:@"measurements"];
+  }
+  
   return dict;
 }
 
@@ -36,6 +47,8 @@ - (instancetype)initWithCoder:(NSCoder *)coder {
     _envelopeTypeName = [coder decodeObjectForKey:@"self.envelopeTypeName"];
     _dataTypeName = [coder decodeObjectForKey:@"self.dataTypeName"];
     _version = [coder decodeObjectForKey:@"self.version"];
+    _properties = [coder decodeObjectForKey:@"self.properties"];
+    _measurements = [coder decodeObjectForKey:@"self.measurements"];
   }
   return self;
 }
@@ -45,6 +58,8 @@ - (void)encodeWithCoder:(NSCoder *)coder {
   [coder encodeObject:self.envelopeTypeName forKey:@"self.envelopeTypeName"];
   [coder encodeObject:self.dataTypeName forKey:@"self.dataTypeName"];
   [coder encodeObject:self.version forKey:@"self.version"];
+  [coder encodeObject:self.properties forKey:@"self.properties"];
+  [coder encodeObject:self.measurements forKey:@"self.measurements"];
 }
 
 

Classes/Telemetry/BITMetricsManager.h

@@ -36,7 +36,18 @@ NS_ASSUME_NONNULL_BEGIN
  *
  *  @param eventName The event's name as a string.
  */
-- (void)trackEventWithName:(NSString *)eventName;
+- (void)trackEventWithName:(nonnull NSString *)eventName;
+
+/**
+ *  This method allows to track an event that happened in your app.
+ *  Remember to choose meaningful event names to have the best experience when diagnosing your app
+ *  in the web portal.
+ *
+ *  @param eventName the name of the event, which should be tracked.
+ *  @param properties key value pairs with additional info about the event.
+ *  @param measurements key value pairs, which contain custom metrics.
+ */
+- (void)trackEventWithName:(nonnull NSString *)eventName properties:(nullable NSDictionary<NSString *, NSString *> *)properties measurements:(nullable NSDictionary<NSString *, NSNumber *> *)measurements;
 
 @end
 

Classes/Telemetry/BITMetricsManager.m

@@ -199,6 +199,25 @@ - (void)trackEventWithName:(NSString *)eventName {
   });
 }
 
+- (void)trackEventWithName:(nonnull NSString *)eventName properties:(nullable NSDictionary<NSString *, NSString *> *)properties measurements:(nullable NSDictionary<NSString *, NSNumber *> *)measurements {
+  if (!eventName) { return; }
+  if (self.disabled) {
+    BITHockeyLogDebug(@"INFO: BITMetricsManager is disabled, therefore this tracking call was ignored.");
+    return;
+  }
+  
+  __weak typeof(self) weakSelf = self;
+  dispatch_async(self.metricsEventQueue, ^{
+    typeof(self) strongSelf = weakSelf;
+    BITEventData *eventData = [BITEventData new];
+    [eventData setName:eventName];
+    [eventData setProperties:properties];
+    [eventData setMeasurements:measurements];
+    [strongSelf trackDataItem:eventData];
+  });
+}
+
+
 #pragma mark Track DataItem
 
 - (void)trackDataItem:(BITTelemetryData *)dataItem {

Classes/Telemetry/BITTelemetryData.h

@@ -11,6 +11,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (nonatomic, copy) NSNumber *version;
 @property (nonatomic, copy) NSString *name;
+@property (nonatomic, strong) NSDictionary *properties;
 
 @end
 

Classes/Telemetry/BITTelemetryData.m

@@ -18,6 +18,7 @@ - (instancetype)initWithCoder:(NSCoder *)coder {
   if(self) {
     _version = [coder decodeObjectForKey:@"self.version"];
     _name = [coder decodeObjectForKey:@"self.name"];
+    _properties = [coder decodeObjectForKey:@"self.properties"];
   }
   return self;
 }
@@ -26,6 +27,7 @@ - (void)encodeWithCoder:(NSCoder *)coder {
   [super encodeWithCoder:coder];
   [coder encodeObject:self.version forKey:@"self.version"];
   [coder encodeObject:self.name forKey:@"self.name"];
+  [coder encodeObject:self.properties forKey:@"self.properties"];
 }
 
 @end