diff --git a/examples/openai/.gitignore b/examples/openai/.gitignore new file mode 100644 index 00000000..eb14d9d6 --- /dev/null +++ b/examples/openai/.gitignore @@ -0,0 +1,4 @@ +# Ignore elastic-otel-javaagent JAR files +elastic-otel-javaagent*.jar +shdotenv +.env diff --git a/examples/openai/README.md b/examples/openai/README.md new file mode 100644 index 00000000..84207fa6 --- /dev/null +++ b/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/ diff --git a/examples/openai/build.gradle.kts b/examples/openai/build.gradle.kts new file mode 100644 index 00000000..7082300d --- /dev/null +++ b/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") + } +} diff --git a/examples/openai/env.example b/examples/openai/env.example new file mode 100644 index 00000000..77351aa0 --- /dev/null +++ b/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 diff --git a/examples/openai/gradle/wrapper/gradle-wrapper.jar b/examples/openai/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..e6441136 Binary files /dev/null and b/examples/openai/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/openai/gradle/wrapper/gradle-wrapper.properties b/examples/openai/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..a4413138 --- /dev/null +++ b/examples/openai/gradle/wrapper/gradle-wrapper.properties @@ -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 diff --git a/examples/openai/gradlew b/examples/openai/gradlew new file mode 100755 index 00000000..b740cf13 --- /dev/null +++ b/examples/openai/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/openai/gradlew.bat b/examples/openai/gradlew.bat new file mode 100644 index 00000000..7101f8e4 --- /dev/null +++ b/examples/openai/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/openai/settings.gradle.kts b/examples/openai/settings.gradle.kts new file mode 100644 index 00000000..610eabc7 --- /dev/null +++ b/examples/openai/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "openai-example" + diff --git a/examples/openai/src/main/java/openai/example/Chat.java b/examples/openai/src/main/java/openai/example/Chat.java new file mode 100644 index 00000000..95cbe093 --- /dev/null +++ b/examples/openai/src/main/java/openai/example/Chat.java @@ -0,0 +1,27 @@ +package openai.example; + +import com.openai.client.OpenAIClient; +import com.openai.client.okhttp.OpenAIOkHttpClient; +import com.openai.models.*; + + +final class Chat { + + public static void main(String[] args) { + String chatModel = System.getenv().getOrDefault("CHAT_MODEL", "gpt-4o-mini"); + + OpenAIClient client = OpenAIOkHttpClient.fromEnv(); + + String message = "Answer in up to 3 words: Which ocean contains Bouvet Island?"; + ChatCompletionCreateParams params = ChatCompletionCreateParams.builder() + .addMessage(ChatCompletionMessageParam.ofChatCompletionUserMessageParam(ChatCompletionUserMessageParam.builder() + .role(ChatCompletionUserMessageParam.Role.USER) + .content(ChatCompletionUserMessageParam.Content.ofTextContent(message)) + .build())) + .model(chatModel) + .build(); + + ChatCompletion chatCompletion = client.chat().completions().create(params); + System.out.println(chatCompletion.choices().get(0).message().content().get()); + } +} diff --git a/examples/openai/src/main/java/openai/example/Embeddings.java b/examples/openai/src/main/java/openai/example/Embeddings.java new file mode 100644 index 00000000..3afb3dfc --- /dev/null +++ b/examples/openai/src/main/java/openai/example/Embeddings.java @@ -0,0 +1,72 @@ +package openai.example; + +import java.util.List; + +import com.openai.client.OpenAIClient; +import com.openai.client.okhttp.OpenAIOkHttpClient; +import com.openai.models.*; + +final class Embeddings { + + public static void main(String[] args) { + String embeddingsModel = System.getenv().getOrDefault("EMBEDDINGS_MODEL", "text-embedding-3-small"); + + OpenAIClient client = OpenAIOkHttpClient.fromEnv(); + + var products = List.of( + "Search: Ingest your data, and explore Elastic's machine learning and retrieval augmented generation (RAG) capabilities.", + "Observability: Unify your logs, metrics, traces, and profiling at scale in a single platform.", + "Security: Protect, investigate, and respond to cyber threats with AI-driven security analytics.", + "Elasticsearch: Distributed, RESTful search and analytics.", + "Kibana: Visualize your data. Navigate the Stack.", + "Beats: Collect, parse, and ship in a lightweight fashion.", + "Connectors: Connect popular databases, file systems, collaboration tools, and more.", + "Logstash: Ingest, transform, enrich, and output." + ); + + var productEmbeddings = client.embeddings().create( + EmbeddingCreateParams.builder() + .input(EmbeddingCreateParams.Input.ofArrayOfStrings(products)) + .model(embeddingsModel) + .build()).data().stream().map(Embedding::embedding).toList(); + + var queryEmbedding = client.embeddings().create( + EmbeddingCreateParams.builder() + .input(EmbeddingCreateParams.Input.ofString("What can help me connect to a database?")) + .model(embeddingsModel) + .build()).data().get(0).embedding(); + + var queryNorm = norm(queryEmbedding); + + var similarities = productEmbeddings.stream() + .map(productEmbedding -> dot(productEmbedding, queryEmbedding) / (queryNorm * norm(productEmbedding))) + .toList(); + double maxSimilarity = Double.MIN_VALUE; + int maxIdx = -1; + for (int i = 0; i < similarities.size(); i++) { + var similarity = similarities.get(i); + if (similarity > maxSimilarity) { + maxSimilarity = similarity; + maxIdx = i; + } + } + + System.out.println(products.get(maxIdx)); + } + + private static double norm(List vector) { + var sumOfSquares = vector.stream() + .mapToDouble(Double::valueOf) + .map(x -> x * x) + .sum(); + return Math.sqrt(sumOfSquares); + } + + private static double dot(List vector1, List vector2) { + double sum = 0; + for (int i = 0; i < vector1.size(); i++) { + sum += vector1.get(i) * vector2.get(i); + } + return sum; + } +}