open-telemetry
/
opentelemetry-java-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-java-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Instrument SharedSessionContract instead of Session

This commit is contained in:
Tyler Benson 2019-02-12 16:53:09 -08:00
parent 180ba619a2
commit e019fcbda5
3 changed files with 38 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
dd-java-agent/instrumentation/hibernate/src/main/java/datadog/trace/instrumentation/hibernate/SessionFactoryInstrumentation.java
View File

@ -24,7 +24,7 @@ import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.method.MethodDescription; import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.description.type.TypeDescription; import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher; import net.bytebuddy.matcher.ElementMatcher;
import org.hibernate.Session; import org.hibernate.SharedSessionContract;
@AutoService(Instrumenter.class) @AutoService(Instrumenter.class)
public class SessionFactoryInstrumentation extends Instrumenter.Default { public class SessionFactoryInstrumentation extends Instrumenter.Default {
@ -36,7 +36,7 @@ public class SessionFactoryInstrumentation extends Instrumenter.Default {
@Override @Override
public Map<String, String> contextStore() { public Map<String, String> contextStore() {
final Map<String, String> map = new HashMap<>(); final Map<String, String> map = new HashMap<>();
map.put("org.hibernate.Session", SessionState.class.getName()); map.put("org.hibernate.SharedSessionContract", SessionState.class.getName());
return Collections.unmodifiableMap(map); return Collections.unmodifiableMap(map);
} }
@ -59,9 +59,11 @@ public class SessionFactoryInstrumentation extends Instrumenter.Default {
// generated. // generated.
transformers.put( transformers.put(
isMethod() isMethod()
.and(named("openSession")) .and(named("openSession").or(named("openStatelessSession")))
.and(takesArguments(0)) .and(takesArguments(0))
.and(returns(named("org.hibernate.Session"))), .and(
returns(
named("org.hibernate.Session").or(named("org.hibernate.StatelessSession")))),
SessionFactoryAdvice.class.getName()); SessionFactoryAdvice.class.getName());
return transformers; return transformers;
@ -70,7 +72,7 @@ public class SessionFactoryInstrumentation extends Instrumenter.Default {
public static class SessionFactoryAdvice { public static class SessionFactoryAdvice {
@Advice.OnMethodExit(suppress = Throwable.class) @Advice.OnMethodExit(suppress = Throwable.class)
public static void openSession(@Advice.Return(readOnly = false) final Session session) { public static void openSession(@Advice.Return final SharedSessionContract session) {
final Span span = final Span span =
GlobalTracer.get() GlobalTracer.get()
@ -81,8 +83,8 @@ public class SessionFactoryInstrumentation extends Instrumenter.Default {
.withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_CLIENT) .withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_CLIENT)
.start(); .start();
final ContextStore<Session, SessionState> contextStore = final ContextStore<SharedSessionContract, SessionState> contextStore =
InstrumentationContext.get(Session.class, SessionState.class); InstrumentationContext.get(SharedSessionContract.class, SessionState.class);
contextStore.putIfAbsent(session, new SessionState(span)); contextStore.putIfAbsent(session, new SessionState(span));
} }
} }

58
dd-java-agent/instrumentation/hibernate/src/main/java/datadog/trace/instrumentation/hibernate/SessionInstrumentation.java
View File

@ -3,7 +3,6 @@ package datadog.trace.instrumentation.hibernate;
import static datadog.trace.agent.tooling.ByteBuddyElementMatchers.safeHasSuperType; import static datadog.trace.agent.tooling.ByteBuddyElementMatchers.safeHasSuperType;
import static datadog.trace.instrumentation.hibernate.SessionMethodUtils.entityName; import static datadog.trace.instrumentation.hibernate.SessionMethodUtils.entityName;
import static io.opentracing.log.Fields.ERROR_OBJECT; import static io.opentracing.log.Fields.ERROR_OBJECT;
import static net.bytebuddy.matcher.ElementMatchers.isDeclaredBy;
import static net.bytebuddy.matcher.ElementMatchers.isInterface; import static net.bytebuddy.matcher.ElementMatchers.isInterface;
import static net.bytebuddy.matcher.ElementMatchers.isMethod; import static net.bytebuddy.matcher.ElementMatchers.isMethod;
import static net.bytebuddy.matcher.ElementMatchers.named; import static net.bytebuddy.matcher.ElementMatchers.named;
@ -25,7 +24,6 @@ import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.method.MethodDescription; import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.description.type.TypeDescription; import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher; import net.bytebuddy.matcher.ElementMatcher;
import org.hibernate.Session;
import org.hibernate.SharedSessionContract; import org.hibernate.SharedSessionContract;
import org.hibernate.Transaction; import org.hibernate.Transaction;
import org.hibernate.query.Query; import org.hibernate.query.Query;
@ -41,7 +39,7 @@ public class SessionInstrumentation extends Instrumenter.Default {
@Override @Override
public Map<String, String> contextStore() { public Map<String, String> contextStore() {
final Map<String, String> map = new HashMap<>(); final Map<String, String> map = new HashMap<>();
map.put("org.hibernate.Session", SessionState.class.getName()); map.put("org.hibernate.SharedSessionContract", SessionState.class.getName());
map.put("org.hibernate.query.Query", SessionState.class.getName()); map.put("org.hibernate.query.Query", SessionState.class.getName());
map.put("org.hibernate.Transaction", SessionState.class.getName()); map.put("org.hibernate.Transaction", SessionState.class.getName());
return Collections.unmodifiableMap(map); return Collections.unmodifiableMap(map);
@ -57,22 +55,14 @@ public class SessionInstrumentation extends Instrumenter.Default {
@Override @Override
public ElementMatcher<TypeDescription> typeMatcher() { public ElementMatcher<TypeDescription> typeMatcher() {
return not(isInterface()) return not(isInterface()).and(safeHasSuperType(named("org.hibernate.SharedSessionContract")));
.and(
safeHasSuperType(
named("org.hibernate.Session")
.or(named("org.hibernate.internal.AbstractSharedSessionContract"))));
} }
@Override @Override
public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() { public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
final Map<ElementMatcher<? super MethodDescription>, String> transformers = new HashMap<>(); final Map<ElementMatcher<? super MethodDescription>, String> transformers = new HashMap<>();
transformers.put( transformers.put(
isMethod() isMethod().and(named("close")).and(takesArguments(0)), SessionCloseAdvice.class.getName());
.and(named("close"))
.and(isDeclaredBy(safeHasSuperType(named("org.hibernate.Session"))))
.and(takesArguments(0)),
SessionCloseAdvice.class.getName());
// Session synchronous methods we want to instrument. // Session synchronous methods we want to instrument.
transformers.put( transformers.put(
@ -86,33 +76,26 @@ public class SessionInstrumentation extends Instrumenter.Default {
.or(named("persist")) .or(named("persist"))
.or(named("lock")) .or(named("lock"))
.or(named("refresh")) .or(named("refresh"))
.or(named("delete"))) .or(named("delete"))),
.and(isDeclaredBy(safeHasSuperType(named("org.hibernate.Session")))),
SessionMethodAdvice.class.getName()); SessionMethodAdvice.class.getName());
// Handle the generic and non-generic 'get' separately. // Handle the generic and non-generic 'get' separately.
transformers.put( transformers.put(
isMethod() isMethod()
.and(named("get")) .and(named("get"))
.and(isDeclaredBy(safeHasSuperType(named("org.hibernate.Session"))))
.and(returns(named("java.lang.Object"))) .and(returns(named("java.lang.Object")))
.and(takesArgument(0, named("java.lang.String"))), .and(takesArgument(0, named("java.lang.String"))),
SessionMethodAdvice.class.getName()); SessionMethodAdvice.class.getName());
// These methods return some object that we want to instrument, and so the Advice will pin the // These methods return some object that we want to instrument, and so the Advice will pin the
// current Span to // current Span to the returned object using a ContextStore.
// the returned object using a ContextStore.
transformers.put( transformers.put(
isMethod() isMethod()
.and(named("beginTransaction").or(named("getTransaction"))) .and(named("beginTransaction").or(named("getTransaction")))
.and(isDeclaredBy(safeHasSuperType(named("org.hibernate.SharedSessionContract"))))
.and(takesArguments(0)) .and(takesArguments(0))
.and(returns(named("org.hibernate.Transaction"))), .and(returns(named("org.hibernate.Transaction"))),
GetTransactionAdvice.class.getName()); GetTransactionAdvice.class.getName());
transformers.put(
isMethod() transformers.put(isMethod().and(named("createQuery")), GetQueryAdvice.class.getName());
.and(named("createQuery"))
.and(isDeclaredBy(safeHasSuperType(named("org.hibernate.SharedSessionContract")))),
GetQueryAdvice.class.getName());
return transformers; return transformers;
} }
@ -121,10 +104,11 @@ public class SessionInstrumentation extends Instrumenter.Default {
@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void closeSession( public static void closeSession(
@Advice.This final Session session, @Advice.Thrown final Throwable throwable) { @Advice.This final SharedSessionContract session,
@Advice.Thrown final Throwable throwable) {
final ContextStore<Session, SessionState> contextStore = final ContextStore<SharedSessionContract, SessionState> contextStore =
InstrumentationContext.get(Session.class, SessionState.class); InstrumentationContext.get(SharedSessionContract.class, SessionState.class);
final SessionState state = contextStore.get(session); final SessionState state = contextStore.get(session);
if (state == null || state.getSessionSpan() == null) { if (state == null || state.getSessionSpan() == null) {
return; return;
@ -146,19 +130,19 @@ public class SessionInstrumentation extends Instrumenter.Default {
@Advice.OnMethodEnter(suppress = Throwable.class) @Advice.OnMethodEnter(suppress = Throwable.class)
public static SessionState startSave( public static SessionState startSave(
@Advice.This final Session session, @Advice.This final SharedSessionContract session,
@Advice.Origin("#m") final String name, @Advice.Origin("#m") final String name,
@Advice.Argument(0) final Object entity) { @Advice.Argument(0) final Object entity) {
final ContextStore<Session, SessionState> contextStore = final ContextStore<SharedSessionContract, SessionState> contextStore =
InstrumentationContext.get(Session.class, SessionState.class); InstrumentationContext.get(SharedSessionContract.class, SessionState.class);
return SessionMethodUtils.startScopeFrom( return SessionMethodUtils.startScopeFrom(
contextStore, session, "hibernate." + name, entityName(entity)); contextStore, session, "hibernate." + name, entityName(entity));
} }
@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void endSave( public static void endSave(
@Advice.This final Session session, @Advice.This final SharedSessionContract session,
@Advice.Enter final SessionState sessionState, @Advice.Enter final SessionState sessionState,
@Advice.Thrown final Throwable throwable) { @Advice.Thrown final Throwable throwable) {
@ -171,14 +155,14 @@ public class SessionInstrumentation extends Instrumenter.Default {
@Advice.OnMethodExit(suppress = Throwable.class) @Advice.OnMethodExit(suppress = Throwable.class)
public static void getQuery( public static void getQuery(
@Advice.This final SharedSessionContract session, @Advice.This final SharedSessionContract session,
@Advice.Return(readOnly = false) final QueryImplementor query) { @Advice.Return final QueryImplementor query) {
if (!(query instanceof Query)) { if (!(query instanceof Query)) {
return; return;
} }
final ContextStore<Session, SessionState> sessionContextStore = final ContextStore<SharedSessionContract, SessionState> sessionContextStore =
InstrumentationContext.get(Session.class, SessionState.class); InstrumentationContext.get(SharedSessionContract.class, SessionState.class);
final ContextStore<Query, SessionState> queryContextStore = final ContextStore<Query, SessionState> queryContextStore =
InstrumentationContext.get(Query.class, SessionState.class); InstrumentationContext.get(Query.class, SessionState.class);
@ -192,10 +176,10 @@ public class SessionInstrumentation extends Instrumenter.Default {
@Advice.OnMethodExit(suppress = Throwable.class) @Advice.OnMethodExit(suppress = Throwable.class)
public static void getTransaction( public static void getTransaction(
@Advice.This final SharedSessionContract session, @Advice.This final SharedSessionContract session,
@Advice.Return(readOnly = false) final Transaction transaction) { @Advice.Return final Transaction transaction) {
final ContextStore<Session, SessionState> sessionContextStore = final ContextStore<SharedSessionContract, SessionState> sessionContextStore =
InstrumentationContext.get(Session.class, SessionState.class); InstrumentationContext.get(SharedSessionContract.class, SessionState.class);
final ContextStore<Transaction, SessionState> transactionContextStore = final ContextStore<Transaction, SessionState> transactionContextStore =
InstrumentationContext.get(Transaction.class, SessionState.class); InstrumentationContext.get(Transaction.class, SessionState.class);

12
dd-java-agent/instrumentation/hibernate/src/main/java/datadog/trace/instrumentation/hibernate/SessionMethodUtils.java
View File

@ -11,7 +11,6 @@ import io.opentracing.tag.Tags;
import io.opentracing.util.GlobalTracer; import io.opentracing.util.GlobalTracer;
import java.util.Collections; import java.util.Collections;
import javax.persistence.Entity; import javax.persistence.Entity;
import org.hibernate.Session;
import org.hibernate.SharedSessionContract; import org.hibernate.SharedSessionContract;
public class SessionMethodUtils { public class SessionMethodUtils {
@ -40,6 +39,11 @@ public class SessionMethodUtils {
final SessionState sessionState = contextStore.get(spanKey); final SessionState sessionState = contextStore.get(spanKey);
if (sessionState == null) {
// No state found. Maybe the instrumentation isn't working correctly.
return null;
}
if (sessionState.getMethodScope() != null) { if (sessionState.getMethodScope() != null) {
// This method call was re-entrant. Do nothing, since it is being traced by the parent/first // This method call was re-entrant. Do nothing, since it is being traced by the parent/first
// call. // call.
@ -91,18 +95,18 @@ public class SessionMethodUtils {
// Copies a span from the given Session ContextStore into the targetContextStore. Used to // Copies a span from the given Session ContextStore into the targetContextStore. Used to
// propagate a Span from a Session to transient Session objects such as Transaction and Query. // propagate a Span from a Session to transient Session objects such as Transaction and Query.
public static <T> void attachSpanFromSession( public static <T> void attachSpanFromSession(
final ContextStore<Session, SessionState> sessionContextStore, final ContextStore<SharedSessionContract, SessionState> sessionContextStore,
final SharedSessionContract session, final SharedSessionContract session,
final ContextStore<T, SessionState> targetContextStore, final ContextStore<T, SessionState> targetContextStore,
final T target) { final T target) {
if (!(session instanceof Session) if (!(session instanceof SharedSessionContract)
|| sessionContextStore == null || sessionContextStore == null
|| targetContextStore == null) { || targetContextStore == null) {
return; return;
} }
final SessionState state = sessionContextStore.get((Session) session); final SessionState state = sessionContextStore.get((SharedSessionContract) session);
if (state == null) { if (state == null) {
return; return;
} }