Rewrite InstrumentPlugin to be lazy #9475

bric3 · 2025-09-05T12:50:11Z

What Does This Do

⚠️ work in progress

This work explore a rewrite of the InstrumentPlugin to avoid eager configuration.

At the same time, I'm exploring the instrument post-processing to be a compiler last action,
instead of adding its own task to run after compilation and intercepting itself.

Motivation

Good usage of Gradle API
Make it lazy

Related to

Blocked by

Remove instrumentation afterEvaluate #9752
Split jetty-server-9.0 project setup to multiple modules #9683
Play instrumentation multi-source
- Split play-2.4 module #10279
- play 2.6 2.7

Additional Notes

Contributor Checklist

Format the title according the contribution guidelines
Assign the type: and (comp: or inst:) labels in addition to any usefull labels
Don't use close, fix or any linking keywords when referencing an issue.
Use solves instead, and assign the PR milestone to the issue
Update the CODEOWNERS file on source file addition, move, or deletion
Update the public documentation in case of new configuration flag or behavior

Jira ticket: [PROJ-IDENT]

github-actions · 2025-09-05T12:50:22Z

Hi! 👋 Thanks for your pull request! 🎉

To help us review it, please make sure to:

Add at least one type, and one component or instrumentation label to the pull request

If you need help, please check our contributing guidelines.

AlexeyKuznetsov-DD

Just curious, what would be the benefit? Faster build?

buildSrc/src/main/groovy/InstrumentPlugin.groovy

AlexeyKuznetsov-DD · 2025-09-05T15:14:41Z

