Skip to content

Commit e6eba40

Browse files
committed
Remove advisor low-cardinality keys that aren't actually exposed.
1 parent 0d2d4b7 commit e6eba40

File tree

1 file changed

+6
-8
lines changed
  • spring-ai-docs/src/main/antora/modules/ROOT/pages/observability

1 file changed

+6
-8
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/observability/index.adoc

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ NOTE: Low cardinality keys will be added to metrics and traces, while high cardi
99

1010
== Chat Client
1111

12-
The `spring.ai.chat.client` observations are recorded when a ChatClient `call()` or `stream()` operations are invoked.
12+
The `spring.ai.chat.client` observations are recorded when a ChatClient `call()` or `stream()` operations are invoked.
1313
They measure the time spent performing the invocation and propagate the related tracing information.
1414

1515
.Low Cardinality Keys
@@ -56,16 +56,14 @@ WARNING: If you enable the inclusion of the input content in the observations, t
5656

5757
=== Chat Client Advisors
5858

59-
The `spring.ai.advisor` observations are recorded when a call or stream around advisors is performed.
59+
The `spring.ai.advisor` observations are recorded when a call or stream around advisors is performed.
6060
They measure the time spent in the advisor (including the time spend on the inner advisors) and propagate the related tracing information.
6161

6262
.Low Cardinality Keys
6363
[cols="a,a", stripes=even]
6464
|===
6565
|Name | Description
6666

67-
|`gen_ai.operation.name` | Always `framework`.
68-
|`gen_ai.system` | Always `spring_ai`.
6967
|`spring.ai.advisor.type` | Where the advisor applies it's logic in the request processing, one of `BEFORE`, `AFTER`, or `AROUND`.
7068
|`spring.ai.kind` | The kind of framework API in Spring AI: `advisor`.
7169
|===
@@ -85,7 +83,7 @@ NOTE: Observability features are currently supported only for `ChatModel` implem
8583
providers: Anthropic, Azure OpenAI, Mistral AI, Ollama, OpenAI, Vertex AI, MiniMax, Moonshot, QianFan, Zhiu AI.
8684
Additional AI model providers will be supported in a future release.
8785

88-
The `gen_ai.client.operation` observations are recorded when calling the ChatModel `call` or `stream` methods.
86+
The `gen_ai.client.operation` observations are recorded when calling the ChatModel `call` or `stream` methods.
8987
They measure the time spent on method completion and propagate the related tracing information.
9088

9189
IMPORTANT: The `gen_ai.client.token.usage` metrics measures number of input and output tokens used by a single model call.
@@ -162,7 +160,7 @@ NOTE: Observability features are currently supported only for `EmbeddingModel` i
162160
AI model providers: Azure OpenAI, Mistral AI, Ollama, and OpenAI.
163161
Additional AI model providers will be supported in a future release.
164162

165-
The `gen_ai.client.operation` observations are recorded on embedding model method calls.
163+
The `gen_ai.client.operation` observations are recorded on embedding model method calls.
166164
They measure the time spent on method completion and propagate the related tracing information.
167165

168166
IMPORTANT: The `gen_ai.client.token.usage` metrics measures number of input and output tokens used by a single model call.
@@ -197,7 +195,7 @@ NOTE: Observability features are currently supported only for `ImageModel` imple
197195
providers: OpenAI.
198196
Additional AI model providers will be supported in a future release.
199197

200-
The `gen_ai.client.operation` observations are recorded on image model method calls.
198+
The `gen_ai.client.operation` observations are recorded on image model method calls.
201199
They measure the time spent on method completion and propagate the related tracing information.
202200

203201
IMPORTANT: The `gen_ai.client.token.usage` metrics measures number of input and output tokens used by a single model call.
@@ -260,7 +258,7 @@ WARNING: If you enable the inclusion of the image prompt data in the observation
260258

261259
All vector store implementations in Spring AI are instrumented to provide metrics and distributed tracing data through Micrometer.
262260

263-
The `db.vector.client.operation` observations are recorded when interacting with the Vector Store.
261+
The `db.vector.client.operation` observations are recorded when interacting with the Vector Store.
264262
They measure the time spent on the `query`, `add` and `remove` operations and propagate the related tracing information.
265263

266264
.Low Cardinality Keys

0 commit comments

Comments
 (0)