[Feat][SDK-574] Automatic navigation telemetry events (#361)

* feat: add flag to capture navigation events in AndroidConfiguration

* doc: update javadoc for TelemetryEventTracker

* doc: update javadoc for RollbarTelemetryEventTracker

* feat: Add TelemetryNavigationCallbacks implementation

* feat: init automatic capture of navigation telemetry events

* ci: fix lint

* ci: fix lint

Author: buongarzoni

rollbar-android/src/main/java/com/rollbar/android/AndroidConfiguration.java

@@ -4,18 +4,25 @@
 
 public class AndroidConfiguration {
   private final AnrConfiguration anrConfiguration;
+  private final boolean mustCaptureNavigationEvents;
 
   AndroidConfiguration(Builder builder) {
     anrConfiguration = builder.anrConfiguration;
+    mustCaptureNavigationEvents = builder.mustCaptureNavigationEvents;
   }
 
   public AnrConfiguration getAnrConfiguration() {
     return anrConfiguration;
   }
 
+  public boolean mustCaptureNavigationEvents() {
+    return mustCaptureNavigationEvents;
+  }
+
 
   public static final class Builder {
     private AnrConfiguration anrConfiguration;
+    private boolean mustCaptureNavigationEvents = true;
 
     public Builder() {
       anrConfiguration = new AnrConfiguration.Builder().build();
@@ -31,6 +38,17 @@ public Builder setAnrConfiguration(AnrConfiguration anrConfiguration) {
       return this;
     }
 
+    /**
+     * Enable or disable automatic capture of Telemetry Navigation events (only over new Activities).
+     * Default is enabled.
+     * @param mustCaptureNavigationEvents if automatic capture must be enabled or disabled.
+     * @return the builder instance
+     */
+    public Builder captureNewActivityTelemetryEvents(boolean mustCaptureNavigationEvents) {
+      this.mustCaptureNavigationEvents = mustCaptureNavigationEvents;
+      return this;
+    }
+
     public AndroidConfiguration build() {
       return new AndroidConfiguration(this);
     }

rollbar-android/src/main/java/com/rollbar/android/Rollbar.java

@@ -2,6 +2,7 @@
 
 import static com.rollbar.android.util.Constants.ROLLBAR_NAMESPACE;
 
+import android.app.Application;
 import android.content.Context;
 import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageManager;
@@ -19,6 +20,7 @@
 import com.rollbar.api.payload.data.TelemetryType;
 import com.rollbar.api.payload.data.body.RollbarThread;
 import com.rollbar.notifier.config.ConfigProvider;
+import com.rollbar.notifier.telemetry.TelemetryEventTracker;
 import com.rollbar.notifier.uncaughtexception.RollbarUncaughtExceptionHandler;
 import com.rollbar.android.provider.NotifierProvider;
 import com.rollbar.android.provider.PersonProvider;
@@ -233,6 +235,7 @@ public static Rollbar init(
           suspendWhenNetworkIsUnavailable);
       if (androidConfiguration != null) {
         initAnrDetector(context, androidConfiguration);
+        initAutomaticCaptureOfNavigationTelemetryEvents(context, androidConfiguration);
       }
     }
 
@@ -273,6 +276,7 @@ public static Rollbar init(Context context, ConfigProvider provider) {
       notifier = new Rollbar(context, null, null, true, false, provider);
       AndroidConfiguration androidConfiguration = makeDefaultAndroidConfiguration();
       initAnrDetector(context, androidConfiguration);
+      initAutomaticCaptureOfNavigationTelemetryEvents(context, androidConfiguration);
     }
     return notifier;
   }
@@ -1173,6 +1177,31 @@ public void run() {
     });
   }
 
