android-methods-profiler - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #llm #go #golang #rust #deep-learning #linux #awesome #awesome-list #pytorch #mcp #openai

android-methods-profiler

(★ 284)

Yet another Android Profiler for AOSP .trace files

File Explorer

Download Latest Version (.zip)

- - build-plugin.yml
  - checks.yaml
  - pr_master.yaml
- FUNDING.yml
- - macosx.sh
- - FAtrace.properties
  - FAtwb.properties
  - Info.plist
  - register_app_and_extension.sh
- - android-methods-profiler.icns
  - background.png
- build.gradle
- build.gradle.kts
- - add_bookmark.png
  - compare_flame_charts.png
  - compare_traces.png
  - find.png
  - preview.png
  - record_new_trace.png
  - setup.png
  - threads-list.png
- KEYMAP.MD
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- build.gradle.kts
.gitignore
_config.yml
build.gradle.kts
gradle.properties
gradlew
gradlew.bat
LICENSE.txt
README.md
settings.gradle

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Yet Another Methods Profiler for Android (YAMP)
This is tool for analyzing method trace files `.trace` files like [Android Profiler](https://developer.android.com/studio/profile/android-profiler) but works faster, has convenient control, user bookmarks and custom highlighting.

![preview](https://raw.githubusercontent.com/Grigory-Rylov/android-methods-profiler/master/docs/assets/preview.png)

![threads](https://raw.githubusercontent.com/Grigory-Rylov/android-methods-profiler/master/docs/assets/threads-list.png)

![find in trace](https://raw.githubusercontent.com/Grigory-Rylov/android-methods-profiler/master/docs/assets/find.png)

For Russian speaking developers there is a video [guide](https://youtu.be/epJNlw6ez-A)

## Download
![GitHub All Releases](https://img.shields.io/github/downloads/Grigory-Rylov/android-methods-profiler/total?color=%234caf50&style=for-the-badge)  
- [Download latest release](https://github.com/Grigory-Rylov/android-methods-profiler/releases)

## Installation
### Android Studio plugin marketplace
1. Find YAMP plugin and install
2. Start through the `Tools->Launch YAMP` menu or 
by searching for "Launch YAMP" in "Find Actions" (osx: cmd+shift+a, windows/linux: ctrl+shift+a)

https://plugins.jetbrains.com/plugin/16167-yamp

### Standalone app
1. Download android-methods-profiler_{YOUR_VERSION}.jar
2. execute `java -jar android-methods-profiler_{YOUR_VERSION}.jar`

## Keymap
Read about keymap [there](docs/KEYMAP.MD)

## Bookmarks
Helps to mark some methods in trace.
Bookmarks are saved automatically after you add new one.
Bookmarks are stored in `$HOME/android-profile-viewer/markers` folder.
The easiest way to add bookmark is to click on the method and press **m** key.
In the opened dialog enter bookmark name and select color.

You can share current opened trace file with your bookmarks in single 
file by `File -> Export trace with bookmarks` or **Ctrl + Shift + e** , 
then select new file name and send single `*.twb` file to anyone 
who has AndroidMethodsProfiler v20.06.22.0 or newer.

`*.twb`file is zip archive with `.trace` and `.marker` files

![Add bookmarks](https://raw.githubusercontent.com/Grigory-Rylov/android-methods-profiler/master/docs/assets/add_bookmark.png)

## New Trace Recording
After first launch you will see **Setup android sdk home** dialog, please 
enter path to Android SDK Home like `$ANDROID_HOME` and it will be stored in settings file

![Setup Android SDK](https://raw.githubusercontent.com/Grigory-Rylov/android-methods-profiler/master/docs/assets/setup.png)

After clicking on *New Trace* icon or pressing *Ctrl + n* record new trace dialog will be opened.
Saved `.trace` files will be placed in `$HOME/android-profile-viewer/trace` folder

In the opened dialog package field is required, activity name is optional.
If you entered activity name then application will start after clicking `Start` button.
If activity field is empty - you need to start application manually, or it can already be running.

Sampling parameter: The lower the value, the more accurate the report will be, but the greater the load on the mobile phone CPU. For old device, like nexus 5X I prefer 1000 microseconds.
 
You can select two record mode: 
- **Sample Java Methods** : Captures your app’s call stack at frequent intervals during your app’s Java-based code execution.
- **Trace Java Methods** : Instruments your app at runtime to record a timestamp at the beginning and end of each method call.

[More information about recording modes](https://developer.android.com/studio/profile/cpu-profiler#configurations)

![Record new trace](https://raw.githubusercontent.com/Grigory-Rylov/android-methods-profiler/master/docs/assets/record_new_trace.png)

## Report generator
Generates flat list of methods with duration. Can be filtered by duration and/or is current method constructor.

## Highlighting: 
- ![#9ac7fa](https://placehold.it/20/9ac7fa?text=+) Choreographer.doFrame
- ![#96dbcc](https://placehold.it/20/96dbcc?text=+) measuring
- ![#c989ff](https://placehold.it/20/c989ff?text=+) layouting
- ![#749efa](https://placehold.it/20/749efa?text=+) inflating
- ![#faa9da](https://placehold.it/20/faa9da?text=+) drawing
- ![#ffa7a3](https://placehold.it/20/ffa7a3?text=+) request layout

Also you can add custom highlighting:
highlighting mapping placed in `$HOME/android-methods-profiler/colors.json`
for example:
```
[
  {
    "filter": "com.example",
    "color": "FF9595"
  }
]
```
will highlight all methods of classes started with `com.example`.

`colors.json` will be created automatically with sample highlighting

## Find class or methods
To find class or method you should press **Ctrl + f** or manually click to searching field.
Type class name and/or method name for example *SomeClass.someMethod* and press **Enter**.

If current thread data contains any matches to the mask "\*.SomeClass.someMethod.\*" then these elements will be highlighted and the focus will be on the first element found.

If you want to find methods that ends with *SomeClass.someMethod* then type *SomeClass.someMethod()* and profiler will find any matches to the mask "\*.SomeClass.someMethod".

If there is no results in current thread, profiler will search it in another threads and ask you to switch to another thread if threre is any results - this can be very useful!

## Compare traces
You can compare your traces with YAMP. Check [README.md](core/src/main/java/com/github/grishberg/profiler/comparator/README.md)

## Settings
Settings are stored in `$HOME/android-methods-profiler/.android-methods-profiler-settings.json`

## Troubleshooting
If you entered activity name in **New trace** dialog and see "Wait for application..." status, but application is started - try to close Android Studio and record again.

To scale application on hi-res displays on linux, try to edit `/opt/android-methods-profiler/app/android-methods-profiler.cfg` and enter `-Dsun.java2d.uiScale=2` below `[JVMOptions]`

# Building
## App
Execute `./gradlew clean :app:fatJar` , release will be placed at `app/build/libs`

## Plugin
Execute `./gradlew clean :plugin:buildPlugin` , plugin will be placed at `plugin/build/distributions`

# Support me if you like YAMP =)
**ETH ERC20 tokens** : `0x25Ca16AD3c4e9BD1e6e5FDD77eDB019386B68591`

**BNB BEP20 tokens** : `0x25Ca16AD3c4e9BD1e6e5FDD77eDB019386B68591`

**USDT TRC20** : `TSo3X6K54nYq3S64wML4M4xFgTNiENkHwC`

**BTC** : `bc1qmm5lp389scuk2hghgyzdztddwgjnxqa2awrrue`

https://www.tinkoff.ru/cf/4KNjR2SMOAj

# License

YAMP is released under the [Apache License, Version 2.0](LICENSE.txt).