Skip to content

Include Gradle process information in Build Scans or build output

License

Notifications You must be signed in to change notification settings

cdsap/InfoGradleProcess

Repository files navigation

Info Gradle Process Plugin

Includes information about Gradle processes in the Build Scans or in the build output. The plugin is compatible with configuration cache.

Usage

Apply the plugin in the main build.gradle(.kts) configuration file:

Kotlin

Using the plugins DSL:

plugins {
  id("io.github.cdsap.gradleprocess") version "0.1.2"
}

Using legacy plugin application:

buildscript {
  repositories {
    gradlePluginPortal()
  }
  dependencies {
    classpath("io.github.cdsap:infogradleprocess:0.1.2")
  }
}

apply(plugin = "io.github.cdsap.gradleprocess")

Groovy

Using the plugins DSL:

plugins {
  id "io.github.cdsap.gradleprocess" version "0.1.2"
}

Using legacy plugin application:

buildscript {
  repositories {
    gradlePluginPortal()
  }
  dependencies {
    classpath "io.github.cdsap:infogradleprocess:0.1.2"
  }
}

apply plugin: "io.github.cdsap.gradleprocess"

Output

Build Scans

If you are using Develocity, the information about the Gradle processes will be included as custom value in the Build Scan:

The field Usage represents the value obtained at the end of the build using jstat on the JVM process.

Note

Develocity 2024.2 provides new resource usage endpoints with detailed information about the different build and child processes during the execution: https://docs.gradle.com/develocity/api-manual/ref/2024.2.html#tag/Builds/operation/GetGradleResourceUsage

Build Output

If you are not using Gradle Enterprise, the information about the Gradle processes will be included at the end of the build:

> Task :core:ui:compileProdDebugKotlin
┌─────────────────────────────────────────────────────────────────────────────┐
│  Gradle processes                                                           │
├─────────┬──────────┬───────────┬────────────┬───────────────┬───────────────┤
│  PID    │  Max     │  Usage    │  Capacity  │  GC Time      │  Uptime       │
├─────────┼──────────┼───────────┼────────────┼───────────────┼───────────────┤
│  10865  │  1.0 Gb  │  0.66 Gb  │  1.0 Gb    │  0.0 minutes  │  0.0 minutes  │
├─────────┼──────────┼───────────┼────────────┼───────────────┼───────────────┤
│  9011   │  0.5 Gb  │  0.2 Gb   │  0.5 Gb    │  0.0 minutes  │  0.0 minutes  │
└─────────┴──────────┴───────────┴────────────┴───────────────┴───────────────┘
BUILD SUCCESSFUL in 35s

Requirements

  • Gradle 7.5+

Libraries

  • com.gradle:develocity-gradle-plugin
  • com.gradle.enterprise:com.gradle.enterprise.gradle.plugin
  • com.jakewharton.picnic:picnic

About

Include Gradle process information in Build Scans or build output

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages