Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add ChatClient input data section to Observability docs

Browse Source
This commit is contained in:
Christian Tzolov
2024-08-22 09:49:32 +02:00
parent 036093a42b
commit 9587cb0dfb
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
spring-ai-docs/src/main/antora/modules/ROOT/pages/observabilty/index.adoc
View File

@@ -33,6 +33,17 @@ NOTE: Low cardinality keys will be added to metrics and traces, while high cardi
|`spring.ai.chat.client.user.text` |Chat client user text.
|===
=== ChatClient input data
The ChatClient input data is typically too big to be included in an observation as span attributes.
The preferred way to store large data it is as span events, which are supported by OpenTelemetry but not yet surfaced through the Micrometer APIs.
Spring AI supports storing these fields as events in OpenTelemetry and will provide a more general event based solution once the issue https://github.com/micrometer-metrics/micrometer/issues/5238 is resolved.
[cols="6,3,1"]
|====
| Property | Description | Default
| `spring.ai.chat.client.observations.include-input` | Enables the inclusion of the input content in the observations. This brings the risk of exposing sensitive or private information. Please, be careful! | `false`
|====
=== ChatClient Advisors