Adds OpenAI example similar to Python and Node.js

Signed-off-by: Adrian Cole <[email protected]>
Co-authored-by: Jonas Kunz <[email protected]>

Author: codefromthecrypt

examples/openai/.gitignore

@@ -0,0 +1,4 @@
+# Ignore elastic-otel-javaagent JAR files
+elastic-otel-javaagent*.jar
+shdotenv
+.env

examples/openai/README.md

@@ -0,0 +1,77 @@
+# OpenAI Zero-Code Instrumentation Examples
+
+This is an example of how to instrument OpenAI calls with zero code changes,
+using `instrumentation-openai-java` included in the Elastic Distribution of
+OpenTelemetry Java ([EDOT Java][edot-java]).
+
+When OpenAI examples run, they export traces, metrics and logs to an OTLP
+compatible endpoint. Traces and metrics include details such as the model used
+and the duration of the LLM request. In the case of chat, Logs capture the
+request and the generated response. The combination of these provide a
+comprehensive view of the performance and behavior of your OpenAI usage.
+
+## Install
+
+Download the EDOT javaagent binary.
+
+```bash
+curl -o elastic-otel-javaagent.jar -L 'https://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=co.elastic.otel&a=elastic-otel-javaagent&v=LATEST'
+```
+
+Build the example application.
+
+```bash
+./gradlew clean assemble
+```
+
+Download shdotenv to load `.env` file when running.
+
+```bash
+curl -O -L https://github.com/ko1nksm/shdotenv/releases/download/v0.14.0/shdotenv
+chmod +x ./shdotenv
+```
+
+## Configure
+
+Copy [env.example](env.example) to `.env` and update its `OPENAI_API_KEY`.
+
+An OTLP compatible endpoint should be listening for traces, metrics and logs on
+`http://localhost:4317`. If not, update `OTEL_EXPORTER_OTLP_ENDPOINT` as well.
+
+For example, if Elastic APM server is running locally, edit `.env` like this:
+```
+OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:8200
+```
+
+## Run
+
+There are two examples, and they run the same way:
+
+### Chat
+
+[Chat](src/main/java/openai/example/Chat.java) asks the LLM a geography question and prints the response.
+
+Run it like this:
+```bash
+./shdotenv java -javaagent:elastic-otel-javaagent.jar -jar build/libs/openai-example-all.jar
+```
+
+You should see something like "Atlantic Ocean" unless your LLM hallucinates!
+
+### Embeddings
+
+
+[Embeddings](src/main/java/openai/example/Embeddings.java) creates in-memory VectorDB embeddings about
+Elastic products. Then, it searches for one similar to a question.
+
+Run it like this:
+```bash
+./shdotenv java -classpath build/libs/openai-example-all.jar -javaagent:elastic-otel-javaagent.jar openai.example.Embeddings
+```
+
+You should see something like "Connectors can help you connect to a database",
+unless your LLM hallucinates!
+
+---
+
+[edot-java]: https://github.com/elastic/elastic-otel-java/

examples/openai/build.gradle.kts

@@ -0,0 +1,37 @@
+plugins {
+    application
+    java
+
+    id("com.gradleup.shadow") version "8.3.5"
+}
+
+group = "openai.example"
+version = "1.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(platform("org.slf4j:slf4j-bom:2.0.16"))
+    implementation("com.openai:openai-java:0.11.8")
+    implementation("org.slf4j:slf4j-simple")
+}
+
+application {
+    mainClass = "openai.example.Chat"
+}
+
+tasks {
+    compileJava {
+        options.release.set(21)
+    }
+
+    shadowJar {
+        archiveFileName.set("openai-example-all.jar")
+    }
+
+    assemble {
+        dependsOn("shadowJar")
+    }
+}

examples/openai/env.example

@@ -0,0 +1,14 @@
+# Update this with your real OpenAI API key
+OPENAI_API_KEY=sk-YOUR_API_KEY
+
+# OTEL_EXPORTER_* variables are not required. If you would like to change your
+# OTLP endpoint to Elastic APM server using HTTP, uncomment the following:
+# OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:8200
+# OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
+
+OTEL_SERVICE_NAME=openai-example
+
+# Change to 'false' to hide prompt and completion content
+OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+# Change to 'false' to not export prompt and completion content events
+ELASTIC_OTEL_JAVA_INSTRUMENTATION_GENAI_EMIT_EVENTS=true

examples/openai/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists