Chronometro

The Chronometro plugin is a benchmarking plugin for Android Studio.

It provides the information on loading times of any kind of functionality that may be found in the Android application. Benchmarking is not a trivial task on Android when taking into account the life cycle of activities and fragments. Thus, this plugin appears to be very handy when one needs to track the completion of the network calls in relation to that.

The plugin provides the annotation that is used to mark the methods that are going to be tracked. At the same time the checkpoints are provided if one would like to have a report on loading time in a current point of execution without stopping the timer.

Chronometro is based on Aspect Oriented Programming for Android and uses the AspectJ library.

Chronometro finds its inspiration in:

• Jake Wharton's plugin Hugo;
• Fernando Cejas guide on AAOP;
• Bintray and packaging by Sittiphol Phanvilai

Usage

Chronometro annotations are added to the methods in interest.

@Chronometro(state = Chronometro.START, name = "Fragment1")
@Override
public void onAttach(Activity activity) {
  super.onAttach(activity);
  // some code here
}
    
@Chronometro(state = Chronometro.END, name = "Fragment1")
@Override
public void onDataSuccess(Data data) {
  // some code here
}

Example of result logs:

Chronometro --> Fragment1 started
Chronometro --> Fragment1 created --> [2000ms]

One may define several timers y providing a different name value in the annotation.

The plugin provides also checkpoints so the developer can get the loading times for methods that run between the starting and ending point. Here are the two states that are available for getting the loading time right before the method runs (Chronometro.CHECKPOINT_START) and one right after (Chronometro.CHECKPOINT_END)

// logging the time until after the view has been created
@Chronometro(state = Chronometro.CHECKPOINT_END, name = "Fragment1")
@Override
public void onViewCreated(View view, @Nullable Bundle savedInstanceState) {
  super.onViewCreated(view, savedInstanceState);
  // some code here
}
    
// logging the time until before the fetching of data
@Chronometro(state = Chronometro.CHECKPOINT_START, name = "Fragment1")
@Override
private void fetchData() {
  // some code here
}

Example of logs at the checkpoints:

  Chronometro --> Fragment1 checkpoint after method onViewCreated --> [68ms]
  Chronometro --> Fragment1 checkpoint before method fetchData --> [108ms]

To integrate the plugin into your project, please add the following code to your Gradle file:

buildscript {
  repositories {
    jcenter()
  }

dependencies {
  classpath 'se.tv4:chronometro-plugin:0.4.0'
  }
}

apply plugin: 'com.android.application'
apply plugin: 'chronometro'

OBS! If you are using android-data-binding in your project, make sure you have at least rc3 version.

classpath 'com.android.databinding:dataBinder:1.0-rc3'

License

Copyright 2015, TV4 AB.

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.