Info Kotlin Process Plugin

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

Usage

Apply the plugin in settings.gradle(.kts) so it observes the whole build, including all projects:

Kotlin (settings.gradle.kts)

Using the plugins DSL:

plugins {
  id("io.github.cdsap.kotlinprocess") version "0.3.1"
}

Groovy (settings.gradle)

Using the plugins DSL:

plugins {
  id "io.github.cdsap.kotlinprocess" version "0.3.1"
}

The legacy project-plugin application in build.gradle(.kts) remains supported for published consumers, but settings-plugin application is preferred for multi-project builds.

Legacy project application (build.gradle.kts)

plugins {
  id("io.github.cdsap.kotlinprocess") version "0.3.1"
}

Using legacy plugin application:

buildscript {
  repositories {
    gradlePluginPortal()
  }
  dependencies {
    classpath("io.github.cdsap:infokotlinprocess:0.3.1")
  }
}

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

Legacy project application (build.gradle)

plugins {
  id "io.github.cdsap.kotlinprocess" version "0.3.1"
}

Using legacy plugin application:

buildscript {
  repositories {
    gradlePluginPortal()
  }
  dependencies {
    classpath "io.github.cdsap:infokotlinprocess:0.3.1"
  }
}

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

Output

Build Scans

If you are using Develocity, the information about the Kotlin 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.

GBOS observations

GBOS file sinks and the GBOS Develocity projection are controlled by one opt-in: infoKotlinProcess.gbos.enabled:

infoKotlinProcess.gbos.enabled=true

or configure it in the settings script:

infoKotlinProcess {
    gbos {
        enabled.set(true)
    }
}

The Develocity projection is controlled by the same opt-in:

infoKotlinProcess.gbos.enabled=true

Develocity is detected automatically. Without the opt-in, legacy Kotlin-Process-* custom values remain unchanged. With it, the legacy values are replaced by the gbos.* projection, and the local GBOS files are written:

Develocity	GBOS opt-in	Result
absent	off/on	no custom values; files follow the GBOS opt-in
present	off	legacy Kotlin-Process-* values
present	on	only gbos.* values plus GBOS files

Each Kotlin daemon is reported as a jvm.process entity observation.

The JSON and NDJSON files are written atomically to ${rootDir}/build/info-kotlin-process/gbos.json and ${rootDir}/build/info-kotlin-process/gbos.ndjson. Each build replaces both files with the observations generated by that build.

Build Output

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

> Task :core:ui:compileProdDebugKotlin
┌─────────────────────────────────────────────────────────────────────────────┐
│  Kotlin 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.jakewharton.picnic:picnic