Add ttid span to ActivityLifecycleIntegration #2369

stefanosiano · 2022-11-16T16:05:28Z

📜 Description

Added ttid (time to initial display) span to ActivityLifecycleIntegration

💡 Motivation and Context

We want to add the ttid info to the transactions, so we are adding a span to the automatic activity tracking transactions

💚 How did you test it?

Added unit test to check ttid span is created and cancelled in case activity finishes early

📝 Checklist

I reviewed the submitted code
I added tests to verify the changes
I updated the docs if needed
No breaking changes

🔮 Next steps

github-actions · 2022-11-16T16:06:32Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against f953c3c

…tyStarted(), not onActivityCreated() anymore

github-actions · 2022-11-16T16:19:07Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	375.68 ms	454.04 ms	78.36 ms
Size	1.73 MiB	2.33 MiB	614.00 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`81a1a6c`	328.73 ms	421.28 ms	92.55 ms
`ecf9680`	326.55 ms	360.26 ms	33.71 ms
`ecf9680`	303.12 ms	346.35 ms	43.23 ms
`38e4f11`	358.20 ms	433.73 ms	75.53 ms
`703d523`	330.27 ms	377.66 ms	47.39 ms
`81a1a6c`	294.04 ms	341.19 ms	47.15 ms
`ecf9680`	321.55 ms	385.52 ms	63.97 ms
`4a9c176`	320.62 ms	334.68 ms	14.06 ms
`3695453`	301.78 ms	371.14 ms	69.36 ms
`b85d8aa`	289.35 ms	335.92 ms	46.56 ms

App size

Revision	Plain	With Sentry	Diff
`81a1a6c`	1.73 MiB	2.32 MiB	612.47 KiB
`ecf9680`	1.73 MiB	2.32 MiB	612.39 KiB
`ecf9680`	1.73 MiB	2.32 MiB	612.39 KiB
`38e4f11`	1.73 MiB	2.32 MiB	609.82 KiB
`703d523`	1.73 MiB	2.33 MiB	613.23 KiB
`81a1a6c`	1.73 MiB	2.32 MiB	612.47 KiB
`ecf9680`	1.73 MiB	2.32 MiB	612.39 KiB
`4a9c176`	1.73 MiB	2.33 MiB	612.69 KiB
`3695453`	1.73 MiB	2.32 MiB	611.62 KiB
`b85d8aa`	1.73 MiB	2.32 MiB	611.62 KiB

Previous results on branch: feat/android-ttid

Startup times

Revision	Plain	With Sentry	Diff
`8d63d7f`	327.04 ms	366.00 ms	38.96 ms
`8aeeb7f`	348.82 ms	398.40 ms	49.58 ms
`d125af1`	325.12 ms	361.04 ms	35.92 ms
`2c9607d`	328.42 ms	398.77 ms	70.35 ms
`89f6386`	279.98 ms	356.45 ms	76.47 ms
`15034e6`	346.20 ms	376.02 ms	29.82 ms
`abb2f2e`	346.82 ms	395.04 ms	48.22 ms
`0e7deaa`	353.50 ms	386.40 ms	32.90 ms

App size

Revision	Plain	With Sentry	Diff
`8d63d7f`	1.73 MiB	2.33 MiB	613.28 KiB
`8aeeb7f`	1.73 MiB	2.33 MiB	614.04 KiB
`d125af1`	1.73 MiB	2.33 MiB	614.08 KiB
`2c9607d`	1.73 MiB	2.33 MiB	612.93 KiB
`89f6386`	1.73 MiB	2.33 MiB	614.05 KiB
`15034e6`	1.73 MiB	2.32 MiB	609.87 KiB
`abb2f2e`	1.73 MiB	2.32 MiB	609.87 KiB
`0e7deaa`	1.73 MiB	2.32 MiB	609.87 KiB

codecov-commenter · 2022-11-16T16:28:19Z

Codecov Report

Base: 80.21% // Head: 80.21% // No change to project coverage 👍

Coverage data is based on head (1db34ad) compared to base (703d523).
Patch has no changes to coverable lines.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #2369   +/-   ##
=========================================
  Coverage     80.21%   80.21%           
  Complexity     3772     3772           
=========================================
  Files           302      302           
  Lines         14221    14221           
  Branches       1885     1885           
