Skip to content

Keep model metric attributes fixed for Prometheus #1470

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

Merged
merged 1 commit into from
Oct 6, 2024
Merged

Keep model metric attributes fixed for Prometheus #1470

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
16 changes: 4 additions & 12 deletions ...al-ai/src/test/java/org/springframework/ai/mistralai/MistralAiChatModelObservationIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package org.springframework.ai.mistralai;

import io.micrometer.common.KeyValue;
import io.micrometer.observation.tck.TestObservationRegistry;
import io.micrometer.observation.tck.TestObservationRegistryAssert;
import org.junit.jupiter.api.BeforeEach;
Expand Down Expand Up @@ -127,18 +128,9 @@ private void validate(ChatResponseMetadata responseMetadata) {
.hasLowCardinalityKeyValue(LowCardinalityKeyNames.AI_PROVIDER.asString(), AiProvider.MISTRAL_AI.value())
.hasLowCardinalityKeyValue(LowCardinalityKeyNames.REQUEST_MODEL.asString(),
MistralAiApi.ChatModel.OPEN_MISTRAL_7B.getValue())
.matches(contextView -> {
var keyValue = contextView.getLowCardinalityKeyValues()
.stream()
.filter(tag -> tag.getKey().equals(LowCardinalityKeyNames.RESPONSE_MODEL.asString()))
.findFirst();
if (StringUtils.hasText(responseMetadata.getModel())) {
return keyValue.isPresent() && keyValue.get().getValue().equals(responseMetadata.getModel());
}
else {
return keyValue.isEmpty();
}
})
.hasLowCardinalityKeyValue(LowCardinalityKeyNames.RESPONSE_MODEL.asString(),
StringUtils.hasText(responseMetadata.getModel()) ? responseMetadata.getModel()
: KeyValue.NONE_VALUE)
.doesNotHaveHighCardinalityKeyValueWithKey(HighCardinalityKeyNames.REQUEST_FREQUENCY_PENALTY.asString())
.hasHighCardinalityKeyValue(HighCardinalityKeyNames.REQUEST_MAX_TOKENS.asString(), "2048")
.doesNotHaveHighCardinalityKeyValueWithKey(HighCardinalityKeyNames.REQUEST_PRESENCE_PENALTY.asString())
Expand Down
14 changes: 8 additions & 6 deletions ...n/java/org/springframework/ai/chat/observation/DefaultChatModelObservationConvention.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ public class DefaultChatModelObservationConvention implements ChatModelObservati
private static final KeyValue REQUEST_MODEL_NONE = KeyValue
.of(ChatModelObservationDocumentation.LowCardinalityKeyNames.REQUEST_MODEL, KeyValue.NONE_VALUE);

private static final KeyValue RESPONSE_MODEL_NONE = KeyValue
.of(ChatModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL, KeyValue.NONE_VALUE);

public static final String DEFAULT_NAME = "gen_ai.client.operation";

@Override
Expand All @@ -52,9 +55,8 @@ public String getContextualName(ChatModelObservationContext context) {

@Override
public KeyValues getLowCardinalityKeyValues(ChatModelObservationContext context) {
var keyValues = KeyValues.of(aiOperationType(context), aiProvider(context), requestModel(context));
keyValues = responseModel(keyValues, context);
return keyValues;
return KeyValues.of(aiOperationType(context), aiProvider(context), requestModel(context),
responseModel(context));
}

protected KeyValue aiOperationType(ChatModelObservationContext context) {
Expand All @@ -75,13 +77,13 @@ protected KeyValue requestModel(ChatModelObservationContext context) {
return REQUEST_MODEL_NONE;
}

protected KeyValues responseModel(KeyValues keyValues, ChatModelObservationContext context) {
protected KeyValue responseModel(ChatModelObservationContext context) {
if (context.getResponse() != null && context.getResponse().getMetadata() != null
&& StringUtils.hasText(context.getResponse().getMetadata().getModel())) {
return keyValues.and(ChatModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL.asString(),
return KeyValue.of(ChatModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL,
context.getResponse().getMetadata().getModel());
}
return keyValues;
return RESPONSE_MODEL_NONE;
}

@Override
Expand Down
15 changes: 8 additions & 7 deletions .../springframework/ai/embedding/observation/DefaultEmbeddingModelObservationConvention.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ public class DefaultEmbeddingModelObservationConvention implements EmbeddingMode
private static final KeyValue REQUEST_MODEL_NONE = KeyValue
.of(EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.REQUEST_MODEL, KeyValue.NONE_VALUE);

private static final KeyValue RESPONSE_MODEL_NONE = KeyValue
.of(EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL, KeyValue.NONE_VALUE);

public static final String DEFAULT_NAME = "gen_ai.client.operation";

@Override
Expand All @@ -48,9 +51,8 @@ public String getContextualName(EmbeddingModelObservationContext context) {

@Override
public KeyValues getLowCardinalityKeyValues(EmbeddingModelObservationContext context) {
var keyValues = KeyValues.of(aiOperationType(context), aiProvider(context), requestModel(context));
keyValues = responseModel(keyValues, context);
return keyValues;
return KeyValues.of(aiOperationType(context), aiProvider(context), requestModel(context),
responseModel(context));
}

protected KeyValue aiOperationType(EmbeddingModelObservationContext context) {
Expand All @@ -71,14 +73,13 @@ protected KeyValue requestModel(EmbeddingModelObservationContext context) {
return REQUEST_MODEL_NONE;
}

protected KeyValues responseModel(KeyValues keyValues, EmbeddingModelObservationContext context) {
protected KeyValue responseModel(EmbeddingModelObservationContext context) {
if (context.getResponse() != null && context.getResponse().getMetadata() != null
&& StringUtils.hasText(context.getResponse().getMetadata().getModel())) {
return keyValues.and(
EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL.asString(),
return KeyValue.of(EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL,
context.getResponse().getMetadata().getModel());
}
return keyValues;
return RESPONSE_MODEL_NONE;
}

@Override
Expand Down
5 changes: 2 additions & 3 deletions ...a/org/springframework/ai/chat/observation/DefaultChatModelObservationConventionTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,8 @@ void shouldNotHaveKeyValuesWhenMissing() {
.requestOptions(ChatOptionsBuilder.builder().build())
.build();
assertThat(this.observationConvention.getLowCardinalityKeyValues(observationContext))
.contains(KeyValue.of(LowCardinalityKeyNames.REQUEST_MODEL.asString(), KeyValue.NONE_VALUE));
assertThat(this.observationConvention.getLowCardinalityKeyValues(observationContext))
.noneMatch(keyValue -> keyValue.getKey().equals(LowCardinalityKeyNames.RESPONSE_MODEL.asString()));
.contains(KeyValue.of(LowCardinalityKeyNames.REQUEST_MODEL.asString(), KeyValue.NONE_VALUE))
.contains(KeyValue.of(LowCardinalityKeyNames.RESPONSE_MODEL.asString(), KeyValue.NONE_VALUE));
assertThat(this.observationConvention.getHighCardinalityKeyValues(observationContext)
.stream()
.map(KeyValue::getKey)
Expand Down
5 changes: 2 additions & 3 deletions ...ngframework/ai/embedding/observation/DefaultEmbeddingModelObservationConventionTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,8 @@ void shouldNotHaveKeyValuesWhenMissing() {
.requestOptions(EmbeddingOptionsBuilder.builder().build())
.build();
assertThat(this.observationConvention.getLowCardinalityKeyValues(observationContext))
.contains(KeyValue.of(LowCardinalityKeyNames.REQUEST_MODEL.asString(), KeyValue.NONE_VALUE));
assertThat(this.observationConvention.getLowCardinalityKeyValues(observationContext))
.noneMatch(keyValue -> keyValue.getKey().equals(LowCardinalityKeyNames.RESPONSE_MODEL.asString()));
.contains(KeyValue.of(LowCardinalityKeyNames.REQUEST_MODEL.asString(), KeyValue.NONE_VALUE))
.contains(KeyValue.of(LowCardinalityKeyNames.RESPONSE_MODEL.asString(), KeyValue.NONE_VALUE));
assertThat(this.observationConvention.getHighCardinalityKeyValues(observationContext)
.stream()
.map(KeyValue::getKey)
Expand Down