[iOS] NR-178366: Log reporting

.github/workflows/branchBuild.yml

@@ -0,0 +1,87 @@
+name: BespokeBuild
+on:  
+  workflow_dispatch:
+    # The input version number (ex: 7.4.0) and branch are required for the bespoke branch build. Branch is an automatically added selector for all github actions.
+    inputs:
+      version:
+        required: true
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  deployS3:
+    name: DeployS3
+    # runs-on: will be set to macos-latest when running on actual GHA. 
+    # *** runs-on: ubuntu-latest is used when running via act on mac os. ***
+    runs-on: macos-13 
+    outputs:
+      version: ${{ steps.setOutput.outputs.version }}
+    steps:
+    - uses: actions/checkout@v3
+      with: 
+        submodules: true
+
+    - uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: '14.3'
+
+    - name: Install the Apple certificate and provisioning profile
+      env:
+        BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }}
+        P12_PASSWORD: ${{ secrets.P12_PASSWORD }}
+        # BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.BUILD_PROVISION_PROFILE_BASE64 }}
+        KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }}
+      run: |
+        # create variables
+        CERTIFICATE_PATH=$RUNNER_TEMP/build_certificate.p12
+        PP_PATH=$RUNNER_TEMP/build_pp.mobileprovision
+        KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
+
+        # import certificate and provisioning profile from secrets
+        echo -n "$BUILD_CERTIFICATE_BASE64" | base64 --decode -o $CERTIFICATE_PATH
+        # echo -n "$BUILD_PROVISION_PROFILE_BASE64" | base64 --decode -o $PP_PATH
+
+        # create temporary keychain
+        security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
+        security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
+        security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
+
+        # import certificate to keychain
+        security import $CERTIFICATE_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
+        security list-keychain -d user -s $KEYCHAIN_PATH
+
+        # # apply provisioning profile
+        # mkdir -p ~/Library/MobileDevice/Provisioning\ Profiles
+        # cp $PP_PATH ~/Library/MobileDevice/Provisioning\ Profiles
+
+    - name: Update gem
+      run: bundle update
+
+    - name: Install gems
+      run: bundle install
+
+    - name: Build NewRelic.xcframework (using fastlane)
+      run: bundle exec fastlane buildAndZip
+
+    - name: Get name
+      run: echo "version=$(cat fastlane/build_version)" >> $GITHUB_ENV
+
+    - id: setOutput
+      name: Print name
+      run: echo "version=${{ env.version }}"  >> $GITHUB_OUTPUT
+
+    - name: Deploy to staging S3
+      run: "aws s3 cp NewRelic_XCFramework_Agent_${{ env.version }}.zip s3://nr-downloads-main/ios-v5/"
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
+
+    - name: Upload build reports
+      if: failure() && steps.build-step.outcome != 'success'
+      uses: actions/upload-artifact@v3
+      with:
+        name: build-reports
+        path: /Users/runner/Library/Logs/fastlane/xcbuild/

Agent.xcodeproj/project.pbxproj

@@ -932,6 +932,8 @@
 		2BA9CA45280DF87A00FDCD00 /* NRMAHarvesterConnection+GZip.m in Sources */ = {isa = PBXBuildFile; fileRef = 2BA9CA42280DF87A00FDCD00 /* NRMAHarvesterConnection+GZip.m */; };
 		2BA9CA46280DF87A00FDCD00 /* NRMAHarvesterConnection+GZip.m in Sources */ = {isa = PBXBuildFile; fileRef = 2BA9CA42280DF87A00FDCD00 /* NRMAHarvesterConnection+GZip.m */; };
 		2BBBE70E28BD528F003CADF3 /* NRMAStartTimerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 2BBBE70D28BD528F003CADF3 /* NRMAStartTimerTests.m */; };
+		2BCA57B42B7E85AD00991C5E /* NRLoggerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 2BCA57B32B7E85AD00991C5E /* NRLoggerTests.m */; };
+		2BCA57B52B7E85AD00991C5E /* NRLoggerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 2BCA57B32B7E85AD00991C5E /* NRLoggerTests.m */; };
 		2BDCA8A42A8C40D50005740D /* NRMASAM.h in Headers */ = {isa = PBXBuildFile; fileRef = 2BDCA8A32A8C40D50005740D /* NRMASAM.h */; };
 		2BDCA8A52A8C40D50005740D /* NRMASAM.h in Headers */ = {isa = PBXBuildFile; fileRef = 2BDCA8A32A8C40D50005740D /* NRMASAM.h */; };
 		2BDCA8AA2A8C41160005740D /* NRMASAM.mm in Sources */ = {isa = PBXBuildFile; fileRef = 2BDCA8A92A8C41160005740D /* NRMASAM.mm */; };
