Analyzing Display and Performance

In this document

Overview
Generating Traces
Tracing Application Code
Analyzing Traces
1. Long running processes
2. Interruptions in display execution

Overview

Systrace helps you analyze how the execution of your application fits into the larger Android environment, letting you see system and applications process execution on a common timeline. The tool allows you to generate highly detailed, interactive reports from devices running Android 4.1 and higher, such as the report in figure 1.

Figure 1. An example Systrace report on 5 seconds of process execution for a running application and related Android system processes.

Generating Traces

In order to create a trace of your application, you must perform a few setup steps. First, you must have a device running Android 4.1 or higher. Set up the device for debugging, connect it to your development system, and install your application. Some types of trace information, specifically disk activity and kernel work queues, require that you have root access to the device. However, most Systrace log data only requires that the device be enabled for developer debugging.

Systrace traces can be run either from a command line or from a graphical user interface. This guide focuses on using the command line options.

Limiting trace data

The Systrace tool can generate a potentially huge amount of data from applications and system sources. To limit the amount of data the tool collects and make the data more relevant to your analysis, use the following options:

Limit the amount of time covered by the trace with the -t, --time option. The default length of a trace is 5 seconds.
Limit the size of the data collected by the trace with the -b, --buf-size option.
Specify what types of processes are traced. The types of processes that can be traced depends on the version of Android you are running:
- Android 4.2 and lower devices: Use the --set-tags option and the --disk, --cpu-freq, --cpu-idle, --cpu-load options.
- Android 4.3 and higher devices: Use the --list-categories option to see what categories are available on your test device.

Tracing on Android 4.3 and higher

To run a trace on Android 4.3 and higher devices:

Make sure the device is connected through a USB cable and is enabled for debugging.

Run the trace with the options you want, for example:

$ cd android-sdk/platform-tools/systrace
$ python systrace.py --time=10 -o mynewtrace.html sched gfx view wm

On the device, execute any user actions you want be included in the trace.

For more information on the available options for running Systrace, see the Systrace help page.

Tracing on Android 4.2 and lower

To use Systrace effectively with devices running Android 4.2 and lower, you must configure the types of processes you want to trace before running a trace. The tool can gather the following types of process information:

General system processes such as graphics, audio and input processes (selected using trace category tags).
Low level system information such as CPU, kernel and disk activity (selected using options).

To set trace tags for Systrace using the command-line:

Use the --set-tags option:

$ cd android-sdk/platform-tools/systrace
$ python systrace.py --set-tags=gfx,view,wm

Stop and restart the adb shell to enable tracing of these processes.
```
$ adb shell stop
$ adb shell start
```

To set trace tags for Systrace using the device user interface:

On the device connected for tracing, navigate to: Settings > Developer options > Monitoring > Enable traces.
Select the categories of processes to be traced and click OK.

Note: The adb shell does not have to be stopped and restarted when selecting trace tags using this method.

After you have configured the category tags for your trace, you can start collecting information for analysis.

To run a trace using the current trace tag settings:

Make sure the device is connected through a USB cable and is enabled for debugging.
Run the trace with the low-level system trace options and limits you want, for example:
```
$ python systrace.py --cpu-freq --cpu-load --time=10 -o mytracefile.html
```
On the device, execute any user actions you want be included in the trace.

For more information on the available options for running Systrace, see the Systrace help page.

Tracing Application Code

The Systrace tool can trace the execution of code within your application. In Android 4.3 (API level 18) and higher, you can use the methods of the Trace class to add instrumentation to your application code and see the results in a Systrace report.

The following code example shows how to use the Trace class to track execution of an application method, including two nested code blocks within that method.

public void ProcessPeople() {
    Trace.beginSection("ProcessPeople");
    try {
        Trace.beginSection("Processing Jane");
        try {
            // code for Jane task...
        } finally {
            Trace.endSection(); // ends "Processing Jane"
        }

        Trace.beginSection("Processing John");
        try {
            // code for John task...
        } finally {
            Trace.endSection(); // ends "Processing John"
        }
    } finally {
        Trace.endSection(); // ends "ProcessPeople"
    }
}

