Feat: Perf. for fragments

CHANGELOG.md

@@ -5,7 +5,8 @@
 ## 5.1.0-beta.1
 
 * Feat: Measure app start time (#1487)
-* Feat: Automatic breadcrumbs logging for fragment lifecycle (#1522) 
+* Feat: Automatic breadcrumbs logging for fragment lifecycle (#1522)
+* Feat: Support transaction waiting for children to finish. (#1535) 
 
 ## 5.0.1
 

sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java

@@ -15,6 +15,7 @@
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
 import io.sentry.SpanStatus;
+import io.sentry.TransactionContext;
 import io.sentry.util.Objects;
 import java.io.Closeable;
 import java.io.IOException;
@@ -134,10 +135,14 @@ private void startTracing(final @NonNull Activity activity) {
 
  // in case appStartTime isn't available, we don't create a span for it.
  if (firstActivityCreated || appStartTime == null) {
- transaction = hub.startTransaction(activityName, UI_LOAD_OP);
+ transaction =
+ hub.startTransaction(
+ new TransactionContext(activityName, UI_LOAD_OP), null, false, null, true);
  } else {
  // start transaction with app start timestamp
- transaction = hub.startTransaction(activityName, UI_LOAD_OP, appStartTime);
+ transaction =
+ hub.startTransaction(
+ new TransactionContext(activityName, UI_LOAD_OP), null, false, appStartTime, true);
  // start specific span for app start
 
  appStartSpan = transaction.startChild(getAppStartOp(), getAppStartDesc(), appStartTime);

sentry-android-fragment/api/sentry-android-fragment.api

@@ -8,6 +8,7 @@ public final class io/sentry/android/fragment/BuildConfig {
 
 public final class io/sentry/android/fragment/FragmentLifecycleIntegration : android/app/Application$ActivityLifecycleCallbacks, io/sentry/Integration, java/io/Closeable {
  public fun <init> (Landroid/app/Application;)V
+ public fun <init> (Landroid/app/Application;ZZ)V
  public fun close ()V
  public fun onActivityCreated (Landroid/app/Activity;Landroid/os/Bundle;)V
  public fun onActivityDestroyed (Landroid/app/Activity;)V
@@ -20,9 +21,11 @@ public final class io/sentry/android/fragment/FragmentLifecycleIntegration : and
 }
 
 public final class io/sentry/android/fragment/SentryFragmentLifecycleCallbacks : androidx/fragment/app/FragmentManager$FragmentLifecycleCallbacks {
+ public static final field Companion Lio/sentry/android/fragment/SentryFragmentLifecycleCallbacks$Companion;
  public fun <init> ()V
- public fun <init> (Lio/sentry/IHub;)V
- public synthetic fun <init> (Lio/sentry/IHub;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+ public fun <init> (Lio/sentry/IHub;ZZZ)V
+ public synthetic fun <init> (Lio/sentry/IHub;ZZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+ public fun <init> (ZZZ)V
  public fun onFragmentAttached (Landroidx/fragment/app/FragmentManager;Landroidx/fragment/app/Fragment;Landroid/content/Context;)V
  public fun onFragmentCreated (Landroidx/fragment/app/FragmentManager;Landroidx/fragment/app/Fragment;Landroid/os/Bundle;)V
  public fun onFragmentDestroyed (Landroidx/fragment/app/FragmentManager;Landroidx/fragment/app/Fragment;)V
@@ -36,3 +39,6 @@ public final class io/sentry/android/fragment/SentryFragmentLifecycleCallbacks :
  public fun onFragmentViewDestroyed (Landroidx/fragment/app/FragmentManager;Landroidx/fragment/app/Fragment;)V
 }
 
+public final class io/sentry/android/fragment/SentryFragmentLifecycleCallbacks$Companion {
+}
+

sentry-android-fragment/src/main/java/io/sentry/android/fragment/FragmentLifecycleIntegration.kt

@@ -6,40 +6,49 @@ import android.app.Application.ActivityLifecycleCallbacks
 import android.os.Bundle
 import androidx.fragment.app.FragmentActivity
 import io.sentry.IHub
-import io.sentry.ILogger
 import io.sentry.Integration
 import io.sentry.SentryLevel.DEBUG
 import io.sentry.SentryOptions
 import java.io.Closeable
 
-class FragmentLifecycleIntegration(private val application: Application) :
+class FragmentLifecycleIntegration(
+ private val application: Application,
+ private val enableFragmentLifecycleBreadcrumbs: Boolean,
+ private val enableAutoFragmentLifecycleTracing: Boolean
+) :
  ActivityLifecycleCallbacks,
  Integration,
  Closeable {
 
+ constructor(application: Application) : this(application, true, false)
+
  private lateinit var hub: IHub
- private lateinit var logger: ILogger
+ private lateinit var options: SentryOptions
 
  override fun register(hub: IHub, options: SentryOptions) {
  this.hub = hub
- this.logger = options.logger
+ this.options = options
 
  application.registerActivityLifecycleCallbacks(this)
- logger.log(DEBUG, "FragmentLifecycleIntegration installed.")
+ options.logger.log(DEBUG, "FragmentLifecycleIntegration installed.")
  }
 
  override fun close() {
  application.unregisterActivityLifecycleCallbacks(this)
- if (::logger.isInitialized) {
- logger.log(DEBUG, "FragmentLifecycleIntegration removed.")
+ if (::options.isInitialized) {
+ options.logger.log(DEBUG, "FragmentLifecycleIntegration removed.")
  }
  }
 
  override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) {
  (activity as? FragmentActivity)
  ?.supportFragmentManager
  ?.registerFragmentLifecycleCallbacks(
- SentryFragmentLifecycleCallbacks(hub),
+ SentryFragmentLifecycleCallbacks(
+ hub = hub,
+ enableFragmentLifecycleBreadcrumbs = enableFragmentLifecycleBreadcrumbs,
+ performanceEnabled = options.isTracingEnabled,
+ enableAutoFragmentLifecycleTracing = enableAutoFragmentLifecycleTracing),
  true
  )
  }

sentry-android-fragment/src/main/java/io/sentry/android/fragment/SentryFragmentLifecycleCallbacks.kt

@@ -9,13 +9,33 @@ import androidx.fragment.app.FragmentManager.FragmentLifecycleCallbacks
 import io.sentry.Breadcrumb
 import io.sentry.HubAdapter
 import io.sentry.IHub
+import io.sentry.ISpan
 import io.sentry.SentryLevel.INFO
+import io.sentry.SpanStatus
 
 @Suppress("TooManyFunctions")
 class SentryFragmentLifecycleCallbacks(
- private val hub: IHub = HubAdapter.getInstance()
+ private val hub: IHub = HubAdapter.getInstance(),
+ private val enableFragmentLifecycleBreadcrumbs: Boolean = true,
+ performanceEnabled: Boolean = false,
+ enableAutoFragmentLifecycleTracing: Boolean = false
 ) : FragmentLifecycleCallbacks() {
 
+ constructor(
+ enableFragmentLifecycleBreadcrumbs: Boolean,
+ performanceEnabled: Boolean,
+ enableAutoFragmentLifecycleTracing: Boolean
+ ) : this(
+ hub = HubAdapter.getInstance(),
+ enableFragmentLifecycleBreadcrumbs = enableFragmentLifecycleBreadcrumbs,
+ performanceEnabled = performanceEnabled,
+ enableAutoFragmentLifecycleTracing = enableAutoFragmentLifecycleTracing
+ )
+
+ private val isPerformanceEnabled = performanceEnabled && enableAutoFragmentLifecycleTracing
+
+ private val fragmentsWithOngoingTransactions = mutableMapOf<Fragment, ISpan>()
+
  override fun onFragmentAttached(
  fragmentManager: FragmentManager,
  fragment: Fragment,
@@ -38,6 +58,8 @@ class SentryFragmentLifecycleCallbacks(
  savedInstanceState: Bundle?
  ) {
  addBreadcrumb(fragment, "created")
+
+ startTracing(fragment)
  }
 
  override fun onFragmentViewCreated(
@@ -55,6 +77,9 @@ class SentryFragmentLifecycleCallbacks(
 
  override fun onFragmentResumed(fragmentManager: FragmentManager, fragment: Fragment) {
  addBreadcrumb(fragment, "resumed")
+
+ // ideally it should be post resumed
+ stopTracing(fragment)
  }
 
  override fun onFragmentPaused(fragmentManager: FragmentManager, fragment: Fragment) {
@@ -71,13 +96,18 @@ class SentryFragmentLifecycleCallbacks(
 
  override fun onFragmentDestroyed(fragmentManager: FragmentManager, fragment: Fragment) {
  addBreadcrumb(fragment, "destroyed")
+
+ stopTracing(fragment)
  }
 
  override fun onFragmentDetached(fragmentManager: FragmentManager, fragment: Fragment) {
  addBreadcrumb(fragment, "detached")
  }
 
  private fun addBreadcrumb(fragment: Fragment, state: String) {
+ if (!enableFragmentLifecycleBreadcrumbs) {
+ return
+ }
  val breadcrumb = Breadcrumb().apply {
  type = "navigation"
  setData("state", state)
@@ -91,4 +121,44 @@ class SentryFragmentLifecycleCallbacks(
  private fun getFragmentName(fragment: Fragment): String {
  return fragment.javaClass.simpleName
  }
+
+ private fun isRunningSpan(fragment: Fragment): Boolean =
+ fragmentsWithOngoingTransactions.containsKey(fragment)
+
+ private fun startTracing(fragment: Fragment) {
+ if (!isPerformanceEnabled || isRunningSpan(fragment)) {
+ return
+ }
+
+ val currentSpan = hub.span
+
+ val span: ISpan
+ val fragmentName = getFragmentName(fragment)
+
+ // should be a span of the activity transaction or its own transaction?
+ span = currentSpan?.startChild(FRAGMENT_LOAD_OP, fragmentName)
+ ?: hub.startTransaction(fragmentName, FRAGMENT_LOAD_OP)
+
+ fragmentsWithOngoingTransactions[fragment] = span
+ }
+
+ private fun stopTracing(fragment: Fragment) {
+ if (!isPerformanceEnabled || !isRunningSpan(fragment)) {
+ return
+ }
+
+ val span = fragmentsWithOngoingTransactions[fragment]
+ span?.let {
+ var status = it.status
+ if (status == null) {
+ status = SpanStatus.OK
+ }
+ it.finish(status)
+ fragmentsWithOngoingTransactions.remove(fragment)
+ }
+ }
+
+ companion object {
+ private const val FRAGMENT_LOAD_OP = "fragment.load"
+ }
 }

sentry-samples/sentry-samples-android/api/sentry-samples-android.api

@@ -58,6 +58,15 @@ public final class io/sentry/samples/android/SecondActivity : androidx/appcompat
  public fun <init> ()V
 }
 
+public final class io/sentry/samples/android/ThirdActivityFragment : androidx/appcompat/app/AppCompatActivity {
+ public fun <init> ()V
+}
+
+public final class io/sentry/samples/android/ThirdFragment : androidx/fragment/app/Fragment {
+ public fun <init> ()V
+ public fun onViewCreated (Landroid/view/View;Landroid/os/Bundle;)V
+}
+
 public final class io/sentry/samples/android/databinding/ActivityMainBinding : androidx/viewbinding/ViewBinding {
  public final field addAttachment Landroid/widget/Button;
  public final field anr Landroid/widget/Button;
@@ -68,6 +77,7 @@ public final class io/sentry/samples/android/databinding/ActivityMainBinding : a
  public final field nativeCrash Landroid/widget/Button;
  public final field openSampleFragment Landroid/widget/Button;
  public final field openSecondActivity Landroid/widget/Button;
+ public final field openThirdFragment Landroid/widget/Button;
  public final field sendMessage Landroid/widget/Button;
  public final field sendUserFeedback Landroid/widget/Button;
  public final field setUser Landroid/widget/Button;
@@ -92,6 +102,16 @@ public final class io/sentry/samples/android/databinding/ActivitySecondBinding :
  public static fun inflate (Landroid/view/LayoutInflater;Landroid/view/ViewGroup;Z)Lio/sentry/samples/android/databinding/ActivitySecondBinding;
 }
 
+public final class io/sentry/samples/android/databinding/ActivityThirdFragmentBinding : androidx/viewbinding/ViewBinding {
+ public final field container Landroid/widget/FrameLayout;
+ public final field fragmentContainerView Landroidx/fragment/app/FragmentContainerView;
+ public static fun bind (Landroid/view/View;)Lio/sentry/samples/android/databinding/ActivityThirdFragmentBinding;
+ public synthetic fun getRoot ()Landroid/view/View;
+ public fun getRoot ()Landroid/widget/FrameLayout;
+ public static fun inflate (Landroid/view/LayoutInflater;)Lio/sentry/samples/android/databinding/ActivityThirdFragmentBinding;
+ public static fun inflate (Landroid/view/LayoutInflater;Landroid/view/ViewGroup;Z)Lio/sentry/samples/android/databinding/ActivityThirdFragmentBinding;
+}
+
 public final class io/sentry/samples/android/databinding/FragmentSampleBinding : androidx/viewbinding/ViewBinding {
  public final field container Landroid/widget/FrameLayout;
  public static fun bind (Landroid/view/View;)Lio/sentry/samples/android/databinding/FragmentSampleBinding;
@@ -110,3 +130,11 @@ public final class io/sentry/samples/android/databinding/FragmentSampleInnerBind
  public static fun inflate (Landroid/view/LayoutInflater;Landroid/view/ViewGroup;Z)Lio/sentry/samples/android/databinding/FragmentSampleInnerBinding;
 }
 
+public final class io/sentry/samples/android/databinding/ThirdFragmentBinding : androidx/viewbinding/ViewBinding {
+ public static fun bind (Landroid/view/View;)Lio/sentry/samples/android/databinding/ThirdFragmentBinding;
+ public synthetic fun getRoot ()Landroid/view/View;
+ public fun getRoot ()Landroid/widget/LinearLayout;
+ public static fun inflate (Landroid/view/LayoutInflater;)Lio/sentry/samples/android/databinding/ThirdFragmentBinding;
+ public static fun inflate (Landroid/view/LayoutInflater;Landroid/view/ViewGroup;Z)Lio/sentry/samples/android/databinding/ThirdFragmentBinding;
+}
+

sentry-samples/sentry-samples-android/build.gradle.kts

@@ -93,6 +93,7 @@ dependencies {
  implementation(project(":sentry-android"))
  implementation(project(":sentry-android-okhttp"))
  implementation(project(":sentry-android-fragment"))
+ implementation(Config.Libs.fragment)
 
 // how to exclude androidx if release health feature is disabled
 // implementation(project(":sentry-android")) {

sentry-samples/sentry-samples-android/src/main/AndroidManifest.xml

@@ -33,6 +33,8 @@
 
  <activity android:name=".SecondActivity" />
 
+ <activity android:name=".ThirdActivityFragment" />
+
  <!-- NOTE: Replace the test DSN below with YOUR OWN DSN to see the events from this app in your Sentry project/dashboard-->
  <meta-data android:name="io.sentry.dsn" android:value="https://1053864c67cc410aa1ffc9701bd6f93d@o447951.ingest.sentry.io/5428559" />
 
@@ -79,7 +81,7 @@
  <!-- <meta-data android:name="io.sentry.traces.activity.enable" android:value="false" />-->
 
  <!-- how to disable the Activity auto instrumentation automatically finished on onActivityPostPaused-->
- <meta-data android:name="io.sentry.traces.activity.auto-finish.enable" android:value="false" />
+<!-- <meta-data android:name="io.sentry.traces.activity.auto-finish.enable" android:value="false" />-->
 
  <!-- how to enable and set a sampleRate (anything between 0.01 and 1.0), it's disabled by default-->
  <!-- <meta-data android:name="io.sentry.sample-rate" android:value="0.5" />-->

sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MainActivity.java

@@ -4,9 +4,7 @@
 import android.os.Bundle;
 import androidx.appcompat.app.AppCompatActivity;
 import io.sentry.Attachment;
-import io.sentry.ISpan;
 import io.sentry.Sentry;
-import io.sentry.SpanStatus;
 import io.sentry.UserFeedback;
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.User;
@@ -159,15 +157,11 @@ protected void onCreate(Bundle savedInstanceState) {
  binding.openSampleFragment.setOnClickListener(
  view -> SampleFragment.newInstance().show(getSupportFragmentManager(), null));
 
- setContentView(binding.getRoot());
- }
+ binding.openThirdFragment.setOnClickListener(
+ view -> {
+ startActivity(new Intent(this, ThirdActivityFragment.class));
+ });
 
- @Override
- protected void onResume() {
- super.onResume();
- final ISpan span = Sentry.getSpan();
- if (span != null) {
- span.finish(SpanStatus.OK);
- }
+ setContentView(binding.getRoot());
  }
 }

sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MyApplication.java

@@ -24,7 +24,7 @@ public void onCreate() {
  // return event;
  // });
  // options.setAnrTimeoutIntervalMillis(2000);
- options.addIntegration(new FragmentLifecycleIntegration(MyApplication.this));
+ options.addIntegration(new FragmentLifecycleIntegration(MyApplication.this, true, true));
  });
  }
 

sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/SecondActivity.kt

@@ -89,11 +89,6 @@ class SecondActivity : AppCompatActivity() {
  Sentry.captureException(t)
 
  showText(true, "error: ${t.message}")
-
- // I opt out enableActivityLifecycleTracingAutoFinish so I know best when to end my transaction
- // be sure to finish all your spans before this
- val transaction = Sentry.getSpan()
- transaction?.finish(SpanStatus.INTERNAL_ERROR)
  }
 
  override fun onResponse(call: Call<List<Repo>>, response: Response<List<Repo>>) {
@@ -102,11 +97,6 @@ class SecondActivity : AppCompatActivity() {
  span.finish(SpanStatus.OK)
 
  showText(text = "items: ${repos.size}")
-
- // I opt out enableActivityLifecycleTracingAutoFinish so I know best when to end my transaction
- // be sure to finish all your spans before this
- val transaction = Sentry.getSpan()
- transaction?.finish(SpanStatus.OK)
  }
  })
  }