buildSrc/src/main/groovy/InstrumentPlugin.groovy

 */
 @SuppressWarnings('unused')
 class InstrumentPlugin implements Plugin<Project> {
+  public static final String DEFAULT_JAVA_VERSION = 'default'


Just curious, why it is default and not 8?

Good question! In the previous code javaVersion was null if not explicitly set, but declaring an additional task input via it.inputs.property("javaVersion", javaVersion) do not allow null, so I introduced a default value. The java version is maily used to affect which workQueue is chosen, so using default or 8 has no consequences in this PR.

That being said, decoupling the Java target version from the Gradle JVM will have an effect and in this case we will have to be handled, but that's a separate work.

To be fair though, I'm not sure the language matters here much because it's about post-processing classes. Which will be done by bytebuddy plugins. Let's keep it like this for now.

dd-java-agent/instrumentation/play-2.6/build.gradle

buildSrc/src/test/groovy/InstrumentPluginTest.groovy

bric3 · 2025-09-10T15:33:50Z

Status report

The new approach of the instrument post-processing works in almost all simple projects, e.g.

Important

The diff was made by this custom tool https://github.com/bric3/jardiff

:dd-java-agent:instrumentation:iast-instrumenter

$ mise exec java@corretto-24 -- jardiff /Users/brice.dutheil/go/src/github.com/DataDog/dd-trace-java{-copy-1,}/dd-java-agent/instrumentation/iast-instrumenter/build/classes/java/main                      17:01:29
Comparing:
* /Users/brice.dutheil/go/src/github.com/DataDog/dd-trace-java-copy-1/dd-java-agent/instrumentation/iast-instrumenter/build/classes/java/main
* /Users/brice.dutheil/go/src/github.com/DataDog/dd-trace-java/dd-java-agent/instrumentation/iast-instrumenter/build/classes/java/main

✔️ META-INF/services/datadog.trace.agent.tooling.InstrumenterModule
✔️ datadog/trace/instrumentation/iastinstrumenter/IastExclusionTrie.class
✔️ datadog/trace/instrumentation/iastinstrumenter/IastInstrumentation$IastMatchers.class
✔️ datadog/trace/instrumentation/iastinstrumenter/IastHardcodedSecretListener$ReportSecretConsumer.class
✔️ datadog/trace/instrumentation/iastinstrumenter/SourceMapperImpl.class
✔️ datadog/trace/instrumentation/iastinstrumenter/StratumListener.class
✔️ datadog/trace/instrumentation/iastinstrumenter/IastInstrumentation.class
✔️ datadog/trace/instrumentation/iastinstrumenter/IastInstrumentation$Muzzle.class
✔️ datadog/trace/instrumentation/iastinstrumenter/IastHardcodedSecretListener.class
✔️ datadog/trace/instrumentation/iastinstrumenter/IastInstrumentation$IastCallSiteSupplier.class
✔️ datadog/trace/instrumentation/iastinstrumenter/IastInstrumentation$IastMatchers$1.class
✔️ datadog/trace/instrumentation/iastinstrumenter/telemetry/TelemetryCallSiteSupplier$IteratorAdapter.class
✔️ datadog/trace/instrumentation/iastinstrumenter/telemetry/TelemetryCallSiteSupplier$1.class
✔️ datadog/trace/instrumentation/iastinstrumenter/telemetry/TelemetryCallSiteSupplier.class
✔️ datadog/trace/instrumentation/iastinstrumenter/service/CallSitesLoader.class

:dd-java-agent:instrumentation:mule-4

$  mise exec java@corretto-24 -- jardiff /Users/brice.dutheil/go/src/github.com/DataDog/dd-trace-java{-copy-1,}/dd-java-agent/instrumentation/mule-4/build/classes/java/main                                 17:26:08
Comparing:
* /Users/brice.dutheil/go/src/github.com/DataDog/dd-trace-java-copy-1/dd-java-agent/instrumentation/mule-4/build/classes/java/main
* /Users/brice.dutheil/go/src/github.com/DataDog/dd-trace-java/dd-java-agent/instrumentation/mule-4/build/classes/java/main

✔️ META-INF/services/datadog.trace.agent.tooling.InstrumenterModule
✔️ datadog/trace/instrumentation/mule4/EventTracerInstrumentation.class
✔️ datadog/trace/instrumentation/mule4/ComponentMessageProcessorInstrumentation$ProcessAdvice.class
✔️ datadog/trace/instrumentation/mule4/AbstractMuleInstrumentation.class
✔️ datadog/trace/instrumentation/mule4/EventTracerInstrumentation$Muzzle.class
✔️ datadog/trace/instrumentation/mule4/SpanState.class
✔️ datadog/trace/instrumentation/mule4/ComponentMessageProcessorInstrumentation$Muzzle.class
✔️ datadog/trace/instrumentation/mule4/JpmsMuleInstrumentation$Muzzle.class
✔️ datadog/trace/instrumentation/mule4/ExecutionInitialSpanInfoInstrumentation$StoreComponentAdvice.class
✔️ datadog/trace/instrumentation/mule4/EventContextInstrumentation$Muzzle.class
✔️ datadog/trace/instrumentation/mule4/ComponentMessageProcessorInstrumentation.class
✔️ datadog/trace/instrumentation/mule4/EventContextCreationAdvice.class
✔️ datadog/trace/instrumentation/mule4/NoopMuleSpan.class
✔️ datadog/trace/instrumentation/mule4/DDEventTracer.class
✔️ datadog/trace/instrumentation/mule4/ExecutionInitialSpanInfoInstrumentation.class
✔️ datadog/trace/instrumentation/mule4/MuleDecorator.class
✔️ datadog/trace/instrumentation/mule4/EventTracerInstrumentation$SwapCoreTracerAdvice.class
✔️ datadog/trace/instrumentation/mule4/JpmsMuleInstrumentation.class
✔️ datadog/trace/instrumentation/mule4/ExecutionInitialSpanInfoInstrumentation$Muzzle.class
✔️ datadog/trace/instrumentation/mule4/EventContextInstrumentation.class

:dd-java-agent:instrumentation:play.2.4

:dd-java-agent:agent-otel:otel-bootstrap

jardiff on otel-bootstrap

Etc.

However, :dd-java-agent:instrumentation:jetty-9 is oddly configured and must be

mise exec java@corretto-24 -- jardiff /Users/brice.dutheil/go/src/github.com/DataDog/dd-trace-java{-copy-1,}/dd-java-agent/instrumentation/jetty-9/build/classes/java/main

And as such not all classes are available when post processing kicks in. Possibly this project needs a heavier setup refactoring.

Few other projects with non-standard configurations to fix

:dd-java-agent:instrumentation:play.2.4
:dd-java-agent:instrumentation:play.2.6

Executing a simple ./gradlew help :

~5K less created tasks during configuration

https://scans.gradle.com/s/jqasddzbs75ve/performance/configuration#summary-tasks-created-during-configuration

Note

~40k tasks created is still way too much and impacts the build performance considerably

versus master, with ~45k task created during configuration

https://scans.gradle.com/s/vg7nn7oitpx5k/performance/configuration#summary-tasks-created-during-configuration

AlexeyKuznetsov-DD · 2025-12-17T16:22:06Z

Just a minor comment. Probably it make sense to refactor this plugin to Kotlin.
I did some naive 1-1 migration here
It is not working properly, so I will close my PR as you are working on it and have more context.

The current implementation was using bad practices in various ways, `project.afterEvaluate`, task creation, explicit `dependsOn` # Conflicts: # buildSrc/src/main/groovy/InstrumentPlugin.groovy # buildSrc/src/main/groovy/MuzzlePlugin.groovy # dd-java-agent/instrumentation/jetty-9/build.gradle # Conflicts: # buildSrc/src/main/groovy/InstrumentPlugin.groovy # buildSrc/src/test/groovy/InstrumentPluginTest.groovy # dd-java-agent/instrumentation/play/play-2.4/build.gradle # dd-java-agent/instrumentation/play/play-2.6/build.gradle

…utions to instrument plugin

…and configuration

…tJava Since instrument plugin do post-processing within compileTask, it not anymore required to depends on instrumentation tasks (as they don't exist anymore)

bric3 · 2025-12-31T09:48:52Z

Just a minor comment. Probably it make sense to refactor this plugin to Kotlin.

Yes, but I'd rather do it, in a second pass. Once this settles down.

bric3 requested review from a team as code owners September 5, 2025 12:50

bric3 requested a review from amarziali September 5, 2025 12:50

bric3 marked this pull request as draft September 5, 2025 12:50

bric3 added tag: no release notes Changes to exclude from release notes comp: tooling Build & Tooling labels Sep 5, 2025

AlexeyKuznetsov-DD reviewed Sep 5, 2025

View reviewed changes

bric3 force-pushed the bdu/lazy-instrument-plugin branch from 248b4eb to 3094d50 Compare September 5, 2025 17:02

bric3 force-pushed the bdu/lazy-instrument-plugin branch from aa6d660 to 0067ada Compare September 10, 2025 16:23

bric3 added type: enhancement Enhancements and improvements tag: needs investigation Issues needing investigations type: refactoring labels Sep 11, 2025

bric3 mentioned this pull request Oct 7, 2025

Split jetty-server-9.0 project setup to multiple modules #9683

Merged

bric3 mentioned this pull request Dec 8, 2025

Refactored InstrumentPlugin from Groovy to Kotlin. #10086

Closed

bric3 mentioned this pull request Dec 18, 2025

Remove instrumentation afterEvaluate #9752

Merged

bric3 force-pushed the bdu/lazy-instrument-plugin branch from 0067ada to 210d17c Compare December 30, 2025 16:18

bric3 had a problem deploying to ci-build December 30, 2025 16:18 — with GitHub Actions Failure

bric3 had a problem deploying to ci-build December 30, 2025 17:49 — with GitHub Actions Failure

bric3 force-pushed the bdu/lazy-instrument-plugin branch from d3a2cd2 to 899f804 Compare December 30, 2025 18:10

bric3 had a problem deploying to ci-build December 30, 2025 18:11 — with GitHub Actions Failure

bric3 added 7 commits December 31, 2025 10:06

chore(build): replace dependency on instrument task to source cet output

82ff47f

chore: Properly react on instrumentPluginClasspath configuration

d7c18db

chore: Rework additional classpath and instrumenter classpath contrib…

1b1a8f2

…utions to instrument plugin

fix: Remove eager whenObjectAdded in InstrumentPlugin

9244887

fix: Fix bad java version comparison

f6fd5c0

chore: Rework INSTRUMENT_PLUGIN_CLASSPATH_CONFIGURATION registration …

fc4a6bb

…and configuration

bric3 added 5 commits December 31, 2025 10:06

chore: Remove CallSiteInstrumentationPlugin dependencies on instrumen…

c4c02e2

…tJava Since instrument plugin do post-processing within compileTask, it not anymore required to depends on instrumentation tasks (as they don't exist anymore)

chore: Removes useless afterEvaluate for forbiddenApi tasks

6d3817a

chore: Split single plugin file to separate types

fccc1f5

chore: Now instrumentPluginClasspath configuration is already registered

71a948c

fix: Incorrect comparison

9b5556c

bric3 force-pushed the bdu/lazy-instrument-plugin branch from 899f804 to 9b5556c Compare December 31, 2025 09:06

bric3 had a problem deploying to ci-build December 31, 2025 09:07 — with GitHub Actions Failure

style: Make spotless happy

4e77995

bric3 had a problem deploying to ci-build December 31, 2025 09:53 — with GitHub Actions Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Rewrite InstrumentPlugin to be lazy #9475

Rewrite InstrumentPlugin to be lazy #9475

Uh oh!

bric3 commented Sep 5, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 5, 2025

Uh oh!

AlexeyKuznetsov-DD left a comment

Uh oh!

Uh oh!

AlexeyKuznetsov-DD Sep 5, 2025

Uh oh!

bric3 Sep 8, 2025 •

edited

Loading

Uh oh!

bric3 Dec 31, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

bric3 commented Sep 10, 2025 •

edited

Loading

Uh oh!

AlexeyKuznetsov-DD commented Dec 17, 2025 •

edited

Loading

Uh oh!

bric3 commented Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Rewrite InstrumentPlugin to be lazy #9475

Are you sure you want to change the base?

Rewrite InstrumentPlugin to be lazy #9475

Uh oh!

Conversation

bric3 commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What Does This Do

Motivation

Additional Notes

Contributor Checklist

Uh oh!

github-actions bot commented Sep 5, 2025

Uh oh!

AlexeyKuznetsov-DD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AlexeyKuznetsov-DD Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

bric3 Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bric3 Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bric3 commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlexeyKuznetsov-DD commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bric3 commented Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bric3 commented Sep 5, 2025 •

edited

Loading

bric3 Sep 8, 2025 •

edited

Loading

bric3 Dec 31, 2025 •

edited

Loading

bric3 commented Sep 10, 2025 •

edited

Loading

AlexeyKuznetsov-DD commented Dec 17, 2025 •

edited

Loading