=========================================
  Hits          11408    11408           
  Misses         2072     2072           
  Partials        741      741

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

romtsn · 2022-11-18T14:26:25Z

I've seen Firebase is taking a slightly different approach using OnDrawListener and posting at front of the queue from within the onDraw method - do you think it can be more precise than our approach? Links for reference

https://github.com/firebase/firebase-android-sdk/blob/e0cfdd60b8c7204805f78874892a03dccbe174af/firebase-perf/src/main/java/com/google/firebase/perf/metrics/AppStartTrace.java#L319

https://github.com/firebase/firebase-android-sdk/blob/e0cfdd60b8c7204805f78874892a03dccbe174af/firebase-perf/src/main/java/com/google/firebase/perf/util/FirstDrawDoneListener.java

stefanosiano · 2022-11-18T15:25:35Z

I'll try to implement it in the same way just to compare the values and see, thanks for posting it

stefanosiano · 2022-11-18T17:53:36Z

Firebase implementation logs a lot of things, but the approach on using OnDrawListener is more reliable.
While timings are the same as this implementation most of the times, there are few cases when using Firebase's approach is unsurprisingly more correct.
I'm making this pr a draft and will switch implementation taking inspiration from Firebase

…pan per activity updated ttidSpan finishing with Firebase's method: span is finished after the very first frame has been drawn using view.getViewTreeObserver().addOnDrawListener added FirstDrawDoneListener Sentry.getSpan() could cause issues

...y-android-core/src/main/java/io/sentry/android/core/internal/util/FirstDrawDoneListener.java

stefanosiano · 2022-12-02T18:41:29Z

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

