Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uber/nanoscope
An extremely accurate Android method tracing tool.
https://github.com/uber/nanoscope
android performance profiler tracing
Last synced: 6 days ago
JSON representation
An extremely accurate Android method tracing tool.
- Host: GitHub
- URL: https://github.com/uber/nanoscope
- Owner: uber
- License: apache-2.0
- Created: 2018-03-05T22:45:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-18T18:43:41.000Z (over 4 years ago)
- Last Synced: 2024-12-08T21:09:02.196Z (13 days ago)
- Topics: android, performance, profiler, tracing
- Language: HTML
- Homepage:
- Size: 6.97 MB
- Stars: 1,251
- Watchers: 37
- Forks: 68
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - uber/nanoscope - An extremely accurate Android method tracing tool. (HTML)
README
# Nanoscope
An extremely accurate Android method tracing tool.
## Overview
Nanoscope is a method tracing tool optimized for extreme accuracy. The tool's overhead has been measured at around ~20 nanoseconds per method (on a Nexus 6P). To achieve this performance, the interesting pieces of Nanoscope are implemented as a [fork of AOSP](https://github.com/uber/nanoscope-art). For this reason, **you'll need to use the Nanoscope Emulator or a device running the Nanoscope OS in order to make use of this tool**. The entrypoint for launching the Nanoscope emulator, provisioning a device with the custom OS, and starting/stopping tracing is the `nanoscope` command-line tool described below.
For more information on motivation and architecture, check out our [blog post](https://eng.uber.com/nanoscope/) and the [wiki](https://github.com/uber/nanoscope/wiki).
## Installation
**Install the `nanoscope` command**
```bash
$ brew tap uber/nanoscope
$ brew install nanoscope
```
## Nanoscope Emulator / Devices
Nanoscope only works with the Nanoscope Emulator or with a device that's running the Nanoscope OS.
**Launch Nanoscope Emulator**
```bash
# Prerequisites
# - $ANDROID_HOME environment variable is set
# - macOS
$ nanoscope emulator
```
**Flash ADB-connected phone with the Nanoscope OS**
If you want to use Nanoscope with a real device, you can execute the following command to replace your stock Android OS with the Nanoscope OS.
*IMPORTANT: This will only work with a Nexus 6P - do not attempt to flash any other device*
*IMPORTANT: This command installs a custom operating system onto the device. There is no way to undo this operation.*
```bash
# Prerequisites
# - Nexus 6p is the only supported device at this time
# - OEM Unlocking is enabled (Settings -> Developer Options -> OEM unlocking)
# - Device is connected via ADB
$ nanoscope flash
```
## Usage
**Start tracing on ADB-connected device**
```bash
$ nanoscope start
Tracing... (Press ENTER to stop)
```
**Startup tracing**
```bash
$ nanoscope start --package=com.example.app
Tracing... (Press ENTER to stop)
```
It's necessary to specify the application package if you want to start tracing before running the app.
**Extensions**
In addition to method tracing, Nanoscope can generate additional
information about executing application (e.g. CPU utilization for a
given thread, number of page faults, object allocation
information). You can enable this additional functionality by using
`--ext` parameter with `nanoscope start` command. It is also necessary
to change the kernel setting of Nexus 6P as follows:
```bash
$ adb shell "echo -1 >/proc/sys/kernel/perf_event_paranoid"
```
Please note that extended functionality DOES NOT work on emulators
(and is therefore not included in our emulator release). Additional
information about this Nanoscope extension can be found
[here](https://github.com/uber/nanoscope/wiki/Trace-Extensions).
## Upgrade
**Client**
```
$ brew update && brew upgrade nanoscope
```
**OS**
```
$ brew update && brew upgrade nanoscope
$ nanoscope flash
```
## License
```
Copyright (C) 2017 Uber Technologies
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```