Skip to content

Commit 12cb26e

Browse files
jonatan-ivanovjonatan-ivanov
committed
Rename TracingHelper to ObservabilityHelper
1 parent 6c5d01c commit 12cb26e

File tree

7 files changed

+20
-20
lines changed

7 files changed

+20
-20
lines changed

‎spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/observation/ChatClientInputContentObservationFilter.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import org.springframework.ai.chat.messages.Message;
2525
import org.springframework.ai.chat.messages.SystemMessage;
2626
import org.springframework.ai.chat.messages.UserMessage;
27-
import org.springframework.ai.observation.tracing.TracingHelper;
27+
import org.springframework.ai.observation.tracing.ObservabilityHelper;
2828
import org.springframework.util.CollectionUtils;
2929

3030
import java.util.List;
@@ -83,7 +83,7 @@ protected void chatClientSystemParams(ChatClientObservationContext context) {
8383

8484
context.addHighCardinalityKeyValue(
8585
KeyValue.of(ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_SYSTEM_PARAM,
86-
TracingHelper.concatenateMaps((Map<String, Object>) systemParams)));
86+
ObservabilityHelper.concatenateMaps((Map<String, Object>) systemParams)));
8787
}
8888

8989
protected void chatClientUserText(ChatClientObservationContext context) {
@@ -112,7 +112,7 @@ protected void chatClientUserParams(ChatClientObservationContext context) {
112112
}
113113
context.addHighCardinalityKeyValue(
114114
KeyValue.of(ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_USER_PARAMS,
115-
TracingHelper.concatenateMaps((Map<String, Object>) userParams)));
115+
ObservabilityHelper.concatenateMaps((Map<String, Object>) userParams)));
116116
}
117117

118118
}

‎spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/observation/ChatClientPromptContentObservationFilter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import io.micrometer.observation.Observation;
2020
import io.micrometer.observation.ObservationFilter;
2121
import org.springframework.ai.chat.observation.ChatModelObservationDocumentation;
22-
import org.springframework.ai.observation.tracing.TracingHelper;
22+
import org.springframework.ai.observation.tracing.ObservabilityHelper;
2323
import org.springframework.util.CollectionUtils;
2424

2525
import java.util.HashMap;
@@ -44,7 +44,7 @@ public Observation.Context map(Observation.Context context) {
4444

4545
chatClientObservationContext
4646
.addHighCardinalityKeyValue(ChatModelObservationDocumentation.HighCardinalityKeyNames.PROMPT
47-
.withValue(TracingHelper.concatenateMaps(prompts)));
47+
.withValue(ObservabilityHelper.concatenateMaps(prompts)));
4848

4949
return chatClientObservationContext;
5050
}

‎spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/observation/DefaultChatClientObservationConvention.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import org.springframework.ai.chat.observation.ChatModelObservationDocumentation;
3131
import org.springframework.ai.model.tool.ToolCallingChatOptions;
3232
import org.springframework.ai.observation.conventions.SpringAiKind;
33-
import org.springframework.ai.observation.tracing.TracingHelper;
33+
import org.springframework.ai.observation.tracing.ObservabilityHelper;
3434
import org.springframework.lang.Nullable;
3535
import org.springframework.util.CollectionUtils;
3636
import org.springframework.util.StringUtils;
@@ -112,7 +112,7 @@ protected KeyValues advisors(KeyValues keyValues, ChatClientObservationContext c
112112
}
113113
var advisorNames = context.getAdvisors().stream().map(Advisor::getName).toList();
114114
return keyValues.and(ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_ADVISORS.asString(),
115-
TracingHelper.concatenateStrings(advisorNames));
115+
ObservabilityHelper.concatenateStrings(advisorNames));
116116
}
117117

118118
protected KeyValues conversationId(KeyValues keyValues, ChatClientObservationContext context) {
@@ -151,7 +151,7 @@ protected KeyValues tools(KeyValues keyValues, ChatClientObservationContext cont
151151

152152
return keyValues.and(
153153
ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_TOOL_NAMES.asString(),
154-
TracingHelper.concatenateStrings(toolNames.stream().sorted().toList()));
154+
ObservabilityHelper.concatenateStrings(toolNames.stream().sorted().toList()));
155155
}
156156

