Add initial instrumentation of OpenAI client (#14221)

Co-authored-by: otelbot <[email protected]>

Author: anuraaga

.fossa.yml

@@ -721,6 +721,12 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:okhttp:okhttp-3.0:library'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:openai:openai-java-1.1:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:openai:openai-java-1.1:library'
     - type: gradle
       path: ./
       target: ':instrumentation:opensearch:opensearch-rest-1.0:javaagent'

buildscripts/checkstyle.xml

@@ -254,6 +254,7 @@
       <property name="arrayInitIndent" value="2"/>
     </module>
     -->
+    <!-- handled by error prone
     <module name="AbbreviationAsWordInName">
       <property name="ignoreFinal" value="false"/>
       <property name="allowedAbbreviationLength" value="0"/>
@@ -262,6 +263,7 @@
                     PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
                     RECORD_COMPONENT_DEF"/>
     </module>
+    -->
     <module name="OverloadMethodsDeclarationOrder"/>
     <!-- there are only a few violations of this, and they all appear to be for good reasons
     <module name="VariableDeclarationUsageDistance"/>

conventions/src/main/kotlin/otel.scala-conventions.gradle.kts

@@ -5,6 +5,7 @@ plugins {
 }
 
 dependencies {
+  compileOnly("org.scala-lang:scala-library:2.11.12")
   testCompileOnly("org.scala-lang:scala-library:2.11.12")
 }
 

instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2BedrockRuntimeTest.java

@@ -29,8 +29,8 @@
 import io.opentelemetry.api.common.Value;
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.api.trace.SpanKind;
-import io.opentelemetry.instrumentation.awssdk.v2_2.recording.RecordingExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.recording.RecordingExtension;
 import io.opentelemetry.semconv.incubating.GenAiIncubatingAttributes;
 import java.net.URI;
 import java.util.ArrayList;

instrumentation/openai/openai-java-1.1/javaagent/README.md

@@ -0,0 +1,5 @@
+# Settings for the OpenAI instrumentation
+
+| System property                                      | Type    | Default | Description                              |
+|------------------------------------------------------|---------|---------|------------------------------------------|
+| `otel.instrumentation.genai.capture-message-content` | Boolean | `false` | record content of user and LLM messages. |

instrumentation/openai/openai-java-1.1/javaagent/build.gradle.kts

@@ -0,0 +1,30 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("com.openai")
+    module.set("openai-java")
+    versions.set("[1.1.0,)")
+    // TODO: assertInverse after completing instrumentation
+  }
+}
+
+dependencies {
+  implementation(project(":instrumentation:openai:openai-java-1.1:library"))
+
+  testInstrumentation(project(":instrumentation:okhttp:okhttp-3.0:javaagent"))
+
+  library("com.openai:openai-java:1.1.0")
+
+  testImplementation(project(":instrumentation:openai:openai-java-1.1:testing"))
+}
+
+tasks {
+  withType<Test>().configureEach {
+    systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+    // TODO run tests both with and without genai message capture
+    systemProperty("otel.instrumentation.genai.capture-message-content", "true")
+  }
+}

instrumentation/openai/openai-java-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/openai/v1_1/OpenAiClientInstrumentation.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.openai.v1_1;
+
+import static io.opentelemetry.javaagent.instrumentation.openai.v1_1.OpenAiSingletons.TELEMETRY;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.returns;
+
+import com.openai.client.OpenAIClient;
+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;
+
+public class OpenAiClientInstrumentation implements TypeInstrumentation {
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("com.openai.client.okhttp.OpenAIOkHttpClient$Builder");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        named("build").and(returns(named("com.openai.client.OpenAIClient"))),
+        OpenAiClientInstrumentation.class.getName() + "$BuildAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class BuildAdvice {
+    @Advice.OnMethodExit(suppress = Throwable.class)
+    @Advice.AssignReturned.ToReturned
+    public static OpenAIClient onExit(@Advice.Return OpenAIClient client) {
+      return TELEMETRY.wrap(client);
+    }
+  }
+}

instrumentation/openai/openai-java-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/openai/v1_1/OpenAiInstrumentationModule.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.openai.v1_1;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+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;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class OpenAiInstrumentationModule extends InstrumentationModule {
+  public OpenAiInstrumentationModule() {
+    super("openai-java", "openai-java-1.1", "openai");
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    return hasClassesNamed("com.openai.client.OpenAIClient");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return singletonList(new OpenAiClientInstrumentation());
+  }
+}

instrumentation/openai/openai-java-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/openai/v1_1/OpenAiSingletons.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.openai.v1_1;
+
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.openai.v1_1.OpenAITelemetry;
+import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
+
+public final class OpenAiSingletons {
+  public static final OpenAITelemetry TELEMETRY =
+      OpenAITelemetry.builder(GlobalOpenTelemetry.get())
+          .setCaptureMessageContent(
+              AgentInstrumentationConfig.get()
+                  .getBoolean("otel.instrumentation.genai.capture-message-content", false))
+          .build();
+
+  private OpenAiSingletons() {}
+}

instrumentation/openai/openai-java-1.1/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/openai/v1_1/ChatTest.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.openai.v1_1;
+
+import com.openai.client.OpenAIClient;
+import io.opentelemetry.instrumentation.openai.v1_1.AbstractChatTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.sdk.testing.assertj.SpanDataAssert;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.Consumer;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class ChatTest extends AbstractChatTest {
+
+  @RegisterExtension
+  private static final AgentInstrumentationExtension testing =
+      AgentInstrumentationExtension.create();
+
+  @Override
+  protected InstrumentationExtension getTesting() {
+    return testing;
+  }
+
+  @Override
+  protected OpenAIClient wrap(OpenAIClient client) {
+    return client;
+  }
+
+  @Override
+  protected final List<Consumer<SpanDataAssert>> maybeWithTransportSpan(
+      Consumer<SpanDataAssert> span) {
+    List<Consumer<SpanDataAssert>> result = new ArrayList<>();
+    result.add(span);
+    // Do a very simple assertion since the telemetry is not part of this library.
+    result.add(s -> s.hasName("POST"));
+    return result;
+  }
+}