Clean up and clarify Crashlytics logging. (#2362)

* Clean up and clarify Crashlytics logging.

Made some log messages clearer and easier to understand, also
reduced noise by changing the log level on existing logs to:

E: Unexpected/error state, not recoverable. Crashlytics will not function.
W: Unexpected/error state, but recoverable.
D: SDK lifecycle logs ("what" is happening).
   - Unix-style "no news is good news" logging, if something goes
     wrong, it will appear in W or E logs.
V: Finer-grained logging ("how" things are happening).
   - "Success" logs, as well as logging of internally-stored values
     (e.g. current mapping file ID) are logged at this level.

Also modified a few logs to *only* print in an error case.

Author: mrwillis21

firebase-crashlytics-ndk/src/androidTest/java/com/google/firebase/crashlytics/ndk/BreakpadControllerTest.java renamed to firebase-crashlytics-ndk/src/androidTest/java/com/google/firebase/crashlytics/ndk/CrashpadControllerTest.java

@@ -24,9 +24,9 @@
 import java.util.UUID;
 import junit.framework.TestCase;
 
-public class BreakpadControllerTest extends TestCase {
+public class CrashpadControllerTest extends TestCase {
 
-  private BreakpadController controller;
+  private CrashpadController controller;
 
   private Context context;
   private NativeApi mockNativeApi;
@@ -40,7 +40,7 @@ protected void setUp() throws Exception {
     context = ApplicationProvider.getApplicationContext();
     mockNativeApi = mock(NativeApi.class);
     mockFilesManager = mock(CrashFilesManager.class);
-    controller = new BreakpadController(context, mockNativeApi, mockFilesManager);
+    controller = new CrashpadController(context, mockNativeApi, mockFilesManager);
   }
 
   @Override

firebase-crashlytics-ndk/src/main/java/com/google/firebase/crashlytics/ndk/BreakpadController.java renamed to firebase-crashlytics-ndk/src/main/java/com/google/firebase/crashlytics/ndk/CrashpadController.java

@@ -27,7 +27,7 @@
 import java.io.OutputStreamWriter;
 import java.nio.charset.Charset;
 
-class BreakpadController implements NativeComponentController {
+class CrashpadController implements NativeComponentController {
 
   private static final Charset UTF_8 = Charset.forName("UTF-8");
   private static final String SESSION_METADATA_FILE = "session.json";
@@ -39,7 +39,7 @@ class BreakpadController implements NativeComponentController {
   private final NativeApi nativeApi;
   private final CrashFilesManager filesManager;
 
-  BreakpadController(Context context, NativeApi nativeApi, CrashFilesManager filesManager) {
+  CrashpadController(Context context, NativeApi nativeApi, CrashFilesManager filesManager) {
     this.context = context;
     this.nativeApi = nativeApi;
     this.filesManager = filesManager;
@@ -55,7 +55,7 @@ public boolean initialize(String sessionId) {
         initSuccess = nativeApi.initialize(crashReportPath, context.getAssets());
       }
     } catch (IOException e) {
-      Logger.getLogger().e("Error initializing CrashlyticsNdk", e);
+      Logger.getLogger().e("Error initializing Crashlytics NDK", e);
     }
     return initSuccess;
   }
@@ -82,12 +82,14 @@ public SessionFiles getFilesForSession(String sessionId) {
     final File sessionFileDirectoryForMinidump = new File(sessionFileDirectory, "pending");
 
     Logger.getLogger()
-        .d("Minidump directory: " + sessionFileDirectoryForMinidump.getAbsolutePath());
+        .v("Minidump directory: " + sessionFileDirectoryForMinidump.getAbsolutePath());
 
     File minidump = getSingleFileWithExtension(sessionFileDirectoryForMinidump, ".dmp");
 
     Logger.getLogger()
-        .d("Minidump " + (minidump != null && minidump.exists() ? "exists" : "does not exist"));
+        .v(
+            "Minidump file "
+                + (minidump != null && minidump.exists() ? "exists" : "does not exist"));
 
     final SessionFiles.Builder builder = new SessionFiles.Builder();
     if (sessionFileDirectory != null

firebase-crashlytics-ndk/src/main/java/com/google/firebase/crashlytics/ndk/FirebaseCrashlyticsNdk.java

@@ -31,7 +31,7 @@ static FirebaseCrashlyticsNdk create(@NonNull Context context) {
     final File rootDir = new File(context.getFilesDir(), FILES_PATH);
 
     final NativeComponentController controller =
-        new BreakpadController(
+        new CrashpadController(
             context, new JniNativeApi(context), new NdkCrashFilesManager(rootDir));
     return new FirebaseCrashlyticsNdk(controller);
   }
@@ -50,8 +50,9 @@ public boolean hasCrashDataForSession(@NonNull String sessionId) {
   @Override
   public boolean openSession(String sessionId) {
     final boolean initSuccess = controller.initialize(sessionId);
-    Logger.getLogger()
-        .i("Crashlytics NDK initialization " + (initSuccess ? "successful" : "FAILED"));
+    if (!initSuccess) {
+      Logger.getLogger().w("Failed to initialize Crashlytics NDK for session " + sessionId);
+    }
     return initSuccess;
   }
 

firebase-crashlytics/src/androidTest/java/com/google/firebase/crashlytics/internal/settings/network/DefaultSettingsSpiCallTest.java

@@ -186,7 +186,13 @@ public void testHandleResponse_requestNotSuccessful() throws IOException {
 
     assertNull(defaultSettingsSpiCall.handleResponse(mockHttpResponse));
     verify(mockHttpResponse, never()).body();
-    verify(mockLogger, times(1)).e(eq("Failed to retrieve settings from " + TEST_URL));
+    verify(mockLogger, times(1))
+        .e(
+            eq(
+                "Settings request failed; (status: "
+                    + HttpURLConnection.HTTP_INTERNAL_ERROR
+                    + ") from "
+                    + TEST_URL));
   }
 
   public void testRequestWasSuccessful_successfulStatusCodes() {

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/CrashlyticsAnalyticsListener.java

@@ -20,6 +20,7 @@
 import com.google.firebase.analytics.connector.AnalyticsConnector.AnalyticsConnectorListener;
 import com.google.firebase.crashlytics.internal.Logger;
 import com.google.firebase.crashlytics.internal.analytics.AnalyticsEventReceiver;
+import java.util.Locale;
 
 /**
  * Crashlytics listener for Firebase Analytics events. Processes incoming events and passes those
@@ -46,7 +47,10 @@ public void setBreadcrumbEventReceiver(@Nullable AnalyticsEventReceiver receiver
 
   @Override
   public void onMessageTriggered(int id, @Nullable Bundle extras) {
-    Logger.getLogger().d("Received Analytics message: " + id + " " + extras);
+    Logger.getLogger()
+        .v(
+            String.format(
+                Locale.US, "Analytics listener received message. ID: %d, Extras: %s", id, extras));
 
     if (extras == null) {
       return;

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/FirebaseCrashlytics.java

@@ -92,7 +92,6 @@ public class FirebaseCrashlytics {
 
     if (analyticsConnector != null) {
       // If FA is available, create a logger to log events from the Crashlytics origin.
-      Logger.getLogger().d("Firebase Analytics is available.");
       final CrashlyticsOriginAnalyticsEventLogger directAnalyticsEventLogger =
           new CrashlyticsOriginAnalyticsEventLogger(analyticsConnector);
 
@@ -107,7 +106,7 @@ public class FirebaseCrashlytics {
           subscribeToAnalyticsEvents(analyticsConnector, crashlyticsAnalyticsListener);
 
       if (analyticsConnectorHandle != null) {
-        Logger.getLogger().d("Firebase Analytics listener registered successfully.");
+        Logger.getLogger().d("Registered Firebase Analytics listener.");
         // Create the event receiver which will supply breadcrumb events to Crashlytics
         final BreadcrumbAnalyticsEventReceiver breadcrumbReceiver =
             new BreadcrumbAnalyticsEventReceiver();
@@ -132,7 +131,8 @@ public class FirebaseCrashlytics {
         // Set the blocking analytics event logger for Crashlytics.
         analyticsEventLogger = blockingAnalyticsEventLogger;
       } else {
-        Logger.getLogger().d("Firebase Analytics listener registration failed.");
+        Logger.getLogger()
+            .w("Could not register Firebase Analytics listener; a listener is already registered.");
         // FA is enabled, but the listener was not registered successfully.
         // We cannot listen for breadcrumbs.
         breadcrumbSource = new DisabledBreadcrumbSource();
@@ -142,7 +142,7 @@ public class FirebaseCrashlytics {
       }
     } else {
       // FA is entirely unavailable. We cannot listen for breadcrumbs or send events.
-      Logger.getLogger().d("Firebase Analytics is unavailable.");
+      Logger.getLogger().d("Firebase Analytics is not available.");
       breadcrumbSource = new DisabledBreadcrumbSource();
       analyticsEventLogger = new UnavailableAnalyticsEventLogger();
     }
@@ -170,11 +170,11 @@ public class FirebaseCrashlytics {
       appData =
           AppData.create(context, idManager, googleAppId, mappingFileId, unityVersionProvider);
     } catch (PackageManager.NameNotFoundException e) {
-      Logger.getLogger().e("Could not retrieve app info, initialization failed.", e);
+      Logger.getLogger().e("Error retrieving app package info.", e);
       return null;
     }
 
-    Logger.getLogger().d("Installer package name is: " + appData.installerPackageName);
+    Logger.getLogger().v("Installer package name is: " + appData.installerPackageName);
 
     final ExecutorService threadPoolExecutor =
         ExecutorUtils.buildSingleThreadExecutorService("com.google.firebase.crashlytics.startup");
@@ -282,7 +282,7 @@ public static FirebaseCrashlytics getInstance() {
    */
   public void recordException(@NonNull Throwable throwable) {
     if (throwable == null) { // Users could call this with null despite the annotation.
-      Logger.getLogger().w("Crashlytics is ignoring a request to log a null exception.");
+      Logger.getLogger().w("A null value was passed to recordException. Ignoring.");
       return;
     }
     core.logException(throwable);

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/analytics/BlockingAnalyticsEventLogger.java

@@ -51,23 +51,25 @@ public BlockingAnalyticsEventLogger(
   @Override
   public void logEvent(@NonNull String name, @Nullable Bundle params) {
     synchronized (latchLock) {
-      Logger.getLogger().d("Logging Crashlytics event to Firebase");
+      Logger.getLogger()
+          .v("Logging event " + name + " to Firebase Analytics with params " + params);
       this.eventLatch = new CountDownLatch(1);
       this.callbackReceived = false;
 
       baseAnalyticsEventLogger.logEvent(name, params);
 
-      Logger.getLogger().d("Awaiting app exception callback from FA...");
+      Logger.getLogger().v("Awaiting app exception callback from Analytics...");
       try {
         if (eventLatch.await(timeout, timeUnit)) {
           callbackReceived = true;
-          Logger.getLogger().d("App exception callback received from FA listener.");
+          Logger.getLogger().v("App exception callback received from Analytics listener.");
         } else {
           Logger.getLogger()
-              .d("Timeout exceeded while awaiting app exception callback from FA listener.");
+              .w("Timeout exceeded while awaiting app exception callback from Analytics listener.");
         }
       } catch (InterruptedException ie) {
-        Logger.getLogger().d("Interrupted while awaiting app exception callback from FA listener.");
+        Logger.getLogger()
+            .e("Interrupted while awaiting app exception callback from Analytics listener.");
       }
 
       this.eventLatch = null;

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/common/CommonUtils.java

@@ -158,7 +158,7 @@ static Architecture getValue() {
       String arch = Build.CPU_ABI;
 
       if (TextUtils.isEmpty(arch)) {
-        Logger.getLogger().d("Architecture#getValue()::Build.CPU_ABI returned null or empty");
+        Logger.getLogger().v("Architecture#getValue()::Build.CPU_ABI returned null or empty");
         return UNKNOWN;
       }
 
@@ -195,7 +195,7 @@ public static synchronized long getTotalRamInBytes() {
             // leave in this handling since we don't know for certain it isn't.
             bytes = convertMemInfoToBytes(result, "GB", BYTES_IN_A_GIGABYTE);
           } else {
-            Logger.getLogger().d("Unexpected meminfo format while computing RAM: " + result);
+            Logger.getLogger().w("Unexpected meminfo format while computing RAM: " + result);
           }
         } catch (NumberFormatException e) {
           Logger.getLogger().e("Unexpected meminfo format while computing RAM: " + result, e);
@@ -606,7 +606,7 @@ public static String resolveUnityEditorVersion(Context context) {
     final int id = CommonUtils.getResourcesIdentifier(context, UNITY_EDITOR_VERSION, "string");
     if (id != 0) {
       version = context.getResources().getString(id);
-      Logger.getLogger().d("Unity Editor version is: " + version);
+      Logger.getLogger().v("Unity Editor version is: " + version);
     }
     return version;
   }