NR-331557: Common Block impl

Author: cdillard-NewRelic

Agent/Utilities/NRLogger.m

@@ -286,10 +286,14 @@ - (void)addLogMessage:(NSDictionary *)message : (BOOL) agentLogsOn {
     });
 }
 
-- (NSData*) jsonDictionary:(NSDictionary*)message {
+- (NSMutableDictionary*) commonBlockDict {
     NSString* NRSessionId = [[[NewRelicAgentInternal sharedInstance] currentSessionId] copy];
     NRMAHarvesterConfiguration *configuration = [NRMAHarvestController configuration];
+
+    // The following line generates the native platform name which is used as "collector.name" in the log payload.
     NSString* nativePlatform = [NewRelicInternalUtils agentName];
+
+    // The following code generates the variable name that is chosen between native platform name or the Hybrid platform name which is used as "instrumentation.name" in the log payload.
     NSString* platform = [NewRelicInternalUtils stringFromNRMAApplicationPlatform:[NRMAAgentConfiguration connectionInformation].deviceInformation.platform];
     NSString* name = [NRMAAgentConfiguration connectionInformation].deviceInformation.platform == NRMAPlatform_Native ? nativePlatform : platform;
 
@@ -316,6 +320,20 @@ - (NSData*) jsonDictionary:(NSDictionary*)message {
         entityGuid = @"";
     }
 
+    NSMutableDictionary *commonAttributes = [NSMutableDictionary dictionary];
+    [commonAttributes setObject:entityGuid forKey:NRLogMessageEntityGuidKey];
+    if (NRSessionId) [commonAttributes setObject:NRSessionId forKey:NRLogMessageSessionIdKey];
+    [commonAttributes setObject:NRLogMessageMobileValue forKey:NRLogMessageInstrumentationProviderKey];
+    if (name) [commonAttributes setObject:name forKey:NRLogMessageInstrumentationNameKey];
+    [commonAttributes setObject:[NRMAAgentConfiguration connectionInformation].deviceInformation.agentVersion forKey:NRLogMessageInstrumentationVersionKey];
+    if (nativePlatform) [commonAttributes setObject:nativePlatform forKey:NRLogMessageInstrumentationCollectorKey];
+    if (nrAppId) [commonAttributes setObject:nrAppId forKey:NRLogMessageAppIdKey];
+
+    return commonAttributes;
+}
+
+- (NSData*) jsonDictionary:(NSDictionary*)message {
+
     NSMutableDictionary *requiredAttributes = [NSMutableDictionary dictionary];
 
     id value = [message objectForKey:NRLogMessageLevelKey];
@@ -336,19 +354,6 @@ - (NSData*) jsonDictionary:(NSDictionary*)message {
     value = [[message objectForKey:NRLogMessageMessageKey]stringByReplacingOccurrencesOfString:@"\"" withString:@"\\\""];
     if (value) [requiredAttributes setObject:value forKey:NRLogMessageMessageKey]; // 6
 
-    if (NRSessionId) [requiredAttributes setObject:NRSessionId forKey:NRLogMessageSessionIdKey]; // 7
-    if (nrAppId) [requiredAttributes setObject:nrAppId forKey:NRLogMessageAppIdKey]; // 8
-    if (entityGuid) [requiredAttributes setObject:entityGuid forKey:NRLogMessageEntityGuidKey]; // 9
-
-    [requiredAttributes setObject:NRLogMessageMobileValue forKey:NRLogMessageInstrumentationProviderKey]; // 10
-    [requiredAttributes setObject:name forKey:NRLogMessageInstrumentationNameKey]; // 11
-
-    value = [NRMAAgentConfiguration connectionInformation].deviceInformation.agentVersion;
-    if (value) [requiredAttributes setObject:value forKey:NRLogMessageInstrumentationVersionKey]; // 12
-
-    [requiredAttributes setObject:nativePlatform forKey:NRLogMessageInstrumentationCollectorKey]; // 13
-
-
     NSMutableDictionary *providedAttributes = [message mutableCopy];
     [providedAttributes removeObjectsForKeys:@[NRLogMessageLevelKey,NRLogMessageFileKey,NRLogMessageLineNumberKey,NRLogMessageMethodKey,NRLogMessageTimestampKey,NRLogMessageMessageKey]];
     [providedAttributes addEntriesFromDictionary:requiredAttributes];
@@ -531,9 +536,56 @@ - (void)enqueueLogUpload {
                 return;
             }
 
-            NSString* logMessagesJson = [NSString stringWithFormat:@"[ %@ ]", [[NSString alloc] initWithData:logData encoding:NSUTF8StringEncoding]];
+
+
+            // modify to contain
+                        /*
+                         [{
+                         "common": {
+                              "attributes": {
+                                "logtype": "accesslogs",
+                                "service": "login-service",
+                                "hostname": "login.example.com"
+                              }
+                            },
+                         "logs": [{
+                                "timestamp": <TIMESTAMP_IN_UNIX_EPOCH_OR_IS08601_FORMAT>,
+                                "message": "User 'xyz' logged in"
+                              },{
+                                "timestamp": <TIMESTAMP_IN_UNIX_EPOCH_OR_IS08601_FORMAT>,
+                                "message": "User 'xyz' logged out",
+                                "attributes": {
+                                  "auditId": 123
+                                }
+                              }]
+                         }]
+
+                         */
+
+                    // the text of the file contents is just comma separated dict objects
+                    // Add the user provided attributes to the message.
+                    NSMutableDictionary *commonBlock = [self commonBlockDict];
+
+                    NSError* error = nil;
+
+                    NSData *json = [NRMAJSON dataWithJSONObject:commonBlock
+                                                                 options:0
+                                                                   error:&error];
+
+                    if (error) {
+                        NRLOG_AGENT_ERROR(@"Failed to create log payload w error = %@", error);
+                    }
+
+                    // New version of the line
+                    NSString* logMessagesJson = [NSString stringWithFormat:@"[{ \"common\": { \"attributes\": %@}, \"logs\": [ %@ ] }]",
+                                                 [[NSString alloc] initWithData:json encoding:NSUTF8StringEncoding],
+                                                 [[NSString alloc] initWithData:logData encoding:NSUTF8StringEncoding]];
+
+            // Old version of the line
+           // NSString* logMessagesJson = [NSString stringWithFormat:@"[ %@ ]", [[NSString alloc] initWithData:logData encoding:NSUTF8StringEncoding]];
+           
             NSData* formattedData = [logMessagesJson dataUsingEncoding:NSUTF8StringEncoding];
-            
+
             // We clear the log when we save the existing logs to uploadQueue.
             [self clearLog];