diff --git a/examples/liberty-car-booking/pom.xml b/examples/liberty-car-booking/pom.xml index 6947b89..20a355f 100644 --- a/examples/liberty-car-booking/pom.xml +++ b/examples/liberty-car-booking/pom.xml @@ -17,29 +17,23 @@ - - UTF-8 - UTF-8 - 10.0.0 - 6.1 - 3.13.0 - 3.4.0 + + UTF-8 + UTF-8 + 10.0.0 + 6.1 + 3.13.0 + 3.4.0 - - ${project.build.directory}/liberty/wlp/usr/shared/resources/lib/ - + + ${project.build.directory}/liberty/wlp/usr/shared/resources/lib/ + - - jakarta.platform - jakarta.jakartaee-api - ${jakartaee-api.version} - provided - org.eclipse.microprofile @@ -48,19 +42,40 @@ pom provided - - ai.djl.huggingface - tokenizers - 0.30.0 - - - - - - org.eclipse.microprofile - microprofile - pom - + + + + io.opentelemetry + opentelemetry-api + 1.44.1 + provided + + + + io.opentelemetry.instrumentation + opentelemetry-instrumentation-annotations + 2.10.0 + provided + + + + + + + org.eclipse.microprofile + microprofile + pom + + + io.opentelemetry + opentelemetry-api + + + + + io.opentelemetry.instrumentation + opentelemetry-instrumentation-annotations + io.smallrye.llm @@ -72,6 +87,12 @@ smallrye-llm-langchain4j-portable-extension + + + io.smallrye.llm + smallrye-llm-langchain4j-telemetry + + org.projectlombok lombok diff --git a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Booking.java b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Booking.java index a8e03c1..bf1ea1e 100644 --- a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Booking.java +++ b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Booking.java @@ -1,14 +1,11 @@ package io.jefrajames.booking; import java.time.LocalDate; +import java.util.Objects; -import lombok.AllArgsConstructor; -import lombok.Data; -import lombok.NoArgsConstructor; - -@Data -@NoArgsConstructor -@AllArgsConstructor +//@Data +//@NoArgsConstructor +//@AllArgsConstructor public class Booking { private String bookingNumber; @@ -18,4 +15,155 @@ public class Booking { private boolean canceled = false; private String carModel; + /** + * + */ + public Booking() { + super(); + //TODO Auto-generated constructor stub + } + + /** + * @param bookingNumber + * @param start + * @param end + * @param customer + * @param canceled + * @param carModel + */ + public Booking(String bookingNumber, LocalDate start, LocalDate end, Customer customer, boolean canceled, + String carModel) { + super(); + this.bookingNumber = bookingNumber; + this.start = start; + this.end = end; + this.customer = customer; + this.canceled = canceled; + this.carModel = carModel; + } + + /** + * @return the bookingNumber + */ + public String getBookingNumber() { + return bookingNumber; + } + + /** + * @param bookingNumber the bookingNumber to set + */ + public void setBookingNumber(String bookingNumber) { + this.bookingNumber = bookingNumber; + } + + /** + * @return the start + */ + public LocalDate getStart() { + return start; + } + + /** + * @param start the start to set + */ + public void setStart(LocalDate start) { + this.start = start; + } + + /** + * @return the end + */ + public LocalDate getEnd() { + return end; + } + + /** + * @param end the end to set + */ + public void setEnd(LocalDate end) { + this.end = end; + } + + /** + * @return the customer + */ + public Customer getCustomer() { + return customer; + } + + /** + * @param customer the customer to set + */ + public void setCustomer(Customer customer) { + this.customer = customer; + } + + /** + * @return the canceled + */ + public boolean isCanceled() { + return canceled; + } + + /** + * @param canceled the canceled to set + */ + public void setCanceled(boolean canceled) { + this.canceled = canceled; + } + + /** + * @return the carModel + */ + public String getCarModel() { + return carModel; + } + + /** + * @param carModel the carModel to set + */ + public void setCarModel(String carModel) { + this.carModel = carModel; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + return Objects.hash(bookingNumber, canceled, carModel, customer, end, start); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + Booking other = (Booking) obj; + return Objects.equals(bookingNumber, other.bookingNumber) && canceled == other.canceled + && Objects.equals(carModel, other.carModel) && Objects.equals(customer, other.customer) + && Objects.equals(end, other.end) && Objects.equals(start, other.start); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + return "Booking [bookingNumber=" + bookingNumber + ", start=" + start + ", end=" + end + ", customer=" + + customer + ", canceled=" + canceled + ", carModel=" + carModel + "]"; + } } diff --git a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/BookingService.java b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/BookingService.java index 4ee5ff5..36fd025 100644 --- a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/BookingService.java +++ b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/BookingService.java @@ -8,13 +8,16 @@ import jakarta.enterprise.context.ApplicationScoped; +import org.jboss.logging.Logger; + import dev.langchain4j.agent.tool.Tool; -import lombok.extern.java.Log; @ApplicationScoped -@Log +//@Log public class BookingService { + private static final Logger LOGGER = Logger.getLogger(BookingService.class.getName()); + // Pseudo database private static final Map BOOKINGS = new HashMap<>(); static { @@ -44,14 +47,14 @@ private Booking checkBookingExists(String bookingNumber, String name, String sur @Tool("Get booking details given a booking number and customer name and surname") public Booking getBookingDetails(String bookingNumber, String name, String surname) { - log.info("DEMO: Calling Tool-getBookingDetails: " + bookingNumber + " and customer: " + LOGGER.info("DEMO: Calling Tool-getBookingDetails: " + bookingNumber + " and customer: " + name + " " + surname); return checkBookingExists(bookingNumber, name, surname); } @Tool("Get all booking ids for a customer given his name and surname") public List getBookingsForCustomer(String name, String surname) { - log.info("DEMO: Calling Tool-getBookingsForCustomer: " + name + " " + surname); + LOGGER.info("DEMO: Calling Tool-getBookingsForCustomer: " + name + " " + surname); Customer customer = new Customer(name, surname); return BOOKINGS.values() .stream() @@ -77,7 +80,7 @@ public void checkCancelPolicy(Booking booking) { @Tool("Cancel a booking given its booking number and customer name and surname") public Booking cancelBooking(String bookingNumber, String name, String surname) { - log.info("DEMO: Calling Tool-cancelBooking " + bookingNumber + " for customer: " + name + LOGGER.info("DEMO: Calling Tool-cancelBooking " + bookingNumber + " for customer: " + name + " " + surname); Booking booking = checkBookingExists(bookingNumber, name, surname); diff --git a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Customer.java b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Customer.java index f2488f0..34203f3 100644 --- a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Customer.java +++ b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/Customer.java @@ -1,15 +1,97 @@ package io.jefrajames.booking; -import lombok.AllArgsConstructor; -import lombok.Data; -import lombok.EqualsAndHashCode; -import lombok.NoArgsConstructor; - -@Data -@NoArgsConstructor -@AllArgsConstructor -@EqualsAndHashCode(of = { "name", "surname" }) +import java.util.Objects; + +//@Data +//@NoArgsConstructor +//@AllArgsConstructor +//@EqualsAndHashCode(of = { "name", "surname" }) public class Customer { private String name; private String surname; + + /** + * + */ + public Customer() { + super(); + //TODO Auto-generated constructor stub + } + + /** + * @param name + * @param surname + */ + public Customer(String name, String surname) { + super(); + this.name = name; + this.surname = surname; + } + + /** + * @return the name + */ + public String getName() { + return name; + } + + /** + * @param name the name to set + */ + public void setName(String name) { + this.name = name; + } + + /** + * @return the surname + */ + public String getSurname() { + return surname; + } + + /** + * @param surname the surname to set + */ + public void setSurname(String surname) { + this.surname = surname; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + return Objects.hash(name, surname); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + Customer other = (Customer) obj; + return Objects.equals(name, other.name) && Objects.equals(surname, other.surname); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + + @Override + public String toString() { + return "Customer [name=" + name + ", surname=" + surname + "]"; + } } diff --git a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DocRagIngestor.java b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DocRagIngestor.java index f50a395..70e8118 100644 --- a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DocRagIngestor.java +++ b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DocRagIngestor.java @@ -12,6 +12,7 @@ import jakarta.inject.Inject; import org.eclipse.microprofile.config.inject.ConfigProperty; +import org.jboss.logging.Logger; import dev.langchain4j.data.document.Document; import dev.langchain4j.data.document.parser.TextDocumentParser; @@ -22,12 +23,12 @@ import dev.langchain4j.store.embedding.EmbeddingStore; import dev.langchain4j.store.embedding.EmbeddingStoreIngestor; import dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore; -import lombok.extern.java.Log; -@Log @ApplicationScoped public class DocRagIngestor { + private static final Logger LOGGER = Logger.getLogger(DocRagIngestor.class.getName()); + // Used by ContentRetriever @Produces private EmbeddingModel embeddingModel = new AllMiniLmL6V2EmbeddingModel(); @@ -57,7 +58,7 @@ public void ingest(@Observes @Initialized(ApplicationScoped.class) Object pointl List docs = loadDocs(); ingestor.ingest(docs); - log.info(String.format("DEMO %d documents ingested in %d msec", docs.size(), + LOGGER.info(String.format("DEMO %d documents ingested in %d msec", docs.size(), System.currentTimeMillis() - start)); } } diff --git a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DummyLLConfig.java b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DummyLLConfig.java index e120c91..e58ac4f 100644 --- a/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DummyLLConfig.java +++ b/examples/liberty-car-booking/src/main/java/io/jefrajames/booking/DummyLLConfig.java @@ -29,6 +29,7 @@ public Set getBeanNames() { .collect(Collectors.toSet()); } + @SuppressWarnings("unchecked") @Override public T getBeanPropertyValue(String beanName, String propertyName, Class type) { String value = properties.getProperty(PREFIX + "." + beanName + "." + propertyName); diff --git a/examples/liberty-car-booking/src/main/liberty/config/server.xml b/examples/liberty-car-booking/src/main/liberty/config/server.xml index 2653bc7..a4cc2a0 100644 --- a/examples/liberty-car-booking/src/main/liberty/config/server.xml +++ b/examples/liberty-car-booking/src/main/liberty/config/server.xml @@ -3,16 +3,24 @@ microProfile-6.1 + mpTelemetry-2.0 - + + + + + + + + diff --git a/examples/liberty-car-booking/src/main/resources/META-INF/microprofile-config.properties b/examples/liberty-car-booking/src/main/resources/META-INF/microprofile-config.properties index 89d8303..7c796d0 100644 --- a/examples/liberty-car-booking/src/main/resources/META-INF/microprofile-config.properties +++ b/examples/liberty-car-booking/src/main/resources/META-INF/microprofile-config.properties @@ -11,6 +11,7 @@ smallrye.llm.plugin.chat-model.config.topP=0.1 smallrye.llm.plugin.chat-model.config.timeout=120s smallrye.llm.plugin.chat-model.config.max-retries=2 #smallrye.llm.plugin.chat-model.config.logRequestsAndResponses=true +smallrye.llm.plugin.chat-model.config.listeners=@all smallrye.llm.plugin.docRagRetriever.class=dev.langchain4j.rag.content.retriever.EmbeddingStoreContentRetriever @@ -31,3 +32,10 @@ fraud.memory.max.messages=20 # Location of documents to RAG app.docs-for-rag.dir=docs-for-rag + +# Microprofile Telemetry +otel.service.name=liberty-car-booking +otel.sdk.disabled=false +otel.logs.exporter=otlp,console +otel.metrics.exporter=otlp,console +otel.traces.exporter=otlp,console diff --git a/examples/pom.xml b/examples/pom.xml index 7aeee5b..d998447 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -41,6 +41,11 @@ smallrye-llm-langchain4j-portable-extension ${project.version} + + io.smallrye.llm + smallrye-llm-langchain4j-telemetry + ${project.version} + org.projectlombok lombok @@ -72,6 +77,11 @@ langchain4j-open-ai ${dev.langchain4j.version} + + ai.djl.huggingface + tokenizers + 0.30.0 + com.azure azure-xml diff --git a/pom.xml b/pom.xml index 7476202..b2e2c85 100644 --- a/pom.xml +++ b/pom.xml @@ -35,6 +35,7 @@ 3.1 + 2.0.1 2.9.0 9.7 2.3.1 @@ -42,8 +43,8 @@ 4.0.3.Final 5.1.4.Final 3.5.3.Final - 1.0.0-alpha1 - + 1.0.0-alpha1 + 3.8.1 17 17 ${maven.compiler.target} @@ -79,6 +80,7 @@ smallrye-llm-langchain4j-buildcompatible-extension smallrye-llm-langchain4j-core smallrye-llm-langchain4j-config-mpconfig + smallrye-llm-langchain4j-telemetry @@ -88,6 +90,12 @@ microprofile-config-api ${version.eclipse.microprofile.config} + + org.eclipse.microprofile.telemetry + microprofile-telemetry-api + ${version.eclipse.microprofile.telemetry} + pom + io.smallrye.common smallrye-common-bom @@ -136,7 +144,38 @@ dev.langchain4j langchain4j - ${dev.langchain4j.version} + ${version.dev.langchain4j} + + + io.smallrye.llm + smallrye-llm-langchain4j-buildcompatible-extension + ${project.version} + + + io.smallrye.llm + smallrye-llm-langchain4j-core + ${project.version} + + + io.smallrye.llm + smallrye-llm-langchain4j-config-mpconfig + ${project.version} + + + io.smallrye.llm + smallrye-llm-langchain4j-portable-extension + ${project.version} + + + io.smallrye.llm + smallrye-llm-langchain4j-telemetry + ${project.version} + + + io.smallrye.config + smallrye-config + ${version.io.smallrye.config} + test @@ -170,4 +209,4 @@ - \ No newline at end of file + diff --git a/smallrye-llm-langchain4j-buildcompatible-extension/pom.xml b/smallrye-llm-langchain4j-buildcompatible-extension/pom.xml index bb24078..ce671e8 100644 --- a/smallrye-llm-langchain4j-buildcompatible-extension/pom.xml +++ b/smallrye-llm-langchain4j-buildcompatible-extension/pom.xml @@ -63,20 +63,17 @@ io.smallrye.llm smallrye-llm-langchain4j-core - ${project.version} io.smallrye.llm smallrye-llm-langchain4j-config-mpconfig - ${project.version} test io.smallrye.config smallrye-config - 3.8.1 test diff --git a/smallrye-llm-langchain4j-config-mpconfig/pom.xml b/smallrye-llm-langchain4j-config-mpconfig/pom.xml index d80a581..7c70fbd 100644 --- a/smallrye-llm-langchain4j-config-mpconfig/pom.xml +++ b/smallrye-llm-langchain4j-config-mpconfig/pom.xml @@ -14,7 +14,6 @@ io.smallrye.config smallrye-config - 3.8.1 test @@ -25,8 +24,6 @@ io.smallrye.llm smallrye-llm-langchain4j-core - ${project.version} - diff --git a/smallrye-llm-langchain4j-core/src/main/java/io/smallrye/llm/plugin/CommonLLMPluginCreator.java b/smallrye-llm-langchain4j-core/src/main/java/io/smallrye/llm/plugin/CommonLLMPluginCreator.java index be71076..a4cc670 100644 --- a/smallrye-llm-langchain4j-core/src/main/java/io/smallrye/llm/plugin/CommonLLMPluginCreator.java +++ b/smallrye-llm-langchain4j-core/src/main/java/io/smallrye/llm/plugin/CommonLLMPluginCreator.java @@ -5,7 +5,9 @@ import java.lang.annotation.Annotation; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; +import java.util.ArrayList; import java.util.Arrays; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -22,6 +24,8 @@ import org.jboss.logging.Logger; import dev.langchain4j.data.segment.TextSegment; +import dev.langchain4j.model.chat.ChatLanguageModel; +import dev.langchain4j.model.chat.listener.ChatModelListener; import dev.langchain4j.store.embedding.EmbeddingStore; import io.smallrye.llm.core.langchain4j.core.config.spi.LLMConfig; import io.smallrye.llm.core.langchain4j.core.config.spi.LLMConfigProvider; @@ -76,11 +80,13 @@ public static void createAllLLMBeans(LLMConfig llmConfig, Consumer bea } beanBuilder.accept( new BeanData(targetClass, builderCLass, scopeClass, beanName, - (Instance creationalContext) -> CommonLLMPluginCreator.create( - creationalContext, - beanName, - targetClass, - builderCLass))); + (Instance creationalContext) -> { + return CommonLLMPluginCreator.create( + creationalContext, + beanName, + targetClass, + builderCLass); + })); } } } @@ -123,6 +129,7 @@ public Function, Object> getCallback() { } } + @SuppressWarnings("unchecked") public static Object create(Instance lookup, String beanName, Class targetClass, Class builderClass) { LLMConfig llmConfig = LLMConfigProvider.getLlmConfig(); LOGGER.info( @@ -144,7 +151,33 @@ public static Object create(Instance lookup, String beanName, Class t } else { for (Method methodToCall : methodsToCall) { Class parameterType = methodToCall.getParameterTypes()[0]; - if (stringValue.startsWith("lookup:")) { + if ("listeners".equals(property)) { + Class typeParameterClass = ChatLanguageModel.class.isAssignableFrom(targetClass) + ? ChatModelListener.class + : parameterType.getTypeParameters()[0].getGenericDeclaration(); + List listeners = (List) Collections.checkedList(new ArrayList<>(), + typeParameterClass); + if ("@all".equals(stringValue.trim())) { + Instance inst = (Instance) getInstance(lookup, typeParameterClass); + if (inst != null) { + inst.forEach(listeners::add); + } + } else { + try { + for (String className : stringValue.split(",")) { + Instance inst = getInstance(lookup, loadClass(className.trim())); + listeners.add(inst.get()); + } + } catch (ClassNotFoundException e) { + throw new RuntimeException(e); + } + } + + if (listeners != null && !listeners.isEmpty()) { + listeners.stream().forEach(l -> LOGGER.info("Adding listener: " + l.getClass().getName())); + methodToCall.invoke(builder, listeners); + } + } else if (stringValue.startsWith("lookup:")) { String lookupableBean = stringValue.substring("lookup:".length()); LOGGER.info("Lookup " + lookupableBean + " " + parameterType); Instance inst; @@ -173,8 +206,8 @@ public static Object create(Instance lookup, String beanName, Class t } } - private static Class loadClass(String scopeClassName) throws ClassNotFoundException { - return Thread.currentThread().getContextClassLoader().loadClass(scopeClassName); + private static Class loadClass(String className) throws ClassNotFoundException { + return Thread.currentThread().getContextClassLoader().loadClass(className); } @SuppressWarnings("unchecked") @@ -189,4 +222,5 @@ private static Instance getInstance(Instance lookup, Class cla return getInstance(lookup, clazz); return lookup.select(clazz, NamedLiteral.of(lookupName)); } + } diff --git a/smallrye-llm-langchain4j-portable-extension/pom.xml b/smallrye-llm-langchain4j-portable-extension/pom.xml index 64e5bdf..896bb55 100644 --- a/smallrye-llm-langchain4j-portable-extension/pom.xml +++ b/smallrye-llm-langchain4j-portable-extension/pom.xml @@ -14,7 +14,6 @@ io.smallrye.llm smallrye-llm-langchain4j-core - ${project.version} dev.langchain4j @@ -41,7 +40,6 @@ io.smallrye.llm smallrye-llm-langchain4j-config-mpconfig - ${project.version} test diff --git a/smallrye-llm-langchain4j-telemetry/pom.xml b/smallrye-llm-langchain4j-telemetry/pom.xml new file mode 100644 index 0000000..2296b95 --- /dev/null +++ b/smallrye-llm-langchain4j-telemetry/pom.xml @@ -0,0 +1,30 @@ + + 4.0.0 + + io.smallrye.llm + smallrye-llm-parent + 1.0.0-SNAPSHOT + + smallrye-llm-langchain4j-telemetry + SmallRye LLM: LangChain4j MP OpenTelemetry + + + + jakarta.enterprise + jakarta.enterprise.cdi-api + provided + + + org.eclipse.microprofile.telemetry + microprofile-telemetry-api + pom + provided + + + io.smallrye.llm + smallrye-llm-langchain4j-core + + + \ No newline at end of file diff --git a/smallrye-llm-langchain4j-telemetry/src/main/java/io/smallrye/llm/langchain4j/telemetry/MetricsChatModelListener.java b/smallrye-llm-langchain4j-telemetry/src/main/java/io/smallrye/llm/langchain4j/telemetry/MetricsChatModelListener.java new file mode 100644 index 0000000..d031d8d --- /dev/null +++ b/smallrye-llm-langchain4j-telemetry/src/main/java/io/smallrye/llm/langchain4j/telemetry/MetricsChatModelListener.java @@ -0,0 +1,129 @@ +package io.smallrye.llm.langchain4j.telemetry; + +import java.util.List; +import java.util.concurrent.TimeUnit; + +import jakarta.annotation.PostConstruct; +import jakarta.enterprise.context.Dependent; +import jakarta.inject.Inject; + +import dev.langchain4j.data.message.AiMessage; +import dev.langchain4j.model.chat.listener.ChatModelErrorContext; +import dev.langchain4j.model.chat.listener.ChatModelListener; +import dev.langchain4j.model.chat.listener.ChatModelRequest; +import dev.langchain4j.model.chat.listener.ChatModelRequestContext; +import dev.langchain4j.model.chat.listener.ChatModelResponse; +import dev.langchain4j.model.chat.listener.ChatModelResponseContext; +import io.opentelemetry.api.common.AttributeKey; +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.api.metrics.DoubleHistogram; +import io.opentelemetry.api.metrics.LongHistogram; +import io.opentelemetry.api.metrics.Meter; + +/** + * Creates metrics that follow the + * Semantic Conventions + * for GenAI Metrics. + * + * @author Buhake Sindi + * @since 25 November 2024 + */ +@Dependent +public class MetricsChatModelListener implements ChatModelListener { + + private static final String MP_AI_METRIC_START_TIME_NAME = "MP_AI_METRIC_START_TIME"; + + private static final String METRIC_CLIENT_TOKEN_USAGE_NAME = "gen_ai.client.token.usage"; + private static final String METRIC_CLIENT_OPERATION_DURATION_NAME = "gen_ai.client.operation.duration"; + + private LongHistogram clientTokenUsage; + private DoubleHistogram clientOperationDuration; + + @Inject + private Meter meter; + + @PostConstruct + private void init() { + clientTokenUsage = meter.histogramBuilder(METRIC_CLIENT_TOKEN_USAGE_NAME) + .ofLongs() + .setDescription("Measures number of input and output tokens used") + .setExplicitBucketBoundariesAdvice(List.of(1L, 4L, 16L, 64L, 256L, 1024L, 4096L, 16384L, 65536L, 262144L, + 1048576L, 4194304L, 16777216L, 67108864L)) + .build(); + + clientOperationDuration = meter.histogramBuilder(METRIC_CLIENT_OPERATION_DURATION_NAME) + .setDescription("GenAI operation duration") + .setExplicitBucketBoundariesAdvice( + List.of(0.01, 0.02, 0.04, 0.08, 0.16, 0.32, 0.64, 1.28, 2.56, 5.12, 10.24, 20.48, 40.96, 81.92)) + .setUnit("s") + .build(); + } + + @Override + public void onRequest(ChatModelRequestContext requestContext) { + requestContext.attributes().put(MP_AI_METRIC_START_TIME_NAME, System.nanoTime()); + } + + @Override + public void onResponse(ChatModelResponseContext responseContext) { + final long endTime = System.nanoTime(); + final long startTime = (Long) responseContext.attributes().get(MP_AI_METRIC_START_TIME_NAME); + + final ChatModelRequest request = responseContext.request(); + final ChatModelResponse response = responseContext.response(); + + Attributes inputTokenCountAttributes = Attributes.of(AttributeKey.stringKey("gen_ai.operation.name"), "chat", + AttributeKey.stringKey("gen_ai.request.model"), request.model(), + AttributeKey.stringKey("gen_ai.response.model"), response.model(), + AttributeKey.stringKey("gen_ai.token.type"), "input"); + //Record + clientTokenUsage.record(response.tokenUsage().inputTokenCount(), inputTokenCountAttributes); + + Attributes outputTokenCountAttributes = Attributes.of(AttributeKey.stringKey("gen_ai.operation.name"), "chat", + AttributeKey.stringKey("gen_ai.request.model"), request.model(), + AttributeKey.stringKey("gen_ai.response.model"), response.model(), + AttributeKey.stringKey("gen_ai.token.type"), "output"); + + //Record + clientTokenUsage.record(response.tokenUsage().outputTokenCount(), outputTokenCountAttributes); + + //Record duration + Attributes durationAttributes = Attributes.of(AttributeKey.stringKey("gen_ai.operation.name"), "chat", + AttributeKey.stringKey("gen_ai.request.model"), request.model(), + AttributeKey.stringKey("gen_ai.response.model"), response.model()); + recordClientOperationDuration(startTime, endTime, durationAttributes); + } + + /* + * (non-Javadoc) + * + * @see + * dev.langchain4j.model.chat.listener.ChatModelListener#onError(dev.langchain4j.model.chat.listener.ChatModelErrorContext) + */ + @Override + public void onError(ChatModelErrorContext errorContext) { + final long endTime = System.nanoTime(); + final long startTime = (Long) errorContext.attributes().get(MP_AI_METRIC_START_TIME_NAME); + final ChatModelRequest request = errorContext.request(); + final ChatModelResponse response = errorContext.partialResponse(); + + StringBuilder sb = new StringBuilder() + .append(errorContext.error().getClass().getName()); + + AiMessage aiMessage = errorContext.partialResponse().aiMessage(); + if (aiMessage != null) { + sb.append(";").append(aiMessage.text()); + } + + //Record duration + Attributes durationAttributes = Attributes.of(AttributeKey.stringKey("gen_ai.operation.name"), "chat", + AttributeKey.stringKey("gen_ai.request.model"), request.model(), + AttributeKey.stringKey("gen_ai.response.model"), response.model(), + AttributeKey.stringKey("error.type"), sb.toString()); + recordClientOperationDuration(startTime, endTime, durationAttributes); + } + + private void recordClientOperationDuration(final long startTime, long endTime, final Attributes attributes) { + clientOperationDuration.record(TimeUnit.SECONDS.convert(endTime - startTime, TimeUnit.NANOSECONDS), attributes); + } +} diff --git a/smallrye-llm-langchain4j-telemetry/src/main/java/io/smallrye/llm/langchain4j/telemetry/SpanChatModelListener.java b/smallrye-llm-langchain4j-telemetry/src/main/java/io/smallrye/llm/langchain4j/telemetry/SpanChatModelListener.java new file mode 100644 index 0000000..c3a1350 --- /dev/null +++ b/smallrye-llm-langchain4j-telemetry/src/main/java/io/smallrye/llm/langchain4j/telemetry/SpanChatModelListener.java @@ -0,0 +1,113 @@ +package io.smallrye.llm.langchain4j.telemetry; + +import jakarta.enterprise.context.Dependent; +import jakarta.inject.Inject; + +import dev.langchain4j.model.chat.listener.ChatModelErrorContext; +import dev.langchain4j.model.chat.listener.ChatModelListener; +import dev.langchain4j.model.chat.listener.ChatModelRequest; +import dev.langchain4j.model.chat.listener.ChatModelRequestContext; +import dev.langchain4j.model.chat.listener.ChatModelResponse; +import dev.langchain4j.model.chat.listener.ChatModelResponseContext; +import dev.langchain4j.model.output.TokenUsage; +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanBuilder; +import io.opentelemetry.api.trace.Tracer; +import io.opentelemetry.context.Scope; + +/** + * Creates metrics that follow the + * Semantic Conventions + * for GenAI spans. + * + * @author Buhake Sindi + * @since 25 November 2024 + */ +@Dependent +public class SpanChatModelListener implements ChatModelListener { + + private static final String OTEL_SCOPE_KEY_NAME = "OTelScope"; + private static final String OTEL_SPAN_KEY_NAME = "OTelSpan"; + + @Inject + private Tracer tracer; + + /* + * (non-Javadoc) + * + * @see dev.langchain4j.model.chat.listener.ChatModelListener#onRequest(dev.langchain4j.model.chat.listener. + * ChatModelRequestContext) + */ + @Override + public void onRequest(ChatModelRequestContext requestContext) { + // TODO Auto-generated method stub + final ChatModelRequest request = requestContext.request(); + SpanBuilder spanBuilder = tracer.spanBuilder("chat " + request.model()) + .setAttribute("gen_ai.operation.name", "chat"); + if (request.maxTokens() != null) + spanBuilder.setAttribute("gen_ai.request.max_tokens", request.maxTokens()); + + if (request.temperature() != null) + spanBuilder.setAttribute("gen_ai.request.temperature", request.temperature()); + + if (request.topP() != null) + spanBuilder.setAttribute("gen_ai.request.top_p", request.topP()); + + Span span = spanBuilder.startSpan(); + Scope scope = span.makeCurrent(); + + requestContext.attributes().put(OTEL_SCOPE_KEY_NAME, scope); + requestContext.attributes().put(OTEL_SPAN_KEY_NAME, span); + } + + /* + * (non-Javadoc) + * + * @see dev.langchain4j.model.chat.listener.ChatModelListener#onResponse(dev.langchain4j.model.chat.listener. + * ChatModelResponseContext) + */ + @Override + public void onResponse(ChatModelResponseContext responseContext) { + // TODO Auto-generated method stub + Span span = (Span) responseContext.attributes().get(OTEL_SPAN_KEY_NAME); + if (span != null) { + ChatModelResponse response = responseContext.response(); + span.setAttribute("gen_ai.response.id", response.id()) + .setAttribute("gen_ai.response.model", response.model()); + if (response.finishReason() != null) { + span.setAttribute("gen_ai.response.finish_reasons", response.finishReason().toString()); + } + TokenUsage tokenUsage = response.tokenUsage(); + if (tokenUsage != null) { + span.setAttribute("gen_ai.usage.output_tokens", tokenUsage.outputTokenCount()) + .setAttribute("gen_ai.usage.input_tokens", tokenUsage.inputTokenCount()); + } + span.end(); + } + + closeScope((Scope) responseContext.attributes().get(OTEL_SCOPE_KEY_NAME)); + } + + /* + * (non-Javadoc) + * + * @see + * dev.langchain4j.model.chat.listener.ChatModelListener#onError(dev.langchain4j.model.chat.listener.ChatModelErrorContext) + */ + @Override + public void onError(ChatModelErrorContext errorContext) { + // TODO Auto-generated method stub + Span span = (Span) errorContext.attributes().get(OTEL_SPAN_KEY_NAME); + if (span != null) { + span.recordException(errorContext.error()); + } + + closeScope((Scope) errorContext.attributes().get(OTEL_SCOPE_KEY_NAME)); + } + + private void closeScope(Scope scope) { + if (scope != null) { + scope.close(); + } + } +}