157157
/**
@@ -170,7 +170,7 @@ protected KeyValues chatClientAdvisorParams(KeyValues keyValues, ChatClientObser
170170
Arrays.stream(ChatClientAttributes.values()).forEach(attribute -> chatClientContext.remove(attribute.getKey()));
171171
return keyValues.and(
172172
ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_ADVISOR_PARAMS.asString(),
173-
TracingHelper.concatenateMaps(chatClientContext));
173+
ObservabilityHelper.concatenateMaps(chatClientContext));
174174
}
175175

176176
/**
@@ -192,7 +192,7 @@ protected KeyValues toolNames(KeyValues keyValues, ChatClientObservationContext
192192

193193
return keyValues.and(
194194
ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_TOOL_FUNCTION_NAMES.asString(),
195-
TracingHelper.concatenateStrings(toolNames.stream().sorted().toList()));
195+
ObservabilityHelper.concatenateStrings(toolNames.stream().sorted().toList()));
196196
}
197197

198198
/**
@@ -218,7 +218,7 @@ protected KeyValues toolCallbacks(KeyValues keyValues, ChatClientObservationCont
218218
.toList();
219219
return keyValues
220220
.and(ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_TOOL_FUNCTION_CALLBACKS
221-
.asString(), TracingHelper.concatenateStrings(toolCallbackNames));
221+
.asString(), ObservabilityHelper.concatenateStrings(toolCallbackNames));
222222
}
223223

224224
}

‎spring-ai-commons/src/main/java/org/springframework/ai/observation/tracing/TracingHelper.java‎ renamed to ‎spring-ai-commons/src/main/java/org/springframework/ai/observation/tracing/ObservabilityHelper.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@
2121
import java.util.StringJoiner;
2222

2323
/**
24-
* Utilities to prepare and process traces for observability.
24+
* Utilities for observability.
2525
*
2626
* @author Thomas Vitale
2727
*/
28-
public final class TracingHelper {
28+
public final class ObservabilityHelper {
2929

30-
private TracingHelper() {
30+
private ObservabilityHelper() {
3131
}
3232

3333
public static String concatenateMaps(Map<String, Object> keyValues) {

‎spring-ai-model/src/main/java/org/springframework/ai/chat/observation/ChatModelCompletionObservationFilter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import io.micrometer.observation.Observation;
2020
import io.micrometer.observation.ObservationFilter;
2121

22-
import org.springframework.ai.observation.tracing.TracingHelper;
22+
import org.springframework.ai.observation.tracing.ObservabilityHelper;
2323

2424
/**
2525
* An {@link ObservationFilter} to include the chat completion content in the observation.
@@ -39,7 +39,7 @@ public Observation.Context map(Observation.Context context) {
3939

4040
chatModelObservationContext
4141
.addHighCardinalityKeyValue(ChatModelObservationDocumentation.HighCardinalityKeyNames.COMPLETION
42-
.withValue(TracingHelper.concatenateStrings(completions)));
42+
.withValue(ObservabilityHelper.concatenateStrings(completions)));
4343

4444
return chatModelObservationContext;
4545
}

‎spring-ai-model/src/main/java/org/springframework/ai/chat/observation/ChatModelPromptContentObservationFilter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import io.micrometer.observation.Observation;
2020
import io.micrometer.observation.ObservationFilter;
2121

22-
import org.springframework.ai.observation.tracing.TracingHelper;
22+
import org.springframework.ai.observation.tracing.ObservabilityHelper;
2323

2424
/**
2525
* An {@link ObservationFilter} to include the chat prompt content in the observation.
@@ -39,7 +39,7 @@ public Observation.Context map(Observation.Context context) {
3939

4040
chatModelObservationContext
4141
.addHighCardinalityKeyValue(ChatModelObservationDocumentation.HighCardinalityKeyNames.PROMPT
42-
.withValue(TracingHelper.concatenateStrings(prompts)));
42+
.withValue(ObservabilityHelper.concatenateStrings(prompts)));
4343

4444
return chatModelObservationContext;
4545
}

‎spring-ai-vector-store/src/main/java/org/springframework/ai/vectorstore/observation/VectorStoreQueryResponseObservationFilter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import io.micrometer.observation.Observation;
2020
import io.micrometer.observation.ObservationFilter;
2121

22-
import org.springframework.ai.observation.tracing.TracingHelper;
22+
import org.springframework.ai.observation.tracing.ObservabilityHelper;
2323
import org.springframework.util.CollectionUtils;
2424

2525
/**
@@ -44,7 +44,7 @@ public Observation.Context map(Observation.Context context) {
4444
if (!CollectionUtils.isEmpty(documents)) {
4545
observationContext.addHighCardinalityKeyValue(
4646
VectorStoreObservationDocumentation.HighCardinalityKeyNames.DB_VECTOR_QUERY_RESPONSE_DOCUMENTS
47-
.withValue(TracingHelper.concatenateStrings(documents)));
47+
.withValue(ObservabilityHelper.concatenateStrings(documents)));
4848
}
4949

5050
return observationContext;

0 commit comments

Comments
 (0)