Add tapir path matching within pekko instrumentation

[masonedmison]

• Ensure tilde$1 onExit is run in correct order #13360 must be merged first.

[masonedmison]

@laurit Would you be able to look at this for me 🙂?

[laurit]

@masonedmison I think with your current approach pekko-http instrumentation will fail to apply when tapir is not available during runtime. You can try this our by changing the tapir dependency to be compileOnly + testCompileOnly. This is because we have tooling that detects which classes are used by the instrumentation and when those classes are missing instrumentation is not applied. It is probably easiest to treat it as completely separate instrumentation. An alternative would be to have it in the same module as pekko but have it in a different InstrumentationModule but then to get muzzle working you may need to use excludeInstrumentationName so that you could have separate pass blocks for pekko and tapir.

[masonedmison]

@masonedmison I think with your current approach pekko-http instrumentation will fail to apply when tapir is not available during runtime. You can try this our by changing the tapir dependency to be compileOnly + testCompileOnly. This is because we have tooling that detects which classes are used by the instrumentation and when those classes are missing instrumentation is not applied. It is probably easiest to treat it as completely separate instrumentation. An alternative would be to have it in the same module as pekko but have it in a different InstrumentationModule but then to get muzzle working you may need to use excludeInstrumentationName so that you could have separate pass blocks for pekko and tapir.

@laurit Very good catch--sorry I missed this! I'm pursuing the second approach first (just pushed up a commit): I've created a separate InstrumentationModule, and I've added the excludeInstrumentationName statements to the muzzle check blocks--with these in place running the muzzle check works. However, I've noticed that when running a simple pekko HTTP simple program (without tapir on the class path) I see a slew of "Missing Class..." on the logs, e.g.,

[error] [otel.javaagent 2025-02-28 15:50:51:020 -0600] [main] WARN io.opentelemetry.javaagent.tooling.instrumentation.MuzzleMatcher - Instrumentation skipped, mismatched references were found: tapir-pekko-http [class io.opentelemetry.javaagent.instrumentation.pekkohttp.v1_0.server.route.TapirPekkoHttpServerRouteInstrumentationModule] on jdk.internal.loader.ClassLoaders$AppClassLoader@251a69d7
[error] [otel.javaagent 2025-02-28 15:50:51:021 -0600] [main] WARN io.opentelemetry.javaagent.tooling.instrumentation.MuzzleMatcher - -- io.opentelemetry.javaagent.instrumentation.pekkohttp.v1_0.server.route.RouteWrapper$Finalizer:47 Missing class sttp.tapir.EndpointInput$Query
[error] [otel.javaagent 2025-02-28 15:50:51:021 -0600] [main] WARN io.opentelemetry.javaagent.tooling.instrumentation.MuzzleMatcher - -- io.opentelemetry.javaagent.instrumentation.pekkohttp.v1_0.server.route.TapirPathInstrumentation$ApplyAdvice:42 Missing class sttp.tapir.server.ServerEndpoint
[error] [otel.javaagent 2025-02-28 15:50:51:021 -0600] [main] WARN io.opentelemetry.javaagent.tooling.instrumentation.MuzzleMatcher - -- io.opentelemetry.javaagent.instrumentation.pekkohttp.v1_0.server.route.RouteWrapper$Finalizer:44 Missing class sttp.tapir.EndpointInput$PathCapture

Looking at the doc string for MuzzleMatcher this looks to be expected, but I just want to make sure.

[masonedmison]

@laurit sorry to be a bother, but would you have a chance to look at my changes following your last comment?

[masonedmison]

@laurit Thank you very much for helping me get this together. I really appreciate it. I see that this is slated to go out in the 2.14.0 release (which is great!); do you know when this release will happen?

[laurit]

do you know when this release will happen?

second half of next week, see https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/RELEASING.md#release-cadence