+  private static void initAutomaticCaptureOfNavigationTelemetryEvents(
+      Context context,
+      AndroidConfiguration androidConfiguration
+  ) {
+    if (!androidConfiguration.mustCaptureNavigationEvents()) {
+      return;
+    }
+
+    com.rollbar.notifier.Rollbar rollbarNotifier = notifier.rollbar;
+    if (rollbarNotifier == null) {
+      return;
+    }
+
+    TelemetryEventTracker telemetryEventTracker = rollbarNotifier.getTelemetryEventTracker();
+    if (telemetryEventTracker == null) {
+      return;
+    }
+
+    Context appContext = context.getApplicationContext();
+    if (appContext instanceof Application) {
+      Application application = (Application) appContext;
+      application.registerActivityLifecycleCallbacks(new TelemetryNavigationCallbacks(telemetryEventTracker));
+    }
+  }
+
   private String loadAccessTokenFromManifest(Context context) throws NameNotFoundException {
     Context appContext = context.getApplicationContext();
     ApplicationInfo ai = appContext.getPackageManager().getApplicationInfo(appContext.getPackageName(), PackageManager.GET_META_DATA);

rollbar-android/src/main/java/com/rollbar/android/TelemetryNavigationCallbacks.java

@@ -0,0 +1,52 @@
+package com.rollbar.android;
+
+import android.app.Activity;
+import android.app.Application;
+import android.os.Bundle;
+
+import com.rollbar.api.payload.data.Level;
+import com.rollbar.api.payload.data.Source;
+import com.rollbar.notifier.telemetry.TelemetryEventTracker;
+
+class TelemetryNavigationCallbacks implements Application.ActivityLifecycleCallbacks {
+    private final TelemetryEventTracker telemetryEventTracker;
+    private String lastActivity;
+
+    TelemetryNavigationCallbacks(TelemetryEventTracker telemetryEventTracker) {
+        this.telemetryEventTracker = telemetryEventTracker;
+    }
+
+    @Override
+    public void onActivityResumed(Activity activity) {
+        String current = activity.getClass().getSimpleName();
+
+        if (lastActivity != null && !lastActivity.equals(current)) {
+            telemetryEventTracker.recordNavigationEventFor(
+                Level.INFO,
+                Source.CLIENT,
+                lastActivity,
+                current
+            );
+        }
+
+        lastActivity = current;
+    }
+
+    @Override
+    public void onActivityCreated(Activity activity, Bundle savedInstanceState) {}
+
+    @Override
+    public void onActivityStarted(Activity activity) {}
+
+    @Override
+    public void onActivityPaused(Activity activity) {}
+
+    @Override
+    public void onActivityStopped(Activity activity) {}
+
+    @Override
+    public void onActivitySaveInstanceState(Activity activity, Bundle outState) {}
+
+    @Override
+    public void onActivityDestroyed(Activity activity) {}
+}

rollbar-java/src/main/java/com/rollbar/notifier/RollbarBase.java

@@ -103,6 +103,14 @@ public void recordNetworkEventFor(Level level, String method, String url, String
     telemetryEventTracker.recordNetworkEventFor(level, getSource(), method, url, statusCode);
   }
 
+  /**
+   * Gives the current TelemetryEventTracker.
+   * @return the {@link TelemetryEventTracker}.
+   */
+  public TelemetryEventTracker getTelemetryEventTracker() {
+    return telemetryEventTracker;
+  }
+
   /**
    * Replace the configuration of this instance directly.
    *

rollbar-java/src/main/java/com/rollbar/notifier/telemetry/RollbarTelemetryEventTracker.java

@@ -14,7 +14,13 @@
 import java.util.concurrent.ConcurrentLinkedQueue;
 
 /**
- * Default {@link TelemetryEventTracker}.
+ * Default implementation of {@link TelemetryEventTracker}.
+ *
+ * <p>This tracker records telemetry events in memory using a bounded, thread-safe
+ * buffer. When the configured maximum capacity is reached, the oldest events
+ * are discarded to make room for new ones.
+ *
+ * <p>Recorded events are returned and cleared when {@link #dump()} is called.
  */
 public class RollbarTelemetryEventTracker implements TelemetryEventTracker {
   public static final int MAXIMUM_CAPACITY_FOR_TELEMETRY_EVENTS = 100;

rollbar-java/src/main/java/com/rollbar/notifier/telemetry/TelemetryEventTracker.java

@@ -7,6 +7,12 @@
 
 import java.util.List;
 
+/**
+ * Collects and manages telemetry events that provide additional runtime
+ * context for error and message payloads.
+ * Telemetry events are typically buffered and cleared after they are
+ * {@link #dump() dumped}.
+ */
 public interface TelemetryEventTracker {
 
   /**