android-cold-startup-instrumentation
This is an instrumentation library for Android Cold Startup which gives duration for each phase of App Startup.
Gradle Setup
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.okcredit:android-cold-startup-instrumentation:1.0-beta'
}
Usage
Add AppStartUpTracer.start() (at the start of onCreate) and AppStartUpTracer.stop() (at the end of onCreate) inside Application onCreate method.
override fun onCreate() {
AppStartUpTracer.start() //Should be before super.onCreate()
super.onCreate()
...
...
...
AppStartUpTracer.stop(this) { appStartUpMetrics->
Log.v("StartUp Logs", appStartUpMetrics.toString())
}
}
Result
On AppStartUpTracer.stop() 2nd parameter takes a lambda which returns Startup logs at the time of the first draw which has duration for each phase during App StartUp.
AppStartUpTracer.stop(this) { appStartUpMetrics->
Log.v("Total Time", appStartUpMetrics.totalTime.toString()) // Time Taken For Cold StartUp
Log.v("Process Fork To CP", appStartUpMetrics.processForkToContentProvider.toString()) // Time Taken From Process start to initialising content provider
Log.v("Content provider", appStartUpMetrics.contentProviderToAppStart.toString()) //Time Taken for initialising content providers
Log.v("Application Create", appStartUpMetrics.applicationOnCreateTime.toString()) //Time Taken for running Application onCreate
Log.v("First Draw", appStartUpMetrics.appOnCreateEndToFirstDraw.toString()) //Time Taken from end of Application onCreate to drawing first frame
}
Note: it gives result only post Lollipop devices(21+)
Phases of App Startup
-
Process Fork to Content Provider : Time Duration between App process forked from Zygote and First Initialization of content provider. Creating the app object and Launching the main thread will be happening here. developers have little influence on the improvement here.
-
Content Provider to App OnCreate() : Time Duration between First Initialization of the content provider to Start of App.OnCreate(). it includes All time taken for Content providers in the app.
-
App OnCreate() Start to App OnCreate() End : Time Duration between Start of App.OnCreate() to End of App.OnCreate(). it includes time taken for App.OnCreate()
-
App OnCreate() End to First Draw of the frame : Time Duration between End of App.OnCreate() to First Draw of the frame. it includes time taken for Initial activity initialisation, inflating the first layout, onMeasure() and onDraw() of for initial layout.
Acknowledgements
Thanks to py - Pierre Yves Ricau for this detailed article series about cold startup. it helps to get code snippet for this library.
License
Copyright 2021 OkCredit.
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.
154 Nov 18, 2022
53 Jul 13, 2022
587 Dec 29, 2022
198 Dec 17, 2022
60 Dec 27, 2022
12 Oct 3, 2022
779 Nov 24, 2022
220 Nov 25, 2022
46 Aug 24, 2022
0 Feb 4, 2022
5 Nov 28, 2022
60 Dec 29, 2022
189 Nov 26, 2022
1 Oct 28, 2021
15 Oct 29, 2022
1 Aug 14, 2022
3 Jul 7, 2022