This sample project shows how to use the Jetpack Macrobenchmark library.

See the Macrobenchmark guide for more information on the library.

The sample project includes a variety of benchmarks to help getting started with the API.

Learn about Baseline Profile generation with classes in the baselineprofile folder.

You can also explore startup and frame timing metrics.

Further, the baseBenchmarks library offers a drop in benchmarks, which can be used in production apps to get started with macrobenchmarking. You can copy & paste the library, then adjust the package name to match the app under test and see results quickly.

Open the MacrobenchmarkSample project in Android Studio Bumblebee or later, and run benchmarks as you usually would run tests: Ctrl-Shift-F10 (Mac: Ctrl-Shift-R)

Alternatively, run the benchmarks from terminal with:

./gradlew macrobenchmark:cC

You can report an Issue with the sample using this repository. If you find an issue with the Macrobenchmark library, report it using the Issue Tracker.

Copyright 2022 The Android Open Source Project, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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.