Skip to content
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

Allow method instrumentation trace methods in boot loader #12454

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Allow method instrumentation trace methods in boot loader #12454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion instrumentation/methods/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ dependencies {

tasks.withType<Test>().configureEach {
jvmArgs(
"-Dotel.instrumentation.methods.include=io.opentelemetry.javaagent.instrumentation.methods.MethodTest\$ConfigTracedCallable[call];io.opentelemetry.javaagent.instrumentation.methods.MethodTest\$ConfigTracedCompletableFuture[getResult]"
"-Dotel.instrumentation.methods.include=io.opentelemetry.javaagent.instrumentation.methods.MethodTest\$ConfigTracedCallable[call];io.opentelemetry.javaagent.instrumentation.methods.MethodTest\$ConfigTracedCompletableFuture[getResult];javax.naming.directory.InitialDirContext[search]"
)
}
11 changes: 10 additions & 1 deletion ...c/main/java/io/opentelemetry/javaagent/instrumentation/methods/MethodInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasSuperType;
import static io.opentelemetry.javaagent.instrumentation.methods.MethodSingletons.getBootstrapLoader;
import static io.opentelemetry.javaagent.instrumentation.methods.MethodSingletons.instrumenter;
import static net.bytebuddy.matcher.ElementMatchers.named;
import static net.bytebuddy.matcher.ElementMatchers.namedOneOf;
Expand Down Expand Up @@ -36,7 +37,15 @@ public MethodInstrumentation(String className, Set<String> methodNames) {

@Override
public ElementMatcher<ClassLoader> classLoaderOptimization() {
return hasClassesNamed(className);
ElementMatcher<ClassLoader> delegate = hasClassesNamed(className);
return target -> {
// hasClassesNamed does not support null class loader, so we provide a custom loader that
// can be used to look up resources in bootstrap loader
Comment on lines +42 to +43
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the comment 👍

if (target == null) {
target = getBootstrapLoader();
}
return delegate.matches(target);
};
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions .../java/io/opentelemetry/javaagent/instrumentation/methods/MethodInstrumentationModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
package io.opentelemetry.javaagent.instrumentation.methods;

import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;

import com.google.auto.service.AutoService;
import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.tooling.config.MethodsConfigurationParser;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
Expand Down Expand Up @@ -45,7 +45,9 @@ public MethodInstrumentationModule() {
public List<String> getAdditionalHelperClassNames() {
return typeInstrumentations.isEmpty()
? emptyList()
: singletonList("io.opentelemetry.javaagent.instrumentation.methods.MethodSingletons");
: Arrays.asList(
"io.opentelemetry.javaagent.instrumentation.methods.MethodSingletons",
"io.opentelemetry.javaagent.instrumentation.methods.MethodSingletons$BootstrapLoader");
}

@Override
Expand Down
15 changes: 15 additions & 0 deletions ...nt/src/main/java/io/opentelemetry/javaagent/instrumentation/methods/MethodSingletons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ public final class MethodSingletons {
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.methods";

private static final Instrumenter<ClassAndMethod, Void> INSTRUMENTER;
private static final ClassLoader bootstrapLoader = new BootstrapLoader();

static {
CodeAttributesGetter<ClassAndMethod> codeAttributesGetter =
Expand All @@ -35,5 +36,19 @@ public static Instrumenter<ClassAndMethod, Void> instrumenter() {
return INSTRUMENTER;
}

public static ClassLoader getBootstrapLoader() {
return bootstrapLoader;
}

private MethodSingletons() {}

private static class BootstrapLoader extends ClassLoader {
static {
ClassLoader.registerAsParallelCapable();
}

BootstrapLoader() {
super(null);
}
}
}
32 changes: 32 additions & 0 deletions ...avaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/methods/MethodTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
import static io.opentelemetry.semconv.incubating.CodeIncubatingAttributes.CODE_FUNCTION;
import static io.opentelemetry.semconv.incubating.CodeIncubatingAttributes.CODE_NAMESPACE;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanKind;
Expand All @@ -18,6 +19,10 @@
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import javax.naming.NoInitialContextException;
import javax.naming.directory.InitialDirContext;
import javax.naming.ldap.InitialLdapContext;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

Expand All @@ -40,6 +45,33 @@ void methodTraced() {
equalTo(CODE_FUNCTION, "call"))));
}

@Test
void bootLoaderMethodTraced() throws Exception {
InitialLdapContext context = new InitialLdapContext();
AtomicReference<Throwable> throwableReference = new AtomicReference<>();
assertThatThrownBy(
() -> {
try {
context.search("foo", null);
} catch (Throwable throwable) {
throwableReference.set(throwable);
throw throwable;
}
})
.isInstanceOf(NoInitialContextException.class);

testing.waitAndAssertTraces(
trace ->
trace.hasSpansSatisfyingExactly(
span ->
span.hasName("InitialDirContext.search")
.hasKind(SpanKind.INTERNAL)
.hasException(throwableReference.get())
.hasAttributesSatisfyingExactly(
equalTo(CODE_NAMESPACE, InitialDirContext.class.getName()),
equalTo(CODE_FUNCTION, "search"))));
}

static class ConfigTracedCallable implements Callable<String> {

@Override
Expand Down
Loading