Skip to content

Miscellaneous "glue" build improvements #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcculls merged 6 commits into from
Oct 2, 2026
Merged

Miscellaneous "glue" build improvements #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
48baa11
Remove unused dependency
mcculls Sep 20, 2026
86353ed
Mark generated glue as synthetic
mcculls Sep 20, 2026
e29affc
Support remapping types/packages when generating glue
mcculls Sep 20, 2026
9388fa8
Exclude generated synthetic classes from javadoc/sources/spotbugs
mcculls Sep 20, 2026
031caf6
Register all of generatedGlueResources and generatedGlueJava as poten…
mcculls Oct 1, 2026
6bfb662
Update buildSrc/src/main/kotlin/instrument-glue.gradle.kts
mcculls Oct 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,10 @@ fun allSources(): List<SourceDirectorySet> {
tasks.javadoc {
dependsOn(embed)
setSource(allSources())
exclude("datadog/instrument/glue", "datadog/instrument/utils/JVM.java")
exclude(
"datadog/instrument/glue",
"datadog/instrument/utils/JVM.java",
"**/*.class")
val javadocOptions = (options as StandardJavadocDocletOptions)
if (JavaVersion.current().isJava9Compatible) {
javadocOptions.addBooleanOption("html5", true)
Expand All @@ -76,6 +79,7 @@ tasks.javadoc {
tasks.named<Jar>("sourcesJar") {
dependsOn(embed)
from(allSources())
exclude("**/*.class")
}

publishing {
Expand Down
11 changes: 10 additions & 1 deletion buildSrc/src/main/kotlin/instrument-glue.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ sourceSets {
val glueImplementation = configurations.getByName("glueImplementation")
dependencies {
glueImplementation(libs.asm)
glueImplementation(libs.asm.commons)
glueImplementation(libs.spotbugs.annotations)
glueImplementation(project(":utils"))
}
Expand All @@ -36,9 +37,17 @@ val generateGlue = tasks.register<JavaExec>("generateGlue") {
mainClass = "datadog.instrument.glue.GlueGenerator"
classpath = sourceSets["glue"].runtimeClasspath
args = listOf(resourcePath.toString(), javaPath.toString()) + glue
outputs.dirs(resourcePath, javaPath)
outputs.dirs(generatedGlueResources, generatedGlueJava)
}

tasks.processResources { dependsOn(generateGlue) }
tasks.compileJava { dependsOn(generateGlue) }
tasks.named("sourcesJar") { dependsOn(generateGlue) }

// exclude generated synthetic class resources from spotbugs
sourceSets.configureEach {
val compiledClasses = output.classesDirs
tasks.named<com.github.spotbugs.snom.SpotBugsTask>(getTaskName("spotbugs", null)) {
classDirs.setFrom(compiledClasses)
}
}
2 changes: 1 addition & 1 deletion class-inject/src/glue/java/datadog/instrument/glue/DefineClassGlueGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ static byte[] generateBytecode(String unsafeNamespace) {

cw.visit(
V1_8,
ACC_PUBLIC | ACC_FINAL,
ACC_PUBLIC | ACC_FINAL | ACC_SYNTHETIC,
DEFINECLASSGLUE_CLASS,
null,
OBJECT_CLASS,
Expand Down
1 change: 0 additions & 1 deletion utils/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ plugins {
}

dependencies {
sampleBytecode("org.springframework:spring-web:7.0.9")
jmh(project(":testing"))
}

Expand Down
7 changes: 5 additions & 2 deletions utils/src/main/java/datadog/instrument/glue/GlueGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package datadog.instrument.glue;

import java.lang.reflect.Method;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;
Expand All @@ -20,14 +21,16 @@ private GlueGenerator() {}
* Entry-point for generating instrumentation glue into resource files or Java source code.
*
* @param args the command-line arguments
* @throws ReflectiveOperationException if the glue cannot be generated
* @throws Exception if the glue cannot be generated
*/
public static void main(String[] args) throws ReflectiveOperationException {
public static void main(String[] args) throws Exception {
if (args.length < 3) {
throw new IllegalArgumentException("Expected: resource-path java-path glue-name...");
}
Path resourcePath = Paths.get(args[0]);
Path javaPath = Paths.get(args[1]);
Files.createDirectories(resourcePath);
Files.createDirectories(javaPath);
for (int i = 2; i < args.length; i++) {
Class<?> generatorClass = Class.forName("datadog.instrument.glue." + args[i] + "Generator");
Method generateGlue = generatorClass.getMethod("generateGlue", Path.class, Path.class);
Expand Down
Loading