Add support for MyBatis framework

docs/supported-libraries.md

@@ -94,6 +94,7 @@ These are the supported libraries and frameworks:
 | [Logback](http://logback.qos.ch/)                                                                                                           | 1.0+                          | [opentelemetry-logback-appender-1.0](../instrumentation/logback/logback-appender-1.0/library),<br>[opentelemetry-logback-mdc-1.0](../instrumentation/logback/logback-mdc-1.0/library)                                                                                                                                                                                                   | none                                                                                                                                    |
 | [Micrometer](https://micrometer.io/)                                                                                                        | 1.5+                          | [opentelemetry-micrometer-1.5](../instrumentation/micrometer/micrometer-1.5/library)                                                                                                                                                                                                                                                                                                    | none                                                                                                                                    |
 | [MongoDB Driver](https://mongodb.github.io/mongo-java-driver/)                                                                              | 3.1+                          | [opentelemetry-mongo-3.1](../instrumentation/mongo/mongo-3.1/library)                                                                                                                                                                                                                                                                                                                   | [Database Client Spans]                                                                                                                 |
+| [MyBatis](https://mybatis.org/mybatis-3/)                                                                                                                     | 3.2.0+                        | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                     |
 | [Netty](https://github.com/netty/netty)                                                                                                     | 3.8+                          | [opentelemetry-netty-4.1](../instrumentation/netty/netty-4.1/library)                                                                                                                                                                                                                                                                                                                   | [HTTP Client Spans], [HTTP Client Metrics], [HTTP Server Spans], [HTTP Server Metrics]                                                  |
 | [OkHttp](https://github.com/square/okhttp/)                                                                                                 | 2.2+                          | [opentelemetry-okhttp-3.0](../instrumentation/okhttp/okhttp-3.0/library)                                                                                                                                                                                                                                                                                                                | [HTTP Client Spans], [HTTP Client Metrics]                                                                                              |
 | [Oracle UCP](https://docs.oracle.com/database/121/JJUCP/)                                                                                   | 11.2+                         | [opentelemetry-oracle-ucp-11.2](../instrumentation/oracle-ucp-11.2/library)                                                                                                                                                                                                                                                                                                             | [Database Pool Metrics]                                                                                                                 |
@@ -144,6 +145,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-3.2/javaagent/build.gradle.kts

@@ -0,0 +1,29 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("org.mybatis")
+    module.set("mybatis")
+    versions.set("[3.2.0,)")
+    assertInverse.set(true)
+  }
+}
+
+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")
+}
+
+tasks.withType<Test>().configureEach {
+  // required on jdk17
+  jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
+  jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+}

instrumentation/mybatis-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/v3_2/MapperMethodRequest.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis.v3_2;
+
+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-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/v3_2/MyBatisExecuteInstrumentation.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis.v3_2;
+
+import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
+import static io.opentelemetry.javaagent.instrumentation.mybatis.v3_2.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)
+    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-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/v3_2/MyBatisInstrumentationModule.java

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

instrumentation/mybatis-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/mybatis/v3_2/MyBatisSingletons.java

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

instrumentation/mybatis-3.2/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/mybatis/v3_2/MyBatisTest.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis.v3_2;
+
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.apache.ibatis.mapping.Environment;
+import org.apache.ibatis.session.Configuration;
+import org.apache.ibatis.session.SqlSession;
+import org.apache.ibatis.session.SqlSessionFactoryBuilder;
+import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory;
+import org.h2.jdbcx.JdbcDataSource;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class MyBatisTest {
+
+  @RegisterExtension
+  protected static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  private static final String SPAN_NAME =
+      "io.opentelemetry.javaagent.instrumentation.mybatis.v3_2.RecordMapper.updateRecord";
+
+  @Test
+  void mybatis() {
+    JdbcDataSource dataSource = new JdbcDataSource();
+    dataSource.setURL("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1");
+    Configuration configuration = new Configuration();
+    configuration.setEnvironment(new Environment("test", new JdbcTransactionFactory(), dataSource));
+    configuration.addMapper(RecordMapper.class);
+    SqlSession sqlSession = new SqlSessionFactoryBuilder().build(configuration).openSession();
+    RecordMapper recordMapper = sqlSession.getMapper(RecordMapper.class);
+    recordMapper.updateRecord();
+    span(SPAN_NAME);
+  }
+
+  static void span(String spanName) {
+    testing.waitAndAssertTracesWithoutScopeVersionVerification(
+        trace -> {
+          trace
+              .hasSize(1)
+              .hasSpansSatisfyingExactly(
+                  span -> {
+                    span.hasKind(SpanKind.INTERNAL).hasName(spanName);
+                  });
+        });
+  }
+}

instrumentation/mybatis-3.2/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/mybatis/v3_2/RecordMapper.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.mybatis.v3_2;
+
+import org.apache.ibatis.annotations.Update;
+
+public interface RecordMapper {
+
+  @Update("CREATE TABLE dummy_record (id INT PRIMARY KEY, content VARCHAR(255))")
+  void updateRecord();
+}

settings.gradle.kts

@@ -384,6 +384,7 @@ include(":instrumentation:mongo:mongo-3.7:javaagent")
 include(":instrumentation:mongo:mongo-4.0:javaagent")
 include(":instrumentation:mongo:mongo-async-3.3:javaagent")
 include(":instrumentation:mongo:mongo-common:testing")
+include(":instrumentation:mybatis-3.2:javaagent")
 include(":instrumentation:netty:netty-3.8:javaagent")
 include(":instrumentation:netty:netty-4.0:javaagent")
 include(":instrumentation:netty:netty-4.1:javaagent")