@@ -1900,6 +1902,8 @@
 		2BA9CA42280DF87A00FDCD00 /* NRMAHarvesterConnection+GZip.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NRMAHarvesterConnection+GZip.m"; sourceTree = "<group>"; };
 		2BBBE6FA28BD528F003CADF3 /* NRMAStartTimerTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NRMAStartTimerTests.h; sourceTree = "<group>"; };
 		2BBBE70D28BD528F003CADF3 /* NRMAStartTimerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = NRMAStartTimerTests.m; sourceTree = "<group>"; };
+		2BCA579F2B7E85AD00991C5E /* NRLoggerTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NRLoggerTests.h; sourceTree = "<group>"; };
+		2BCA57B32B7E85AD00991C5E /* NRLoggerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = NRLoggerTests.m; sourceTree = "<group>"; };
 		2BDCA8A32A8C40D50005740D /* NRMASAM.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NRMASAM.h; sourceTree = "<group>"; };
 		2BDCA8A92A8C41160005740D /* NRMASAM.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = NRMASAM.mm; sourceTree = "<group>"; };
 		2BDCA8B02A8C43040005740D /* NRMASAMTest.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = NRMASAMTest.mm; sourceTree = "<group>"; };
@@ -2341,6 +2345,8 @@
 				0209AC7524E7392E00E45C90 /* NewRelicNonJenkinsTests-Bridging-Header.h */,
 				0209AC7124E7392E00E45C90 /* NRCPUVitalsTest.h */,
 				0209AC8224E7393100E45C90 /* NRCPUVitalsTest.m */,
+				2BCA579F2B7E85AD00991C5E /* NRLoggerTests.h */,
+				2BCA57B32B7E85AD00991C5E /* NRLoggerTests.m */,
 				0209AC7924E7392F00E45C90 /* NRCustomMetricsTests.h */,
 				0209AC8624E7393200E45C90 /* NRCustomMetricsTests.m */,
 				0209AC8B24E7393300E45C90 /* NRMA_Swift_Trouble_Class.h */,
@@ -4363,6 +4369,7 @@
 				0209AC3F24E7075200E45C90 /* NRHarvesterStateTest.m in Sources */,
 				0209AC2F24E7073800E45C90 /* NRMAHarvestableHTTPReqeustTests.m in Sources */,
 				0209ABD724E706AE00E45C90 /* TestHexUploader.m in Sources */,
+				2BCA57B42B7E85AD00991C5E /* NRLoggerTests.m in Sources */,
 				0209AC2924E7071F00E45C90 /* NRMeasurementPoolTest.m in Sources */,
 				0209AC0324E7070900E45C90 /* NRMASessionExclusivityWithDelegateTests.m in Sources */,
 				0209AC8E24E7393300E45C90 /* NRThreadTest.m in Sources */,
@@ -4600,6 +4607,7 @@
 				2B40F4FF28BEB95E00EAD248 /* NRMAStartTimerTests.m in Sources */,
 				025657FC24EB19BF00FE3125 /* TestUITableViewInstrumentation.m in Sources */,
 				025657FD24EB19BF00FE3125 /* TestHexUploadPublisher.mm in Sources */,
+				2BCA57B52B7E85AD00991C5E /* NRLoggerTests.m in Sources */,
 				025657FE24EB19BF00FE3125 /* NRMetricTests.m in Sources */,
 				025657FF24EB19BF00FE3125 /* TestSessionIdentifierManger.m in Sources */,
 				343883572834405700B31C2E /* NRMAURLTransformerTests.m in Sources */,

Agent/CrashHandler/NRMACrashDataUploader.m

@@ -105,21 +105,23 @@ - (void) uploadFileAtPath:(NSURL*)path
     // Get the size in bytes of the crash report to be uploaded via below uploadTaskWithRequest:fromFile call.
     __block NSData* reqData = [NSData dataWithContentsOfURL:path options:0 error:nil];
     NSURLRequest* request = [self buildPost];
