Proof of Concept: Frame Timing Integration

[ueman]

📜 Description

Proof of concept for tracking frame durations.

It's not really useful without being able to better determine what's causing it.

💡 Motivation and Context

#513

💚 How did you test it?

Not yet

📝 Checklist

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

🔮 Next steps

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 3.22581% with 30 lines in your changes missing coverage. Please review.

Project coverage is 90.50%. Comparing base (679dce9) to head (eb560b7).
Report is 1687 commits behind head on main.

Files with missing lines	Patch %	Lines
...lib/src/integrations/frame_timing_integration.dart	3.22%	30 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #519      +/-   ##
==========================================
- Coverage   91.67%   90.50%   -1.17%     
==========================================
  Files          70       71       +1     
  Lines        2318     2349      +31     
==========================================
+ Hits         2125     2126       +1     
- Misses        193      223      +30     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ueman]

I haven't yet found a way to determine the device current refresh rate.

[ueman]

Average frame time would be nice to know, too.

[ueman]

Now that we have performance tracing, we can add frame metrics just like Android or iOS

[ueman]

@marandaneto Is there some documentation on how these values should be added to transactions? Or do I have to go by the Android/iOS source code?

[marandaneto]

@marandaneto Is there some documentation on how these values should be added to transactions? Or do I have to go by the Android/iOS source code?

there are no official docs yet since mobile vitals is a preview, but if you're willing to work on that, I can guide you.

[ueman]

@marandaneto that would be nice

[ueman]

If I understand the source code of the Android SDK correctly, I need to add the frame metrics in the following format to a transaction?

{
...
"measurements":{
      "frames_frozen":{
         "value":0.0
      },
      "frames_slow":{
         "value":2.0
      },
      "frames_total":{
         "value":2.0
      }
   }
},
...

I'm assuming the data collection should start (and end) with the start (and end) of a transaction. Is that correct?

[marandaneto]

If I understand the source code of the Android SDK correctly, I need to add the frame metrics in the following format to a transaction?

{
...
"measurements":{
      "frames_frozen":{
         "value":0.0
      },
      "frames_slow":{
         "value":2.0
      },
      "frames_total":{
         "value":2.0
      }
   }
},
...

I'm assuming the data collection should start (and end) with the start (and end) of a transaction. Is that correct?

that's correct, good finding, sorry, we didn't have the time to document it yet.

[ueman]

Are there any hooks for a transaction start and end which I can use to turn on and off frame time recording? The docs state that it has a small performance impact, so I really don't want to have it enabled the whole time.

If there's no hooks, I can think of three ways to enable us to go further with this:

• Add some kind of hooks for transactions. Maybe something like integrations/event processors but just internal?
• A transaction factory which an SDK can register. The Flutter SDK could then subclass the transaction to add frame time recordings
• A method on SentryFlutter to start a subclassed transaction which enables frame time recordings.

[marandaneto]

Are there any hooks for a transaction start and end which I can use to turn on and off frame time recording? The docs state that it has a small performance impact, so I really don't want to have it enabled the whole time.

If there's no hooks, I can think of three ways to enable us to go further with this:

• Add some kind of hooks for transactions. Maybe something like integrations/event processors but just internal?
• A transaction factory which an SDK can register. The Flutter SDK could then subclass the transaction to add frame time recordings
• A method on SentryFlutter to start a subclassed transaction which enables frame time recordings.

ideally, like Android, the measurements are dependent on this issue #611
so we start checking slow/frozen frames when a transaction is created by the navigation transactions.
and then thru the navigation transaction, we can start and stop the measurements monitoring, so no need for hooks or anything, just an integration that handles everything, well, we do need hooks to start and finish a transaction during the screen loading (or routes).