combination build error

[hongshuai1994]

According to the steps in the document, I tried to build the opentelemetry-java project together with the opentelemetry-java-instrumentation. The build was successful, but the built javaagent reported an error when starting. The specific steps I performed are as follows:

1. clone the two projects separately to local
2. enter the bom directory and bom-alpha directory of the opentelemetry-java project and execute the ./gradlew generateBuildSubstitutions command to obtain two substitutions.gradle.kts files, the contents of the two files obtained are as follows：

// bom/substitutions.gradle.kts
dependencySubstitution {
  substitute(module("io.opentelemetry:opentelemetry-context")).using(project(":context"))
  substitute(module("io.opentelemetry:opentelemetry-opentracing-shim")).using(project(":opentracing-shim"))
  substitute(module("io.opentelemetry:opentelemetry-api")).using(project(":api:all"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-common")).using(project(":exporters:common"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-logging")).using(project(":exporters:logging"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-logging-otlp")).using(project(":exporters:logging-otlp"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-zipkin")).using(project(":exporters:zipkin"))
  substitute(module("io.opentelemetry:opentelemetry-extension-kotlin")).using(project(":extensions:kotlin"))
  substitute(module("io.opentelemetry:opentelemetry-extension-trace-propagators")).using(project(":extensions:trace-propagators"))
  substitute(module("io.opentelemetry:opentelemetry-sdk")).using(project(":sdk:all"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-common")).using(project(":sdk:common"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-logs")).using(project(":sdk:logs"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-metrics")).using(project(":sdk:metrics"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-testing")).using(project(":sdk:testing"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-trace")).using(project(":sdk:trace"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")).using(project(":sdk-extensions:autoconfigure"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")).using(project(":sdk-extensions:autoconfigure-spi"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-extension-jaeger-remote-sampler")).using(project(":sdk-extensions:jaeger-remote-sampler"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-otlp")).using(project(":exporters:otlp:all"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-otlp-common")).using(project(":exporters:otlp:common"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-sender-grpc-managed-channel")).using(project(":exporters:sender:grpc-managed-channel"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-sender-jdk")).using(project(":exporters:sender:jdk"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-sender-okhttp")).using(project(":exporters:sender:okhttp"))
  substitute(module("io.opentelemetry:opentelemetry-opencensus-shim")).using(project(":opencensus-shim"))
  substitute(module("io.opentelemetry:opentelemetry-api-incubator")).using(project(":api:incubator"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-prometheus")).using(project(":exporters:prometheus"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-extension-incubator")).using(project(":sdk-extensions:incubator"))
}
// bom-alpha/substitutions.gradle.kts
dependencySubstitution {
  substitute(module("io.opentelemetry:opentelemetry-opencensus-shim")).using(project(":opencensus-shim"))
  substitute(module("io.opentelemetry:opentelemetry-api-incubator")).using(project(":api:incubator"))
  substitute(module("io.opentelemetry:opentelemetry-exporter-prometheus")).using(project(":exporters:prometheus"))
  substitute(module("io.opentelemetry:opentelemetry-sdk-extension-incubator")).using(project(":sdk-extensions:incubator"))
}

3. I copied the contents of these two files(except for these two items<substitute(module("io.opentelemetry:opentelemetry-exporter-zipkin")).using(project(":exporters:zipkin")),substitute(module("io.opentelemetry:opentelemetry-api")).using(project(":api:all"))> of BOM, because when building, these two tasks reported errors.) to settings.gradle.kts of opentelemetry-java-instrumentation, as shown in the screenshot below

4. then enter the opentelemetry-java-instrumentation directory and execute the ./gradlew assemble -x test command. After successful execution, got the javaagent
5. use this javaagent to instrument the java application, and a startup error occurs, as follows

[otel.javaagent 2024-07-04 14:23:12:916 +0800] [main] INFO io.opentelemetry.javaagent.tooling.VersionLogger - opentelemetry-javaagent - version: 2.6.0-SNAPSHOT
OpenTelemetry Javaagent failed to start
java.util.ServiceConfigurationError: io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider: Provider io.opentelemetry.instrumentation.resources.ManifestResourceProvider could not be instantiated
	at java.util.ServiceLoader.fail(ServiceLoader.java:232)
	at java.util.ServiceLoader.access$100(ServiceLoader.java:185)
	at java.util.ServiceLoader$LazyIterator.nextService(ServiceLoader.java:384)
	at java.util.ServiceLoader$LazyIterator.next(ServiceLoader.java:404)
	at java.util.ServiceLoader$1.next(ServiceLoader.java:480)
	at io.opentelemetry.sdk.autoconfigure.internal.SpiHelper.load(SpiHelper.java:101)
	at io.opentelemetry.sdk.autoconfigure.internal.SpiHelper.loadOrdered(SpiHelper.java:87)
	at io.opentelemetry.sdk.autoconfigure.ResourceConfiguration.configureResource(ResourceConfiguration.java:94)
	at io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdkBuilder.build(AutoConfiguredOpenTelemetrySdkBuilder.java:439)
	at io.opentelemetry.javaagent.tooling.OpenTelemetryInstaller.installOpenTelemetrySdk(OpenTelemetryInstaller.java:29)
	at io.opentelemetry.javaagent.tooling.AgentInstaller.installBytebuddyAgent(AgentInstaller.java:122)
	at io.opentelemetry.javaagent.tooling.AgentInstaller.installBytebuddyAgent(AgentInstaller.java:102)
	at io.opentelemetry.javaagent.tooling.AgentStarterImpl.start(AgentStarterImpl.java:99)
	at io.opentelemetry.javaagent.bootstrap.AgentInitializer$1.run(AgentInitializer.java:53)
	at io.opentelemetry.javaagent.bootstrap.AgentInitializer$1.run(AgentInitializer.java:47)
	at io.opentelemetry.javaagent.bootstrap.AgentInitializer.execute(AgentInitializer.java:68)
	at io.opentelemetry.javaagent.bootstrap.AgentInitializer.initialize(AgentInitializer.java:46)
	at io.opentelemetry.javaagent.OpenTelemetryAgent.startAgent(OpenTelemetryAgent.java:57)
	at io.opentelemetry.javaagent.OpenTelemetryAgent.premain(OpenTelemetryAgent.java:45)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at sun.instrument.InstrumentationImpl.loadClassAndStartAgent(InstrumentationImpl.java:386)
	at sun.instrument.InstrumentationImpl.loadClassAndCallPremain(InstrumentationImpl.java:401)
Caused by: java.lang.LinkageError: loader constraint violation: when resolving field "SERVICE_NAME" the class loader (instance of io/opentelemetry/javaagent/bootstrap/AgentClassLoader) of the referring class, io/opentelemetry/javaagent/shaded/io/opentelemetry/semconv/ServiceAttributes, and the class loader (instance of <bootloader>) for the field's resolved type, io/opentelemetry/javaagent/shaded/io/opentelemetry/api/common/AttributeKey, have different Class objects for that type
	at io.opentelemetry.instrumentation.resources.ManifestResourceProvider$1.registerAttributes(ManifestResourceProvider.java:47)
	at io.opentelemetry.instrumentation.resources.AttributeResourceProvider.<init>(AttributeResourceProvider.java:54)
	at io.opentelemetry.instrumentation.resources.ManifestResourceProvider.<init>(ManifestResourceProvider.java:38)
	at io.opentelemetry.instrumentation.resources.ManifestResourceProvider.<init>(ManifestResourceProvider.java:33)
	at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
	at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
	at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at java.lang.reflect.Constructor.newInstance(Constructor.java:423)
	at java.lang.Class.newInstance(Class.java:442)
	at java.util.ServiceLoader$LazyIterator.nextService(ServiceLoader.java:380)
	... 22 more

6. I undo the modifications to the settings.gradle.kts file in opentelemetry-java-instrumentation and rebuild it, and the resulting javaagent can start normally

Did I do something wrong in the process of combination building or am I missing some steps?

[hongshuai1994]

I asked Gemini using the startup error message. Gemini suggested that the version might be wrong. I checked that the local opentelmetry-java was different from the opentelemetry-java declared in opentelemetry-java-instrumentation. After I changed it to the same version , the build error is reported as follows

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':javaagent:relocateBaseJavaagentLibs'.
> Cannot copy file '/Users/burning/Documents/OSS/opentelemetry-java/sdk/common/build/libs/opentelemetry-sdk-common-1.39.0.jar' to 'opentelemetry-sdk-common-1.39.0.jar' because file '/Users/burning/.gradle/caches/modules-2/files-2.1/io.opentelemetry/opentelemetry-sdk-common/1.39.0/fb8168627bf0059445f61081eaa47c4ab787fc2e/opentelemetry-sdk-common-1.39.0.jar' has already been copied there.

The error message indicates that an error occurred when copying the jar from the opentelemetry-java project to the opentelemetry-java-instrumentation. I feel that the replacement statement in settings.gradle.kts should have taken effect. The above startup error is probably caused by the version mismatch.

[hongshuai1994]

I found a very strange way to complete the combined build. According to the above error report, when building opentelemetry-java-instrumentation for the first time, gradlew will download all used dependencies to the local first. If the dependency version is not updated later, Each subsequent build will use the previously downloaded external dependencies. In other words, I can find the location of the jar in opentelemetry-java to be updated, and then replace the updated jar with it. I tried it and it worked.

[hongshuai1994]

By the way, you also need to modify the code of opentelemetry-java-instrumentation so that gradlew can recompile and build the entire project. Otherwise, it will directly return the previously built product of opentelemetry-java-instrumentation.

[jkwatson]

Could you submit a PR that updates the documentation to help future people who are trying to do this? Thanks!

[hongshuai1994]

Could you submit a PR that updates the documentation to help future people who are trying to do this? Thanks!

#6560
This is my first time to submit a PR to opentelemetry-java. The PR link is above, but some Checks have not passed yet.