IgnoredTypesConfigurer SPI does not work due to package shading

[edwardxia]

Caused by: java.lang.AbstractMethodError: Receiver class MyIgnoredTypesConfigurer does not define or inherit an implementation of the resolved method 'abstract void configure(io.opentelemetry.javaagent.shaded.instrumentation.api.config.Config, io.opentelemetry.javaagent.extension.ignore.IgnoredTypesBuilder)' of interface io.opentelemetry.javaagent.extension.ignore.IgnoredTypesConfigurer.

My class implement the SPI interface and takes io.opentelemetry.instrumentation.api.config.Config as argument, but when this is loaded from agent it is expecting the shaded class io.opentelemetry.javaagent.shaded.instrumentation.api.config.Config, causing it to break.

[edwardxia]

Adding a package relocation rule in my project fixed this. However, other things like custom exporter provider spi etc. do not need package relocation to work.

[mateuszrzeszutek]

Hey @edwardxia ,
What's your use case - are you developing a custom distro or an extension? You shouldn't need to relocate anything in the case of implementing a custom extension.

[edwardxia]

Extension loaded by -Dotel.javaagent.extensions. My understanding is that I shouldn't need to relocate, thus I think it is a bug.

[edwardxia]

import com.google.auto.service.AutoService;
import io.opentelemetry.instrumentation.api.config.Config;
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesBuilder;
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesConfigurer;

@AutoService(IgnoredTypesConfigurer.class)
public class FabanIgnoredTypesConfigurer implements IgnoredTypesConfigurer {
    @Override
    public void configure(Config config, IgnoredTypesBuilder builder) {
        builder.allowClass("com.sun.faban.");
    }

    @Override
    public int order() {
        return 1;
    }
}

[trask]

oh no! the runtime shading for the extensions

opentelemetry-java-instrumentation/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/RemappingUrlConnection.java

Lines 32 to 34 in 1a994b9

	rule(
	"#io.opentelemetry.instrumentation",
	"#io.opentelemetry.javaagent.shaded.io.opentelemetry.instrumentation"),

doesn't quite match the compile-time shading:

opentelemetry-java-instrumentation/buildSrc/src/main/kotlin/io.opentelemetry.instrumentation.javaagent-shadowing.gradle.kts

Line 19 in 1a994b9

relocate("io.opentelemetry.instrumentation", "io.opentelemetry.javaagent.shaded.instrumentation")

I will send a PR to fix.