Support importing simpleperf trace files from Android Studio by nisargjhaveri · Pull Request #5212 · firefox-devtools/profiler

nisargjhaveri · 2024-11-15T18:53:35Z

Attempt to add importer for simpleperf trace files. These can be generated using the simpleperf report-sample command or using Profiler UI in Android Studio.

Here is the file format details: https://cs.android.com/android/platform/superproject/main/+/main:system/extras/simpleperf/cmd_report_sample.proto

Added a couple of dependencies to work with protobuf. These will also be useful for more importers in future, I believe pprof also uses protobufs (in discussion at #4462).

This is one attempt. I'm fairly new to the codebase and Flow. Feel free to suggest any changes as required.

codecov · 2024-11-15T19:01:31Z

Codecov Report

Attention: Patch coverage is 96.98113% with 8 lines in your changes missing coverage. Please review.

Project coverage is 86.06%. Comparing base (28e880e) to head (a7493d9).
Report is 92 commits behind head on main.

Files with missing lines	Patch %	Lines
src/profile-logic/import/simpleperf.js	96.88%	8 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5212      +/-   ##
==========================================
- Coverage   88.61%   86.06%   -2.56%     
==========================================
  Files         308      311       +3     
  Lines       28051    29582    +1531     
  Branches     7596     8156     +560     
==========================================
+ Hits        24858    25460     +602     
- Misses       2979     3542     +563     
- Partials      214      580     +366

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

mstange · 2024-11-25T16:10:56Z

Can you share an example output profile?

This importer would be nice to have. As an alternative you can also use samply import perf.data with a samply built from the main branch of https://github.com/mstange/samply .

julienw

Thanks, this looks pretty good! Impressive work!

I suggested a few things, tell me what you think!
Also it would be good to have a few tests, at least one import test. See unit/profile-conversion.test.js for existing tests.

nisargjhaveri · 2024-11-25T21:02:38Z

@mstange Thanks for pointing out samply, seems interesting. I'll have a look! Though this only helps when you have control over the perf.data file which might not be available when exporting the profile from Android Studio.

@julienw Thanks a lot for the review. I have addressed most of the suggestions. Please have a look?

julienw

Thanks, this looks good to me!
I rebased and updated some part of the code that were needed after the rebase and I'm gonna land this soon!
Thanks for your patience

julienw · 2025-01-10T18:24:01Z

Would you want to add some limited documentation around https://profiler.firefox.com/docs/#/./guide-android-profiling ?

PR firefox-devtools#5212 added support for importing simpleperf trace file format. Update the documentation on Android profiling to reflect this.

nisargjhaveri · 2025-01-10T20:28:33Z

Would you want to add some limited documentation around https://profiler.firefox.com/docs/#/./guide-android-profiling ?

Thanks @julienw for updating and merging. Created #5309 to update the documentation.

Updates: [Nicolas Chevobbe] Adapt Keyboard shortcut dialog in High Contrast Mode. (#5245) [Nicolas Chevobbe] Fix sidebar-toggle in High Contrast Mode. (#5246) [Nicolas Chevobbe] Fix timeline selection overlay time / hover line in High Contrast Mode (#5247) [Zac Spitzer] fix broken link for processed profile format (#5267) [Greg Tatum] Update the memory allocation docs and add DHAT docs (#5270) [Markus Stange] Simplify some code related to thread CPU deltas (#5265) [Greg Tatum] Update dhat convertor to work better with valgrind (#5269) [Markus Stange] Rename UniqueStringArray to StringTable. (#5283) [Markus Stange] Use snapshot testing in the symbolicator CLI test. (#5284) [Markus Stange] Fix two confused upgraders which didn't expect to be run on the serialized format. (#5285) [Nicolas Chevobbe] Fix timelineSettingsHiddenTracks in High Contrast Mode. (#5250) [Julien Wajsberg] Fix some test and non-test warnings (#5294) [Nisarg Jhaveri] Support importing simpleperf trace files from Android Studio (#5212) [Sean Kim] Add HTTP response status code in the profiler network tab (#5297) [Markus Stange] Change StringTable API a bit. (#5286) [Markus Stange] Correctly declare imported simpleperf trace profiles to be of the current version. (#5312) [Markus Stange] Two small changes (#5313) [Nazım Can Altınova] Show sample tooltips on sample graph hover (#5298) Also thanks to our localizers: en-CA: chutten es-CL: ravmn es-CL: ravmn fr: Théo Chevalier ia: Melo46 ia: Melo46 sv-SE: Andreas Pettersson uk: Lobodzets zh-TW: Olvcpr423

…5309) PR #5212 added support for importing simpleperf trace file format. Update the documentation on Android profiling to reflect this.

nisargjhaveri added 3 commits November 15, 2024 23:58

Add importer for simpleperf trace profiles

1e1a39e

Ignore generated protobuf files in flowconfig

fc180c5

Fix lints

67bee10

nisargjhaveri mentioned this pull request Nov 15, 2024

Support importing simpleperf trace files from Android Studio #5203

Closed

nisargjhaveri added 3 commits November 18, 2024 00:09

Use weightType only when profiled with cpu-clock

d3fe3e8

Add sampled events in profile info

cafe9c9

Fix minor lint issue

5f4217d

julienw requested changes Nov 25, 2024

View reviewed changes

nisargjhaveri commented Nov 25, 2024

View reviewed changes

Comment thread package.json Outdated

nisargjhaveri added 2 commits November 26, 2024 01:03

Add README for proto, use npx for pbjs

41b17e8

Improve simpleperf importer

ae6b291

julienw self-requested a review December 3, 2024 17:03

nisargjhaveri and others added 5 commits January 10, 2025 19:10

Add test for importing simpleperf trace

c1c2e10

Minor fix, add a log

115cd43

Add toolkit and platform in profile meta

2f811e0

Merge remote-tracking branch 'moz/main' into simpleperf_trace

cc6dc78

Update code following the rename of the UniqueStringArray to StringTable

a97496b

julienw force-pushed the simpleperf_trace branch from a7493d9 to a97496b Compare January 10, 2025 18:18

julienw approved these changes Jan 10, 2025

View reviewed changes

julienw merged commit 72ce344 into firefox-devtools:main Jan 10, 2025

nisargjhaveri mentioned this pull request Jan 10, 2025

Update docs to include Android Studio/Simpleperf trace file support #5309

Merged

julienw mentioned this pull request Jan 15, 2025

Deploy January 15, 2025 #5318

Merged

julienw pushed a commit that referenced this pull request Jan 17, 2025

Update docs to include Android Studio/Simpleperf trace file support (#…

c203a86

…5309) PR #5212 added support for importing simpleperf trace file format. Update the documentation on Android profiling to reflect this.

Uh oh!

Conversation

nisargjhaveri commented Nov 15, 2024

Uh oh!

codecov Bot commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mstange commented Nov 25, 2024

Uh oh!

julienw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nisargjhaveri commented Nov 25, 2024

Uh oh!

julienw left a comment

Choose a reason for hiding this comment

Uh oh!

julienw commented Jan 10, 2025

Uh oh!

nisargjhaveri commented Jan 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Nov 15, 2024 •

edited

Loading