Skip to content

feat: add operation type and provider metrics to advisor #1771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

feat: add operation type and provider metrics to advisor #1771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions ...g/springframework/ai/chat/client/advisor/observation/AdvisorObservationDocumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import io.micrometer.observation.ObservationConvention;
import io.micrometer.observation.docs.ObservationDocumentation;

import org.springframework.ai.observation.conventions.AiObservationAttributes;

/**
* AI Advisor observation documentation.
*
Expand Down Expand Up @@ -55,6 +57,26 @@ public KeyName[] getHighCardinalityKeyNames() {
*/
public enum LowCardinalityKeyNames implements KeyName {

/**
* The name of the operation being performed.
*/
AI_OPERATION_TYPE {
@Override
public String asString() {
return AiObservationAttributes.AI_OPERATION_TYPE.value();
}
},

/**
* The model provider as identified by the client instrumentation.
*/
AI_PROVIDER {
@Override
public String asString() {
return AiObservationAttributes.AI_PROVIDER.value();
}
},

/**
* Spring AI kind.
*/
Expand Down
13 changes: 12 additions & 1 deletion ...ringframework/ai/chat/client/advisor/observation/DefaultAdvisorObservationConvention.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@

import org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.HighCardinalityKeyNames;
import org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames;
import org.springframework.ai.observation.conventions.AiOperationType;
import org.springframework.ai.observation.conventions.AiProvider;
import org.springframework.ai.observation.conventions.SpringAiKind;
import org.springframework.ai.util.ParsingUtils;
import org.springframework.lang.Nullable;
Expand Down Expand Up @@ -64,7 +66,16 @@ public String getContextualName(AdvisorObservationContext context) {

@Override
public KeyValues getLowCardinalityKeyValues(AdvisorObservationContext context) {
return KeyValues.of(springAiKind(), advisorType(context), advisorName(context));
return KeyValues.of(aiOperationType(context), aiProvider(context), springAiKind(), advisorType(context),
advisorName(context));
}

protected KeyValue aiOperationType(AdvisorObservationContext context) {
return KeyValue.of(LowCardinalityKeyNames.AI_OPERATION_TYPE, AiOperationType.FRAMEWORK.value());
}

protected KeyValue aiProvider(AdvisorObservationContext context) {
return KeyValue.of(LowCardinalityKeyNames.AI_PROVIDER, AiProvider.SPRING_AI.value());
}

protected KeyValue advisorType(AdvisorObservationContext context) {
Expand Down
4 changes: 4 additions & 0 deletions ...ramework/ai/chat/client/advisor/observation/DefaultAdvisorObservationConventionTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@

import org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.HighCardinalityKeyNames;
import org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames;
import org.springframework.ai.observation.conventions.AiOperationType;
import org.springframework.ai.observation.conventions.AiProvider;
import org.springframework.ai.observation.conventions.SpringAiKind;

import static org.assertj.core.api.Assertions.assertThat;
Expand Down Expand Up @@ -69,6 +71,8 @@ void shouldHaveLowCardinalityKeyValuesWhenDefined() {
assertThat(this.observationConvention.getLowCardinalityKeyValues(observationContext)).contains(
KeyValue.of(LowCardinalityKeyNames.ADVISOR_TYPE.asString(),
AdvisorObservationContext.Type.AROUND.name()),
KeyValue.of(LowCardinalityKeyNames.AI_OPERATION_TYPE.asString(), AiOperationType.FRAMEWORK.value()),
KeyValue.of(LowCardinalityKeyNames.AI_PROVIDER.asString(), AiProvider.SPRING_AI.value()),
KeyValue.of(LowCardinalityKeyNames.ADVISOR_NAME.asString(), "MyName"),
KeyValue.of(LowCardinalityKeyNames.SPRING_AI_KIND.asString(), SpringAiKind.ADVISOR.value()));
}
Expand Down