Support tracing RAG retrieval in Spring AI 1.x plugin #808
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 | ||
| * | ||
| * http://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. | ||
| * | ||
| */ | ||
|
|
||
| package org.apache.skywalking.apm.plugin.spring.ai.v1; | ||
|
|
||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceConstructorInterceptor; | ||
| import org.springframework.ai.embedding.EmbeddingOptions; | ||
| import org.springframework.ai.embedding.EmbeddingModel; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| import java.lang.reflect.Field; | ||
| import java.lang.reflect.Method; | ||
|
|
||
| public class AbstractObservationVectorStoreConstructorInterceptor implements InstanceConstructorInterceptor { | ||
|
|
||
| @Override | ||
| public void onConstruct(EnhancedInstance objInst, Object[] allArguments) { | ||
| if (allArguments != null && allArguments.length > 0) { | ||
| String embeddingModelName = resolveModelFromArgument(allArguments[0]); | ||
| objInst.setSkyWalkingDynamicField(new VectorStoreEnhanceContext(embeddingModelName)); | ||
| } | ||
| } | ||
|
|
||
| private String resolveModelFromArgument(Object argument) { | ||
| if (argument instanceof EmbeddingModel) { | ||
| return resolveModelFromEmbeddingModel(argument); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private String resolveModelFromEmbeddingModel(Object embeddingModel) { | ||
| if (embeddingModel == null) { | ||
| return null; | ||
| } | ||
| String model = resolveModelFromOptionsMethod(embeddingModel); | ||
| if (StringUtils.hasText(model)) { | ||
| return model; | ||
| } | ||
| model = resolveModelFromOptionsField(embeddingModel, "options"); | ||
| if (StringUtils.hasText(model)) { | ||
| return model; | ||
| } | ||
| return resolveModelFromOptionsField(embeddingModel, "defaultOptions"); | ||
| } | ||
|
|
||
| private String resolveModelFromOptionsMethod(Object embeddingModel) { | ||
| try { | ||
| Method method = embeddingModel.getClass().getMethod("getOptions"); | ||
| return resolveModelFromOptions(method.invoke(embeddingModel)); | ||
| } catch (Throwable ignored) { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private String resolveModelFromOptionsField(Object embeddingModel, String fieldName) { | ||
| Class<?> type = embeddingModel.getClass(); | ||
| while (type != null) { | ||
| try { | ||
| Field field = type.getDeclaredField(fieldName); | ||
| field.setAccessible(true); | ||
| return resolveModelFromOptions(field.get(embeddingModel)); | ||
| } catch (NoSuchFieldException e) { | ||
| type = type.getSuperclass(); | ||
| } catch (Throwable ignored) { | ||
| return null; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private String resolveModelFromOptions(Object options) { | ||
| if (options instanceof EmbeddingOptions) { | ||
| return ((EmbeddingOptions) options).getModel(); | ||
| } | ||
| return null; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 | ||
| * | ||
| * http://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. | ||
| * | ||
| */ | ||
|
|
||
| package org.apache.skywalking.apm.plugin.spring.ai.v1; | ||
|
|
||
| import org.apache.skywalking.apm.agent.core.context.ContextManager; | ||
| import org.apache.skywalking.apm.agent.core.context.tag.Tags; | ||
| import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan; | ||
| import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult; | ||
| import org.apache.skywalking.apm.agent.core.util.GsonUtil; | ||
| import org.apache.skywalking.apm.network.trace.component.ComponentsDefine; | ||
| import org.apache.skywalking.apm.plugin.spring.ai.v1.contant.Constants; | ||
| import org.springframework.ai.document.Document; | ||
| import org.springframework.ai.vectorstore.SearchRequest; | ||
| import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore; | ||
| import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| import java.lang.reflect.Method; | ||
| import java.util.ArrayList; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public class AbstractObservationVectorStoreInterceptor implements InstanceMethodsAroundInterceptor { | ||
|
|
||
| @Override | ||
| public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, | ||
| MethodInterceptResult result) throws Throwable { | ||
| SearchRequest request = (SearchRequest) allArguments[0]; | ||
| VectorStoreObservationContext context = createObservationContext(objInst, request); | ||
| String dataSourceId = resolveDataSourceId(context, objInst); | ||
|
|
||
| AbstractSpan span = ContextManager.createExitSpan(Constants.RETRIEVAL + "/" + dataSourceId, dataSourceId); | ||
| SpanLayer.asGenAI(span); | ||
| span.setComponent(ComponentsDefine.SPRING_AI); | ||
| Tags.GEN_AI_OPERATION_NAME.set(span, Constants.RETRIEVAL); | ||
| Tags.GEN_AI_DATA_SOURCE_ID.set(span, dataSourceId); | ||
| String model = resolveEmbeddingModelName(objInst); | ||
| if (StringUtils.hasText(model)) { | ||
| Tags.GEN_AI_REQUEST_MODEL.set(span, model); | ||
| } | ||
|
|
||
| if (request != null) { | ||
| Tags.GEN_AI_TOP_K.set(span, String.valueOf(request.getTopK())); | ||
| if (StringUtils.hasText(request.getQuery())) { | ||
| Tags.GEN_AI_RETRIEVAL_QUERY_TEXT.set(span, request.getQuery()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, | ||
| Object ret) throws Throwable { | ||
| if (!ContextManager.isActive()) { | ||
| return ret; | ||
| } | ||
| try { | ||
| if (ret instanceof List<?>) { | ||
| Tags.GEN_AI_RETRIEVAL_DOCUMENTS.set(ContextManager.activeSpan(), toDocumentsJson((List<?>) ret)); | ||
|
Member
There was a problem hiding this comment.
Lower risk than the query text since only |
||
| } | ||
| } finally { | ||
| ContextManager.stopSpan(); | ||
| } | ||
| return ret; | ||
| } | ||
|
|
||
| @Override | ||
| public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments, | ||
| Class<?>[] argumentsTypes, Throwable t) { | ||
| if (ContextManager.isActive()) { | ||
| ContextManager.activeSpan().log(t); | ||
|
wu-sheng marked this conversation as resolved.
Outdated
|
||
| } | ||
| } | ||
|
|
||
| private VectorStoreObservationContext createObservationContext(EnhancedInstance objInst, SearchRequest request) { | ||
| VectorStoreObservationContext.Builder builder = ((AbstractObservationVectorStore) objInst) | ||
| .createObservationContextBuilder(VectorStoreObservationContext.Operation.QUERY.value()); | ||
| if (request != null) { | ||
| builder.queryRequest(request); | ||
| } | ||
| return builder.build(); | ||
| } | ||
|
|
||
| private String resolveEmbeddingModelName(EnhancedInstance objInst) { | ||
| Object context = objInst.getSkyWalkingDynamicField(); | ||
| if (context instanceof VectorStoreEnhanceContext) { | ||
| return ((VectorStoreEnhanceContext) context).getEmbeddingModelName(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private String resolveDataSourceId(VectorStoreObservationContext context, EnhancedInstance objInst) { | ||
| StringBuilder dataSourceId = new StringBuilder(); | ||
| appendDataSourcePart(dataSourceId, context.getDatabaseSystem()); | ||
| appendDataSourcePart(dataSourceId, context.getNamespace()); | ||
| appendDataSourcePart(dataSourceId, context.getCollectionName()); | ||
| if (dataSourceId.length() > 0) { | ||
| return dataSourceId.toString(); | ||
| } | ||
| return objInst.getClass().getSimpleName(); | ||
| } | ||
|
|
||
| private void appendDataSourcePart(StringBuilder dataSourceId, String value) { | ||
| if (!StringUtils.hasText(value)) { | ||
| return; | ||
| } | ||
| if (dataSourceId.length() > 0) { | ||
| dataSourceId.append('/'); | ||
| } | ||
| dataSourceId.append(value); | ||
| } | ||
|
|
||
| private String toDocumentsJson(List<?> documents) { | ||
| List<Map<String, Object>> retrievalDocuments = new ArrayList<>(documents.size()); | ||
| for (Object item : documents) { | ||
| if (!(item instanceof Document)) { | ||
| continue; | ||
| } | ||
| Document document = (Document) item; | ||
| Map<String, Object> documentMap = new LinkedHashMap<>(); | ||
| documentMap.put("id", document.getId()); | ||
| if (document.getScore() != null) { | ||
| documentMap.put("score", document.getScore()); | ||
| } | ||
| retrievalDocuments.add(documentMap); | ||
| } | ||
| return GsonUtil.toJson(retrievalDocuments); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 | ||
| * | ||
| * http://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. | ||
| * | ||
| */ | ||
|
|
||
| package org.apache.skywalking.apm.plugin.spring.ai.v1; | ||
|
|
||
| public class VectorStoreEnhanceContext { | ||
|
|
||
| private final String embeddingModelName; | ||
|
|
||
| public VectorStoreEnhanceContext(String embeddingModelName) { | ||
| this.embeddingModelName = embeddingModelName; | ||
| } | ||
|
|
||
| public String getEmbeddingModelName() { | ||
| return embeddingModelName; | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.