automattic/measure-builds-gradle-plugin

Gradle Plugin for reporting build time metrics.

measure-builds Gradle Plugin

Gradle Plugin for reporting build metrics at the end of the build.

Features

• Add own, custom reporters and send metrics to any system
• Configuration Cache compatibility
• Gradle Enterprise integration - optionally attach Gradle Scan Id to the metrics

Setup

// settings.gradle
plugins {
    id "com.gradle.enterprise" version "latest_version" // optional
}

// build.gradle
import com.automattic.android.measure.reporters.MetricsReport
import com.automattic.android.measure.reporters.SlowSlowTasksMetricsReporter

plugins {
    id "com.automattic.android.measure-builds" version "latest_tag"
}

measureBuilds {
    enable = true
    attachGradleScanId = true // `false`, if no Enterprise plugin applied OR don't want to attach build scan id
    onBuildMetricsReadyListener { MetricsReport metricsReport ->
        // Use ready reporters
        SlowSlowTasksMetricsReporter.report(metricsReport)
        
        // or add your own reporters here or use 
        MyCustomReporter.report(metricsReport)
    }
}

Configuration

Property	Default	Description
enable	false	Enable plugin
onBuildMetricsReadyListener		Callback to be called when build metrics are ready to be reported. Use this to add your own reporters.
attachGradleScanId	false	Upload metrics after build scan is published, with build scan id attached. If false, metrics will be uploaded upon build finish, without build scan id attached
obfuscateUsername	false	Obfuscate system username with SHA-1

Demo

measure-builds-gradle-plugin's Issues

Introduce code coverage metrics

Integrate Codecov and use https://github.com/koral--/jacoco-gradle-testkit-plugin

Opt-in username obfuscation

Allow users of the plugin to obfuscate their usernames. See: cc2ce63

Do not collect build times if they are not meant to be sent

⚠️ Is your feature request related to a problem? Please describe

Currently, even if user opt-out from the measuring build times, plugin still measures the times - it just doesn't send it.

💡 Describe the solution you'd like

The plugin should not measure any times if user resigned from sending them - there's no need for additional build overhead (even if small).

Thank you @oguzkocer for reporting this!

Do not collect and send metrics for specific starting tasks

Idea

Allow clients to specify a list of tasks for which the plugin won't start collecting metrics. For example, it could be any linter task or some git pre-hooks.

Idea originated in: Automattic/pocket-casts-android#1603 (comment)

Windows 10 compatibility

Hello 👋, is the plugin supposed to work under windows? This line seems to break the gradle build as uname is not a Windows command.

my project build.gradle.kts

plugins {
    id("com.automattic.android.measure-builds") version "3.0.0"
}

measureBuilds {
    enable = true
}

The error I got

FAILURE: Build failed with an exception.

* What went wrong:
A problem occurred configuring root project 'XXXXX'.
> A problem occurred starting process 'command 'uname''

Thanks for the response

Measurements are not sent if project reused Gradle cache configuration when `attachGradleScanId` is `true`.

When reusing Gradle cache configuration AND attachGradleScanId is true, the plugin does not send measurements.

Get username from environmental variables

Use Gradle `logger` instead of `println`

⚠️ Is your feature request related to a problem? Please describe

Currently plugin uses println for logging events but its not in sync with other Gradle logs - e.g. ./gradlew -q will print logs from this plugin as noticed here: woocommerce/woocommerce-android#5214

💡 Describe the solution you'd like

The plugin should use in-house Gradle logger to log events.

Thank you @oguzkocer for reporting this

Set up upload Gradle Plugin Portal

In the past, this plugin was hosted on Gradle Plugin Portal. We changed it to Automattic's S3 instance though to get more features (per commit publish).

But when #38 will be merged, it'll make sense to offer the plugin on Gradle Plugin Portal as well, to make it available for a wider audience, that prefer to use a standardized repository (Gradle Plugin Portal) than custom, 3rd party one (Automattic's S3).

Add tests

Currently plugin is completely not tested. It'd be worth to add tests like:

• Unit tests for networking layer
• Tests for integrating with a project
• Periodic test about checking if events are accepted by Tracks

Report should contain data about included builds

As including builds has significant influence on build time, it'd be great if the plugin could determine list of projects added by include builds.

`enable` does nothing

Add support for Gradle Configuration Cache

Add documentation

This project could use some documentation in two forms:

• Update and add more to the project's Wiki page. Explain the overall flow of events and how to integrate the plugin
• Add Javadoc comments, especially to plugin's extension, as this is the main contact point with consumers.

Create build report file

At the end of the build, the plugin could produce a file to /build/ directory, containing gathered metrics. This would make debugging and functional tests much easier.

Check if builds runs on M1 Mac

⚠️ Is your feature request related to a problem? Please describe

I think it'll be a worth metric to check if Gradle build runs on M1-based Mac computer.

💡 Describe the solution you'd like

We could use uname -m and just pass its value to payload.

https://stackoverflow.com/questions/65259300/detect-apple-silicon-from-command-line

🤚 Do you want to develop this feature yourself?

• Yes
• No