Skip to content

Hibernate 6: don't record NoResultException #12879

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
merged 1 commit into from
Dec 12, 2024
Merged

Hibernate 6: don't record NoResultException #12879

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
28 changes: 28 additions & 0 deletions ...est/java/io/opentelemetry/javaagent/instrumentation/hibernate/v4_0/EntityManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,21 @@
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_STATEMENT;
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM;
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_USER;
import static java.util.Collections.emptyList;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Named.named;

import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.sdk.trace.data.StatusData;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.stream.Stream;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.LockModeType;
import javax.persistence.NoResultException;
import javax.persistence.Persistence;
import javax.persistence.Query;
import org.hibernate.Version;
Expand Down Expand Up @@ -324,6 +329,29 @@ void testAttachesStateToQuery(Function<EntityManager, Query> queryBuildMethod) {
.get(stringKey("hibernate.session_id"))))));
}

@Test
void testNoResultExceptionIgnored() {
EntityManager entityManager = entityManagerFactory.createEntityManager();
Query query = entityManager.createQuery("from Value where id = :id");
query.setParameter("id", 1000L);
assertThatThrownBy(query::getSingleResult).isInstanceOf(NoResultException.class);
entityManager.close();

testing.waitAndAssertTraces(
trace ->
trace.hasSpansSatisfyingExactly(
span ->
span.hasName("SELECT Value")
.hasKind(SpanKind.INTERNAL)
.hasNoParent()
.hasStatus(StatusData.unset())
.hasEvents(emptyList()),
span ->
span.hasName("SELECT db1.Value")
.hasKind(SpanKind.CLIENT)
.hasParent(trace.getSpan(0))));
}

private static Stream<Arguments> provideArgumentsAttachesState() {
return Stream.of(
Arguments.of(
Expand Down
3 changes: 2 additions & 1 deletion .../java/io/opentelemetry/javaagent/instrumentation/hibernate/v6_0/QueryInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,14 @@ public void transform(TypeTransformer transformer) {
transformer.applyAdviceToMethod(
isMethod()
.and(
// not instrumenting getSingleResult as it calls list that is instrumented and
// we don't want to record the NoResultException that it throws
Comment on lines +48 to +49
Copy link
Member

Choose a reason for hiding this comment

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

👍

namedOneOf(
"list",
"getResultList",
"stream",
"getResultStream",
"uniqueResult",
"getSingleResult",
"getSingleResultOrNull",
"uniqueResultOptional",
"executeUpdate",
Expand Down
2 changes: 1 addition & 1 deletion ...java/io/opentelemetry/javaagent/instrumentation/hibernate/v6_0/AbstractHibernateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ protected static void setup() {
// Pre-populate the DB, so delete/update can be tested.
Session writer = sessionFactory.openSession();
writer.beginTransaction();
prepopulated = new ArrayList<Value>();
prepopulated = new ArrayList<>();
for (int i = 0; i < 5; i++) {
prepopulated.add(new Value("Hello :) " + i));
writer.persist(prepopulated.get(i));
Expand Down
28 changes: 28 additions & 0 deletions ...est/java/io/opentelemetry/javaagent/instrumentation/hibernate/v6_0/EntityManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,28 @@
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_STATEMENT;
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM;
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_USER;
import static java.util.Collections.emptyList;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Named.named;

import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.sdk.testing.assertj.SpanDataAssert;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.data.StatusData;
import jakarta.persistence.EntityManager;
import jakarta.persistence.EntityManagerFactory;
import jakarta.persistence.EntityTransaction;
import jakarta.persistence.LockModeType;
import jakarta.persistence.NoResultException;
import jakarta.persistence.Persistence;
import jakarta.persistence.Query;
import java.util.Arrays;
import java.util.List;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.stream.Stream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
Expand Down Expand Up @@ -166,6 +171,29 @@ void testAttachesStateToQuery(Parameter parameter) {
.get(AttributeKey.stringKey("hibernate.session_id")))));
}

@Test
void testNoResultExceptionIgnored() {
EntityManager entityManager = entityManagerFactory.createEntityManager();
Query query = entityManager.createQuery("from Value where id = :id");
query.setParameter("id", 1000);
assertThatThrownBy(query::getSingleResult).isInstanceOf(NoResultException.class);
entityManager.close();

testing.waitAndAssertTraces(
trace ->
trace.hasSpansSatisfyingExactly(
span ->
span.hasName("SELECT " + Value.class.getName())
.hasKind(SpanKind.INTERNAL)
.hasNoParent()
.hasStatus(StatusData.unset())
.hasEvents(emptyList()),
span ->
span.hasName("SELECT db1.Value")
.hasKind(SpanKind.CLIENT)
.hasParent(trace.getSpan(0))));
}

private static Stream<Arguments> provideHibernateActionParameters() {
List<BiConsumer<EntityManager, Value>> sessionMethodTests =
Arrays.asList(
Expand Down
Loading