-    
+
     if ([reqData length] > kNRMAMaxPayloadSizeLimit) {
         NRLOG_ERROR(@"Unable to upload crash log because payload is larger than 1 MB, discarding crash report");
         [NRMASupportMetricHelper enqueueMaxPayloadSizeLimitMetric:@"mobile_crash"];
         // Remove the crash log even though we couldn't upload so we don't try every time.
         [self removeCrashLogAtpath:path];
         return;
-   }
-
+    }
+
+    NRLOG_VERBOSE(@"NEWRELIC CRASH UPLOADER - Perform crash upload");
+
     [[self.uploadSession uploadTaskWithRequest:request fromFile:path completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable responseError) {
         NRLOG_VERBOSE(@"NEWRELIC CRASH UPLOADER - Crash Upload Response: %@", response);
         if(responseError) {
             NRLOG_ERROR(@"NEWRELIC CRASH UPLOADER - Crash Upload Response Error: %@", responseError);
         }
-        
+
         if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
 
             unsigned long long requestLength = [reqData length];
@@ -177,7 +179,7 @@ - (BOOL) shouldUploadFileWithUniqueIdentifier:(NSString*)key {
     if (value.integerValue > kNRMAMaxCrashUploadRetry) {
         [self stopTrackingFileUploadWithUniqueIdentifier:key];
 
-        
+
         return NO;
     }
 

Agent/FeatureFlags/NRMAFlags.m

@@ -168,8 +168,7 @@ + (BOOL) shouldEnableOfflineStorage {
 }
 
 + (BOOL) shouldEnableLogReporting {
-    return NO;
-    //return ([NRMAFlags featureFlags] & NRFeatureFlag_LogReporting) != 0;
+    return ([NRMAFlags featureFlags] & NRFeatureFlag_LogReporting) != 0;
 }
 + (BOOL) shouldEnableNewEventSystem {
     return ([NRMAFlags featureFlags] & NRFeatureFlag_NewEventSystem) != 0;
@@ -227,11 +226,9 @@ + (BOOL) shouldEnableNewEventSystem {
     if ((flags & NRFeatureFlag_OfflineStorage) == NRFeatureFlag_OfflineStorage) {
         [retArray addObject:@"OfflineStorage"];
     }
-
-    // NOTE: Temporarily removed NRFeatureFlag_LogReporting
-//    if ((flags & NRFeatureFlag_LogReporting) == NRFeatureFlag_LogReporting) {
-//        [retArray addObject:@"LogReporting"];
-//    }
+    if ((flags & NRFeatureFlag_LogReporting) == NRFeatureFlag_LogReporting) {
+        [retArray addObject:@"LogReporting"];
+    }
     if ((flags & NRFeatureFlag_NewEventSystem) == NRFeatureFlag_NewEventSystem) {
         [retArray addObject:@"NewEventSystem"];
     }

Agent/Harvester/DataStore/NRMAAgentConfiguration.m

@@ -127,8 +127,6 @@ - (void) setCrashCollectorHost:(NSString*)host {
 }
 
 - (void) setLoggingURL {
-    if (![NRMAFlags shouldEnableLogReporting]) { return; }
-
     if (self.applicationToken.regionCode.length) {
         _loggingURL = [NSString stringWithFormat:kNRMA_REGION_SPECIFIC_LOGGING_HOST,self.applicationToken.regionCode];
     }
@@ -141,11 +139,13 @@ - (void) setLoggingURL {
     else {
         _loggingURL = kNRMA_DEFAULT_LOGGING_HOST;
     }
-    _loggingURL = [_loggingURL stringByAppendingFormat:@"/log/v1"];
+    _loggingURL = [_loggingURL stringByAppendingFormat:@"/mobile/logs"];
 
     NSString* logURL = [NSString stringWithFormat:@"%@%@", @"https://", _loggingURL];
-
+    
     [NRLogger setLogURL:logURL];
+
+    [NRLogger setLogIngestKey:self.applicationToken.value];
 }
 
 + (NRMAConnectInformation*) connectionInformation

Agent/Harvester/DataStore/NRMAHarvestResponse.h

@@ -14,6 +14,7 @@
 #define UNAUTHORIZED           401
 #define FORBIDDEN              403
 #define NOT_FOUND              404
+#define CONFIGURATION_UPDATE   409
 #define ENTITY_TOO_LARGE       413
 #define INVALID_AGENT_ID       450
 #define UNSUPPORTED_MEDIA_TYPE 415

Agent/Harvester/DataStore/NRMAHarvestResponse.m

@@ -24,6 +24,7 @@ - (int) getResponseCode
         case FORBIDDEN:
         case INVALID_AGENT_ID:
         case UNSUPPORTED_MEDIA_TYPE:
+        case CONFIGURATION_UPDATE:
             return self.statusCode;
             break;
         default:

Agent/Harvester/DataStore/NRMAHarvesterConfiguration.h

@@ -29,6 +29,8 @@
 #define kNRMA_ACCOUNT_ID @"account_id"
 #define kNMRA_APPLICATION_ID @"application_id"
 #define kNRMA_TRUSTED_ACCOUNT_KEY @"trusted_account_key"
+#define kNRMA_ENTITY_GUID_KEY @"entity_guid"
+#define kNRMA_LOG_REPORTING_KEY @"log_reporting"
 
 #define NRMA_DEFAULT_COLLECT_NETWORK_ERRORS YES  // boolean
 #define NRMA_DEFAULT_REPORT_PERIOD 60            // seconds
@@ -60,6 +62,12 @@
 @property(nonatomic,assign) long long account_id;
 @property(nonatomic,assign) long long application_id;
 @property(nonatomic,strong) NSString* trusted_account_key;
+@property(nonatomic,strong) NSString* entity_guid;
+@property(nonatomic,assign) BOOL      log_reporting_enabled;
+
+// CAN BE
+// NONE < ERROR < WARN < INFO < DEBUG < AUDIT < VERBOSE
+@property(nonatomic,assign) NSString* log_reporting_level;
 
 + (id) defaultHarvesterConfiguration;
 - (BOOL) isValid;

Agent/Harvester/DataStore/NRMAHarvesterConfiguration.m

@@ -86,6 +86,20 @@ - (id) initWithDictionary:(NSDictionary*)dict
         self.application_id = [[dict valueForKey:kNMRA_APPLICATION_ID] longLongValue];
         self.trusted_account_key = [dict valueForKey:kNRMA_TRUSTED_ACCOUNT_KEY];
 
+        if ([dict objectForKey:kNRMA_ENTITY_GUID_KEY]) {
+            self.entity_guid = [dict valueForKey:kNRMA_ENTITY_GUID_KEY];
+        } else {
+            self.entity_guid = @"";
+        }
+
+        // begin parsing log reporting section.
+        if ([dict objectForKey:kNRMA_LOG_REPORTING_KEY]) {
+            id innerDict = [dict objectForKey:kNRMA_LOG_REPORTING_KEY];
+            self.log_reporting_enabled = innerDict[@"enabled"];
+            self.log_reporting_level = innerDict[@"level"];
+        }
+        // end parsing log reporting section.
+
         // The collector does not currently send down this key, but we still want a sane default
         if ([dict objectForKey:kNRMA_AT_MAX_SEND_ATTEMPTS]) {
             self.activity_trace_max_send_attempts = [[dict valueForKey:kNRMA_AT_MAX_SEND_ATTEMPTS] intValue];
@@ -110,6 +124,8 @@ + (id) defaultHarvesterConfiguration
     configuration.activity_trace_max_send_attempts = NRMA_DEFAULT_ACTIVITY_TRACE_MAX_SEND_ATTEMPTS;
     configuration.activity_trace_min_utilization = NRMA_DEFAULT_ACTIVITY_TRACE_MIN_UTILIZATION;
     configuration.trusted_account_key = @"";
+    configuration.entity_guid = @"";
+    configuration.log_reporting_level = @"WARNING";
 
     configuration.at_capture = [NRMATraceConfigurations defaultTraceConfigurations];
     return configuration;
@@ -148,7 +164,17 @@ - (NSDictionary*) asDictionary
     dictionary[kNMRA_APPLICATION_ID] = @(self.application_id);
     dictionary[kNRMA_ACCOUNT_ID] = @(self.account_id);
     dictionary[kNRMA_ENCODING_KEY] = self.encoding_key;
-    dictionary[kNRMA_TRUSTED_ACCOUNT_KEY] = self.trusted_account_key;
+
+    if ([self.trusted_account_key length]) {
+        dictionary[kNRMA_TRUSTED_ACCOUNT_KEY] = self.trusted_account_key;
+    }
+
+    if ([self.entity_guid length]) {
+        dictionary[kNRMA_ENTITY_GUID_KEY] = self.entity_guid;
+    }
+
+    // TODO: Check the right way to handle this inner Dict.
+    //dictionary[kNRMA_LOG_REPORTING_KEY] = @{@"enabled": @(self.log_reporting_enabled), @"level": self.log_reporting_level};
 
     return dictionary;
 }