Refactor GaugeMetadata to be logged only when the session is verbose

Author: tejasd

firebase-perf/src/main/java/com/google/firebase/perf/session/FirebasePerformanceSessionSubscriber.kt

@@ -17,8 +17,6 @@
 package com.google.firebase.perf.session
 
 import com.google.firebase.perf.logging.FirebaseSessionsEnforcementCheck
-import com.google.firebase.perf.session.gauges.GaugeManager
-import com.google.firebase.perf.v1.ApplicationProcessState
 import com.google.firebase.sessions.api.SessionSubscriber
 
 class FirebasePerformanceSessionSubscriber(override val isDataCollectionEnabled: Boolean) :
@@ -33,7 +31,5 @@ class FirebasePerformanceSessionSubscriber(override val isDataCollectionEnabled:
 
     val updatedSession = PerfSession.createWithId(sessionDetails.sessionId)
     SessionManager.getInstance().updatePerfSession(updatedSession)
-    GaugeManager.getInstance()
-      .logGaugeMetadata(updatedSession.sessionId(), ApplicationProcessState.FOREGROUND)
   }
 }

firebase-perf/src/main/java/com/google/firebase/perf/session/SessionManager.java

@@ -115,6 +115,9 @@ public void updatePerfSession(PerfSession perfSession) {
       }
     }
 
+    // Log gauge metadata.
+    logGaugeMetadataIfCollectionEnabled();
+
     // Start of stop the gauge data collection.
     startOrStopCollectingGauges();
   }
@@ -153,6 +156,12 @@ public void unregisterForSessionUpdates(WeakReference<SessionAwareObject> client
     }
   }
 
+  private void logGaugeMetadataIfCollectionEnabled() {
+    if (perfSession.isVerbose()) {
+      gaugeManager.logGaugeMetadata(perfSession.sessionId());
+    }
+  }
+
   private void startOrStopCollectingGauges() {
     FirebaseSessionsEnforcementCheck.checkSession(perfSession, "startOrStopCollectingGauges");
 

firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/GaugeManager.java

@@ -274,18 +274,17 @@ private void syncFlush(String sessionId, ApplicationProcessState appState) {
    * Log the Gauge Metadata information to the transport.
    *
    * @param sessionId The {@link PerfSession#sessionId()} ()} to which the collected Gauge Metrics
-   *     should be associated with.
-   * @param appState The {@link ApplicationProcessState} for which these gauges are collected.
+   *                  should be associated with.
    * @return true if GaugeMetadata was logged, false otherwise.
    */
-  public boolean logGaugeMetadata(String sessionId, ApplicationProcessState appState) {
+  public boolean logGaugeMetadata(String sessionId) {
     if (gaugeMetadataManager != null) {
       GaugeMetric gaugeMetric =
           GaugeMetric.newBuilder()
               .setSessionId(sessionId)
               .setGaugeMetadata(getGaugeMetadata())
               .build();
-      transportManager.log(gaugeMetric, appState);
+      transportManager.log(gaugeMetric, ApplicationProcessState.FOREGROUND);
       return true;
     }
     return false;

firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/GaugeManagerTest.java

@@ -385,8 +385,7 @@ public void testGaugeCounterIsDecrementedWhenLogged() {
     // There's no job to log the gauges.
     assertThat(fakeScheduledExecutorService.isEmpty()).isTrue();
 
-    // Generate metrics that don't exceed the GaugeCounter.MAX_COUNT.
-    generateMetricsAndIncrementCounter(20);
+    generateMetricsAndIncrementCounter(MAX_GAUGE_COUNTER_BEFORE_LOGGING - 10);
 
     // There's still no job to log the gauges.
     assertThat(fakeScheduledExecutorService.isEmpty()).isTrue();
@@ -397,7 +396,8 @@ public void testGaugeCounterIsDecrementedWhenLogged() {
     assertThat(fakeScheduledExecutorService.getDelayToNextTask(TimeUnit.MILLISECONDS))
         .isEqualTo(TIME_TO_WAIT_BEFORE_FLUSHING_GAUGES_QUEUE_MS);
 
-    assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCounter + 30);
+    assertThat(GaugeCounter.count())
+        .isEqualTo(priorGaugeCounter + MAX_GAUGE_COUNTER_BEFORE_LOGGING);
     fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
 
     assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCounter);
@@ -561,7 +561,7 @@ public void testLogGaugeMetadataSendDataToTransport() {
     when(fakeGaugeMetadataManager.getMaxAppJavaHeapMemoryKb()).thenReturn(1000);
     when(fakeGaugeMetadataManager.getMaxEncouragedAppJavaHeapMemoryKb()).thenReturn(800);
 
-    testGaugeManager.logGaugeMetadata(testSessionId(1), ApplicationProcessState.FOREGROUND);
+    testGaugeManager.logGaugeMetadata(testSessionId(1));
 
     GaugeMetric recordedGaugeMetric =
         getLastRecordedGaugeMetric(ApplicationProcessState.FOREGROUND);
@@ -588,9 +588,7 @@ public void testLogGaugeMetadataDoesNotLogWhenGaugeMetadataManagerNotAvailable()
             new Lazy<>(() -> fakeCpuGaugeCollector),
             new Lazy<>(() -> fakeMemoryGaugeCollector));
 
-    assertThat(
-            testGaugeManager.logGaugeMetadata(testSessionId(1), ApplicationProcessState.FOREGROUND))
-        .isFalse();
+    assertThat(testGaugeManager.logGaugeMetadata(testSessionId(1))).isFalse();
   }
 
   @Test
@@ -605,14 +603,10 @@ public void testLogGaugeMetadataLogsAfterApplicationContextIsSet() {
             new Lazy<>(() -> fakeCpuGaugeCollector),
             new Lazy<>(() -> fakeMemoryGaugeCollector));
 
-    assertThat(
-            testGaugeManager.logGaugeMetadata(testSessionId(1), ApplicationProcessState.FOREGROUND))
-        .isFalse();
+    assertThat(testGaugeManager.logGaugeMetadata(testSessionId(1))).isFalse();
 
     testGaugeManager.initializeGaugeMetadataManager(ApplicationProvider.getApplicationContext());
-    assertThat(
-            testGaugeManager.logGaugeMetadata(testSessionId(1), ApplicationProcessState.FOREGROUND))
-        .isTrue();
+    assertThat(testGaugeManager.logGaugeMetadata(testSessionId(1))).isTrue();
 
     GaugeMetric recordedGaugeMetric =
         getLastRecordedGaugeMetric(ApplicationProcessState.FOREGROUND);