Note: When you nest trace calls within each other, the endSection() method ends the most recently called beginSection(String) method. This means that a trace started within another trace cannot extend beyond the end of the enclosing trace, so make sure your beginning and ending method calls are properly matched to measure your applications processing.

Note: Traces must begin and end on the same thread. Do not call beginSection(String) on one thread of execution and then attempt to end the trace with a call to endSection() on another thread.

When using application-level tracing with Systrace, you must specify the package name of your application in the user interface or specify the -a or --app= options on the command line. For more information, see the Systrace help page.

Analyzing Traces

After you have generated a trace using Systrace, it lists the location of the output file and you can open the report using a web browser. How you use the trace data depends on the performance issues you are investigating. However, this section provides some general instructions on how to analyze a trace.

The reports generated by Systrace are interactive, allowing you to zoom into and out of the process execution details. Use the W key to zoom in, the S key to zoom out, the A key to pan left and the D key to pan right. Select a task in timeline using your mouse to get more information about the task. For more information about the using the keyboard navigation shortcuts and navigation, see the Systrace reference documentation.

Long running processes

A well-behaved application executes many small operations quickly and with a regular rhythm, with individual operations completing within few milliseconds, depending on the device and the processes being performed, as shown in figure 2:

Figure 2. Excerpt from a trace of a smoothly running application with a regular execution rhythm.

The trace excerpt in figure 2 shows a well-behaved application with a regular process rhythm (1). The lower section of figure 2 shows a magnified section of the trace indicated by the dotted outline, which reveals some irregularity in the process execution. In particular, one of the wider task bars, indicated by (2), is taking slightly longer (14 milliseconds) than other, similar tasks on this thread, which are averaging between 9 and 12 milliseconds to complete. This particular task execution length is likely not noticeable to a user, unless it impacts another process with specific timing, such as a screen update.

Long running processes show up as thicker than usual execution bars in a trace. These thicker bars can indicate a problem in your application performance. When they show up in your trace, zoom in on the process using the keyboard navigation shortcuts to identify the task causing the problem, and click on the task to get more information. You should also look at other processes running at the same time, looking for a thread in one process that is being blocked by another process.

Interruptions in display execution

The Systrace tool is particularly useful in analyzing application display slowness, or pauses in animations, because it shows you the execution of your application across multiple system processes. With display execution, drawing screen frames with a regular rhythm is essential for good performance. Having a regular rhythm for display ensures that animations and motion are smooth on screen. If an application drops out of this rhythm, the display can become jerky or slow from the users perspective.

If you are analyzing an application for this type of problem, examine the SurfaceFlinger process in the Systrace report where your application is also executing to look for places where it drops out of its regular rhythm.

Figure 3. Excerpt from a trace of an application showing interruptions in display processing.

The trace excerpt in figure 3 shows an section of a trace that indicates an interruption in the device display. The section of the SurfaceFlinger process in top excerpt, indicated by (1), shows that display frames are being missed. These dropped frames are potentially causing the display to stutter or halt. Zooming into this problem area in the lower trace, shows that a memory operation (image buffer dequeuing and allocation) in the surfaceflinger secondary thread is taking a long time (2). This delay causes the application to miss the display update window, indicated by the dotted line. As the developer of this application, you should investigate other threads in your application that may also be trying to allocate memory at the same time or otherwise blocking memory allocation with another request or task.

Regular, rhythmic execution of the SurfaceFlinger process is essential to smooth display of screen content, particularly for animations and motion. Interruptions in the regular execution pattern of this thread is not always an indication of a display problem with your application. Further testing is required to determine if this is actually a performance problem from a user perspective. Being able to identify display execution patterns like the example above can help you detect display problems and build a smooth-running, high-performance application.

Note: When using Systrace to analyze display problems, make sure you activate the tracing tags for Graphics and Views.

For more information on the command line options and keyboard controls for Systrace, see the Systrace help page.

Results