Add support for MyBatis framework

docs/supported-libraries.md

@@ -144,6 +144,7 @@ These are the supported libraries and frameworks:
 | [Vert.x Web](https://vertx.io/docs/vertx-web/java/)                                                                                         | 3.0+                          | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Provides `http.route` [2]                                                                                                               |
 | [Vibur DBCP](https://www.vibur.org/)                                                                                                        | 11.0+                         | [opentelemetry-vibur-dbcp-11.0](../instrumentation/vibur-dbcp-11.0/library)                                                                                                                                                                                                                                                                                                             | [Database Pool Metrics]                                                                                                                 |
 | [ZIO](https://zio.dev/)                                                                                                                     | 2.0+                          | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Context propagation                                                                                                                     |
+| [MyBatis](https://mybatis.org/mybatis-3/)                                                                                                                     | 3.2.0+                        | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                     |
 
 **[1]** Standalone library instrumentation refers to instrumentation that can be used without the Java agent.
 

instrumentation/mybatis/javaagent/build.gradle.kts

@@ -0,0 +1,26 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+dependencies {
+  compileOnly("com.google.auto.value:auto-value-annotations")
+  annotationProcessor("com.google.auto.value:auto-value")
+  library("org.mybatis:mybatis:3.2.0")
+  testImplementation("org.mockito:mockito-core")
+  testImplementation("org.mockito:mockito-junit-jupiter")
+  testImplementation("com.h2database:h2:1.4.191")
+}
+
+muzzle {
+  pass {
+    group.set("org.mybatis")
+    module.set("mybatis")
+    versions.set("[3.2.0,)")
+  }
+}
+
+tasks.withType<Test>().configureEach {
+  // required on jdk17
+  jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
+  jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+}

instrumentation/mybatis/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/MapperMethodRequest.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import com.google.auto.value.AutoValue;
+
+@AutoValue
+public abstract class MapperMethodRequest {
+
+  public static MapperMethodRequest create(String mapperName) {
+    return new AutoValue_MapperMethodRequest(mapperName);
+  }
+
+  public abstract String getMapperName();
+}

instrumentation/mybatis/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/MybatisAttributesExtractor.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import javax.annotation.Nullable;
+
+class MybatisAttributesExtractor implements AttributesExtractor<MapperMethodRequest, Void> {
+
+  @Override
+  public void onStart(
+      AttributesBuilder attributes,
+      Context parentContext,
+      MapperMethodRequest mapperMethodRequest) {
+    attributes.put("component.name", "mybatis");
+  }
+
+  @Override
+  public void onEnd(
+      AttributesBuilder attributes,
+      Context context,
+      MapperMethodRequest mapperMethodRequest,
+      @Nullable Void unused,
+      @Nullable Throwable error) {}
+}

instrumentation/mybatis/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/MybatisExecuteInstrumentation.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
+import static io.opentelemetry.javaagent.instrumentation.mybatis.MybatisSingletons.mapperInstrumenter;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+import org.apache.ibatis.binding.MapperMethod.SqlCommand;
+
+public class MybatisExecuteInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("org.apache.ibatis.binding.MapperMethod");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        named("execute"), MybatisExecuteInstrumentation.class.getName() + "$ExecuteAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class ExecuteAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void getMapperInfo(
+        @Advice.FieldValue("command") SqlCommand command,
+        @Advice.Local("otelRequest") MapperMethodRequest request,
+        @Advice.Local("otelContext") Context context,
+        @Advice.Local("otelScope") Scope scope) {
+      Context parentContext = currentContext();
+      if (command == null || !mapperInstrumenter().shouldStart(parentContext, request)) {
+        return;
+      }
+      request = MapperMethodRequest.create(command.getName());
+      context = mapperInstrumenter().start(parentContext, request);
+      scope = context.makeCurrent();
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class, inline = true)
+    public static void stopSpan(
+        @Advice.Thrown Throwable throwable,
+        @Advice.Local("otelRequest") MapperMethodRequest request,
+        @Advice.Local("otelContext") Context context,
+        @Advice.Local("otelScope") Scope scope) {
+      if (scope != null) {
+        scope.close();
+        mapperInstrumenter().end(context, request, null, throwable);
+      }
+    }
+  }
+}

instrumentation/mybatis/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/MybatisInstrumentationModule.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import java.util.Arrays;
+import java.util.List;
+
+@AutoService(InstrumentationModule.class)
+public class MybatisInstrumentationModule extends InstrumentationModule {
+
+  public MybatisInstrumentationModule() {
+    super("mybatis");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return Arrays.asList(new MybatisExecuteInstrumentation());
+  }
+}

instrumentation/mybatis/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/MybatisSingletons.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
+
+public final class MybatisSingletons {
+  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.mybatis";
+
+  private static final Instrumenter<MapperMethodRequest, Void> MAPPER_INSTRUMENTER;
+
+  static {
+    SpanNameExtractor<MapperMethodRequest> spanNameExtractor = new MybatisSpanNameExtractor();
+
+    MAPPER_INSTRUMENTER =
+        Instrumenter.<MapperMethodRequest, Void>builder(
+                GlobalOpenTelemetry.get(),
+                INSTRUMENTATION_NAME,
+                spanNameExtractor)
+            .addAttributesExtractor(new MybatisAttributesExtractor())
+            .buildInstrumenter(SpanKindExtractor.alwaysInternal());
+  }
+
+  public static Instrumenter<MapperMethodRequest, Void> mapperInstrumenter() {
+    return MAPPER_INSTRUMENTER;
+  }
+  private MybatisSingletons() {}
+}

instrumentation/mybatis/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/MybatisSpanNameExtractor.java

@@ -0,0 +1,16 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
+
+public class MybatisSpanNameExtractor implements SpanNameExtractor<MapperMethodRequest> {
+
+  @Override
+  public String extract(MapperMethodRequest request) {
+    return request.getMapperName();
+  }
+}

instrumentation/mybatis/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/mybatis/MybatisTest.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import static org.mockito.Mockito.when;
+
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import org.apache.ibatis.binding.MapperMethod;
+import org.apache.ibatis.mapping.MappedStatement;
+import org.apache.ibatis.mapping.SqlCommandType;
+import org.apache.ibatis.reflection.factory.DefaultObjectFactory;
+import org.apache.ibatis.session.Configuration;
+import org.apache.ibatis.session.defaults.DefaultSqlSession;
+import org.junit.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.mockito.Mockito;
+
+class MybatisTest {
+
+  @RegisterExtension
+  protected static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  private static final String SPAN_NAME =
+      "io.opentelemetry.javaagent.instrumentation.mybatis.RecordMapper.updateRecord";
+
+  @Test
+  void mybatis() throws Exception {
+    DefaultSqlSession sqlSession = Mockito.mock(DefaultSqlSession.class);
+    Configuration configuration = Mockito.mock(Configuration.class);
+    DefaultObjectFactory defaultObjectFactory = Mockito.mock(DefaultObjectFactory.class);
+    when(sqlSession.update(SPAN_NAME, null)).thenReturn(1);
+    Class<?> mappedStatementClass = Class.forName(MappedStatement.class.getName());
+    Constructor<?> constructor = mappedStatementClass.getDeclaredConstructor();
+    constructor.setAccessible(true);
+    MappedStatement mappedStatement = (MappedStatement) constructor.newInstance();
+    Field id = mappedStatementClass.getDeclaredField("id");
+    id.setAccessible(true);
+    id.set(mappedStatement, SPAN_NAME);
+    Field sqlCommandType = mappedStatementClass.getDeclaredField("sqlCommandType");
+    sqlCommandType.setAccessible(true);
+    sqlCommandType.set(mappedStatement, SqlCommandType.UPDATE);
+    when(configuration.hasStatement(SPAN_NAME)).thenReturn(true);
+    when(configuration.getMappedStatement(SPAN_NAME)).thenReturn(mappedStatement);
+    when(configuration.getObjectFactory()).thenReturn(defaultObjectFactory);
+    when(defaultObjectFactory.isCollection(Void.class)).thenReturn(false);
+    Class<?> mapper = Class.forName(RecordMapper.class.getName());
+    Method method = mapper.getMethod("updateRecord");
+    MapperMethod mapperMethod = new MapperMethod(mapper, method, configuration);
+    mapperMethod.execute(sqlSession, null);
+    span(SPAN_NAME);
+  }
+
+  private void span(String spanName) {
+    testing.waitAndAssertTracesWithoutScopeVersionVerification(
+        trace -> {
+          trace
+              .hasSize(1)
+              .hasSpansSatisfyingExactly(
+                  span -> {
+                    span.hasKind(SpanKind.INTERNAL).hasName(spanName);
+                  });
+        });
+  }
+}

instrumentation/mybatis/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/mybatis/RecordMapper.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis;
+
+import org.apache.ibatis.annotations.Update;
+
+public interface RecordMapper {
+
+  @Update("update dummy_record set content = '3131223'")
+  void updateRecord();
+}

settings.gradle.kts

@@ -567,6 +567,7 @@ include(":instrumentation:vibur-dbcp-11.0:library")
 include(":instrumentation:vibur-dbcp-11.0:testing")
 include(":instrumentation:wicket-8.0:javaagent")
 include(":instrumentation:zio:zio-2.0:javaagent")
+include(":instrumentation:mybatis:javaagent")
 
 // benchmark
 include(":benchmark-overhead-jmh")