Analyze energy use in UWP apps

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

The Visual Studio Energy Consumption profiler helps you analyze the power and energy consumption of UWP apps on low-power tablet devices that run all or part of the time on their own batteries. On a battery-powered device, an app that uses too much energy can cause so much customer dissatisfaction that, eventually, customers might even uninstall it. Optimizing energy use can increase your app's adoption and use by customers.

What the Energy Consumption profiler is, how it works, and what it measures

The Energy Consumption profiler captures the activities of the display, CPU, and network connections of a device during a profiling session. It then generates estimates of the power used for those activities and the total amount of energy for the profiling session.

Note

The energy profiler estimates power and energy use by using a software model of standard reference device hardware that is representative of the low powered tablet devices your application might run on. To provide the best estimates, we recommend that you collect the profile data on a low powered tablet device.

Although the model provides good estimates for a variety of low-powered devices, the actual values of the device you profile will likely be different. Use the values to find display, CPU, and network activities that are costly relative to other resource uses and so might be good candidates for optimization.

The Energy Consumption profiler uses these definitions of power and energy:

• Power measures the rate that force is used to perform work that is done in a period of time. In electrical science, the standard unit of power is a watt, which is defined as the rate at which work is done when one ampere of current flows through an electrical potential difference of one volt. In the Power Usage graph, the units are displayed as milliwatts mW which are one thousandth of a watt.

  Note that because power is a rate, it has a direction (the work can increase or decrease in a period of time) and a speed (the amount that the work increases or decreases).

• Energy measures the total amount of power, either as a capacity or potential, as in the power capacity of a battery, or as the total amounted of power expended over a period of time. The unit of energy is a watt-hour, the amount of power of one watt constantly applied for one hour. In the Energy Summary, the units are displayed as milliwatt-hours mW-h.

For example, a fully charged battery in a tablet has a certain amount of stored energy. As the energy is used to perform tasks such as communicating over a network, calculating values, or displaying graphics, the power of the battery dissipates at different rates. For any period of time, the total of the power consumed is also measured by energy.

Identify scenarios with user marks

You can add user marks to your profiling data to help identify areas in the timeline ruler.

The mark appears as an orange triangle in the timeline at the time the method executed. The message and the time are displayed as a tooltip when you hover over the mark. If two or more user marks are close together, the marks are merged and the tooltip data is combined. You can zoom in on the timeline to separate the marks.

Add marks to C#, Visual Basic, C++ code

To add a user mark to C#, Visual Basic, C++ code, first create a Windows.Foundation.Diagnostics.LoggingChannel object. Then insert calls to LoggingChannel.LogMessage methods at the points in your code that you want to mark. Use LoggingLevel.Information in the calls.

When the method executes, a user mark is added to the profiling data along with a message.

Note

• Windows.Foundation.Diagnostics.LoggingChannel implements the Windows.Foundation.IClosable interface (projected as System.IDisposable in C# and VB). To avoid leaking operating system resources, call LoggingChannel.Close (LoggingChannel.Dispose in C# and VB) when you're finished with a logging channel.
• Each open logging channel must have a unique name. If you attempt to create a new logging channel with the same name as an undisposed channel, an exception is thrown.

For example code, see the Windows SDK Sample LoggingSession sample.

Add marks to JavaScript code

To add user marks add the following code at the points in your code that you want to mark:

if (performance && performance.mark) {
    performance.mark(markDescription);
}

markDescription is a string that contains the message to display in the user mark tooltip.

Configure your environment for profiling

To obtain the good estimates, you'll want to profile the energy use of the app on a low-powered device that is being powered by its batteries. Because Visual Studio does not run on most of these devices, you'll need to connect your Visual Studio computer to the device using the Visual Studio remote tools. To connect to a remote device, you need to configure both the Visual Studio project and the remote device. See Run UWP apps on a remote machine for more information.

Tip

• We don't recommend energy profiling on the UWP simulator or on the Visual Studio computer. Profiling on the actual device provides far more realistic data.
• Profile on the target device while it is powered by its batteries.
• Close other apps that might use the same resources (network, CPU, or display).

Collect energy profile data for your app

1. On the Debug menu, choose Start Diagnostics Without Debugging.

   

2. Choose Energy Consumption and then choose Start.

   Note

   When you start the Energy Consumption profiler, you might see a User Account Control window requesting your permission to run VsEtwCollector.exe. Choose Yes.

3. Exercise your app to collect data.

4. To stop profiling, switch back to Visual Studio (Alt + Tab) and choose Stop collection on the Diagnostic hub page.

   

   Visual Studio analyzes the collected data and displays the results.

Collect energy profile data for an installed app

The Energy Consumption tool can only be run on UWP apps that are launched from a Visual Studio solution or are installed from the Microsoft Store. When a solution is open in Visual Studio, the default target is the Startup Project. To target an installed app:

1. Choose Change Target and then choose Installed App.

2. From the Select Installed App Package list, choose the target.

3. Choose Energy Consumption on the Performance Profiler page.

4. Choose Start to begin profiling.

   To stop profiling, switch back to Visual Studio (Alt + Tab) and choose Stop collection on the Diagnostic hub page.

Analyze energy profile data

The energy profile data is displayed in Visual Studio document window:

Image	Description
	The report file is named ReportYYYYMMDD-HHMM.diagsession. You can change the name if you decide to save the report.
	The timeline shows the length of the profiling session, app lifecycle activation events, and user marks.
	You can restrict the report to a part of the timeline by dragging the blue bars to select a region of the timeline.
	The Power Usage graph is a multi-line chart that displays the change in the power output that is caused by a device resource during a profiling session. The Energy Consumption profiler tracks the power used by the CPU, network activity, and the screen display.
	The Resources (On/Off) graph provides details of network energy costs. The Network bar represents the time that the network connection was open. The Data Transfer child bar is the time that the app was receiving or sending data over the network.
	The Energy Usage Summary shows the proportional amount of the total energy that was used in the selected timeline by the CPU, network activity, and the screen display.

To analyze the energy profile data

Find an area where resource power peaked. Relate the peak area to the functionality of your app. Then use the timeline control bars on the timeline to zoom in on the area. If you are focused on network usage, expand the Network node in the Resources (On/Off) graph to compare the time that the network connection was open to the time that the app was receiving or transferring data over the connection. Reducing the time that the network is unnecessarily opened is a very effective optimization.

Optimize energy use

In addition to transmitting data, network connections incur energy costs for initializing, maintaining, and shutting down the connection. Some networks maintain the connection for a period of time after data is sent or received to allow more data over to be transmitted over a single connection. You can use the Resources (On/Off) pane to examine the way your app interacts with the connection.

If the Network and Data Transfer bars show that the connection is open for long periods to intermittently transmit a series of small data packets, you can batch the data to send it in one transmission, reduce the time that the network is open, and thus save energy costs.

You have less control over the energy costs of the display. Most screens require more energy to display light colors than darker colors, so using a dark background is one way to reduce costs.

Other resources

• The Connection state and cost management sections for C#/VB/C++ and XAML describe the Windows APIs that provide network connectivity information that your app can use to minimize the cost of network traffic.

  The Visual Studio simulator for UWP apps enables you to simulate data connection properties of the network information APIs. See Run UWP apps in the simulator

• The CPU Usage tools can help you reduce the CPU load when it is caused by inefficient functions. See Analyze CPU usage.

See also

• Profiling in Visual Studio
• First look at profiling tools