@@ -206,7 +205,7 @@ protected void onResume() {
    final ISpan span = Sentry.getSpan();
    if (span != null) {
      span.setMeasurement("screen_load_count", screenLoadCount, new MeasurementUnit.Custom("test"));
-      span.finish(SpanStatus.OK);
+      // span.finish(SpanStatus.OK);


@romtsn I found that using Sentry.getSpan() and then span.finish() is finishing the ttid span
Is it something to be worried about? Would a user be already using something like this?

yes, it's possible that the users already do this to finish the activity transaction whenever they think it's suitable for them.

Once we implement #1828, this should not matter anymore, but until then, we should probably mention this in the docs + migration docs, that calling span.finish in onResume will change how ttid span is measured.

CHANGELOG.md

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

romtsn

Looks good to me overall, great job 👍 One more thing I'd like to ask you - could you enable auto-finish for activity transactions and test if it works fine with the ttid spans? I think it shouldn't change anything but just for the sake of correctness.

romtsn · 2022-12-12T11:59:45Z

I think it shouldn't change anything but just for the sake of correctness.

Actually after looking at this one more time, I think it will affect the ttid span, because currently we're finishing it as cancelled inside the stopTracing method, which is also called when auto-finish is enabled.

Perhaps we should only finish the ttid span as cancelled in onActivityDestroyed, otherwise we should just finish the activity transaction, and keep the ttid span running until it finishes itself

stefanosiano · 2022-12-12T14:56:32Z

Perhaps we should only finish the ttid span as cancelled in onActivityDestroyed, otherwise we should just finish the activity transaction, and keep the ttid span running until it finishes itself

Yep, auto-finish stops the ttid. Let's finish the span only in onActivityDestroyed then. Thanks for the catch

What about the stopPreviousTransactions()? It makes sense to cancel the ttid span in that case, right?

romtsn · 2022-12-13T08:46:04Z

What about the stopPreviousTransactions()? It makes sense to cancel the ttid span in that case, right?

yeah I think it makes sense, otherwise it will run indefinitely right? if we switched the screens in the meantime

stefanosiano · 2022-12-13T09:37:05Z

yeah I think it makes sense, otherwise it will run indefinitely right? if we switched the screens in the meantime

It would end when the previous activity is destroyed, but if an activity is started without destroying the previous one, then it would run indefinitely, yeah

…tarts, not anymore if auto-finish option is enabled

added ttid span to ActivityLifecycleIntegration

fd54fa6

SentryFrameMetricsCollector start collecting frameMetrics in onActivi…

1d48b5a

…tyStarted(), not onActivityCreated() anymore

Merge branch 'main' into feat/android-ttid

7af811a

stefanosiano marked this pull request as ready for review November 16, 2022 16:51

stefanosiano requested review from adinauer, romtsn and markushi as code owners November 16, 2022 16:51

stefanosiano added 3 commits November 16, 2022 18:08

updated changelog

501d3e7

Update CHANGELOG.md

ff733e5

Merge branch 'main' into feat/android-ttid

d49606b

romtsn reviewed Nov 18, 2022

View reviewed changes

sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java Outdated Show resolved Hide resolved

stefanosiano marked this pull request as draft November 18, 2022 17:50

stefanosiano added 3 commits November 30, 2022 16:35

Merge branch 'main' into feat/android-ttid

1e8fc53

added Instrumenter.Sentry to ttid span

37b5edc

romtsn reviewed Dec 2, 2022

View reviewed changes

...y-android-core/src/main/java/io/sentry/android/core/internal/util/FirstDrawDoneListener.java Show resolved Hide resolved

stefanosiano commented Dec 2, 2022

View reviewed changes

added reference to Firebase sdk

13a6c1a

stefanosiano mentioned this pull request Dec 6, 2022

add ui.ttid to span operations getsentry/develop#776

Merged

stefanosiano and others added 3 commits December 9, 2022 15:13

Merge branch 'main' into feat/android-ttid

1db34ad

updated ttid span op and descr

168e138

Format code

da34861

romtsn reviewed Dec 10, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

romtsn reviewed Dec 12, 2022

View reviewed changes

sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java Outdated Show resolved Hide resolved

romtsn approved these changes Dec 12, 2022

View reviewed changes

stefanosiano marked this pull request as ready for review December 13, 2022 08:25

stefanosiano added 2 commits December 13, 2022 11:17

ttid span is now cancelled only on destroyed or when a new activity s…

04bbc33

…tarts, not anymore if auto-finish option is enabled

Merge branch 'main' into feat/android-ttid

f953c3c

stefanosiano merged commit b5b855d into main Dec 14, 2022

stefanosiano deleted the feat/android-ttid branch December 14, 2022 08:35

gslevinkov mentioned this pull request Jan 20, 2023

NO-TICKET - Bump Sentry 6.6.0 -> 6.12.1 p2p-org/key-app-android#1141

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ttid span to ActivityLifecycleIntegration #2369

Add ttid span to ActivityLifecycleIntegration #2369

stefanosiano commented Nov 16, 2022

github-actions bot commented Nov 16, 2022 •

edited

github-actions bot commented Nov 16, 2022 •

edited

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/android-ttid

Startup times

App size

codecov-commenter commented Nov 16, 2022 •

edited

romtsn commented Nov 18, 2022

stefanosiano commented Nov 18, 2022

stefanosiano commented Nov 18, 2022

stefanosiano Dec 2, 2022

romtsn Dec 12, 2022

romtsn left a comment

romtsn commented Dec 12, 2022

stefanosiano commented Dec 12, 2022 •

edited

romtsn commented Dec 13, 2022

stefanosiano commented Dec 13, 2022

Add ttid span to ActivityLifecycleIntegration #2369

Add ttid span to ActivityLifecycleIntegration #2369

Conversation

stefanosiano commented Nov 16, 2022

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Nov 16, 2022 • edited

github-actions bot commented Nov 16, 2022 • edited

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/android-ttid

Startup times

App size

codecov-commenter commented Nov 16, 2022 • edited

Codecov Report

romtsn commented Nov 18, 2022

stefanosiano commented Nov 18, 2022

stefanosiano commented Nov 18, 2022

stefanosiano Dec 2, 2022

Choose a reason for hiding this comment

romtsn Dec 12, 2022

Choose a reason for hiding this comment

romtsn left a comment

Choose a reason for hiding this comment

romtsn commented Dec 12, 2022

stefanosiano commented Dec 12, 2022 • edited

romtsn commented Dec 13, 2022

stefanosiano commented Dec 13, 2022

github-actions bot commented Nov 16, 2022 •

edited

github-actions bot commented Nov 16, 2022 •

edited

codecov-commenter commented Nov 16, 2022 •

edited

stefanosiano commented Dec 12, 2022 •

edited