From ada1887f978b5bb1126caa286775152356437c17 Mon Sep 17 00:00:00 2001 From: Yanming Zhou Date: Tue, 21 Oct 2025 10:30:45 +0800 Subject: [PATCH] Document that Spring Boot Actuator is required for observability Signed-off-by: Yanming Zhou --- .../ROOT/pages/observability/index.adoc | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/observability/index.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/observability/index.adoc index 2ddeacadd46..b113df3d251 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/observability/index.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/observability/index.adoc @@ -2,6 +2,27 @@ = Observability Spring AI builds upon the observability features in the Spring ecosystem to provide insights into AI-related operations. + +The spring-boot-actuator module is required for enabling observability. +Add the Spring Boot Actuator dependency to your project's Maven `pom.xml` build file: + +[source,xml] +---- + + org.springframework.boot + spring-boot-starter-actuator + +---- + +or to your Gradle `build.gradle` build file. + +[source,groovy] +---- +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-actuator' +} +---- + Spring AI provides metrics and tracing capabilities for its core components: `ChatClient` (including `Advisor`), `ChatModel`, `EmbeddingModel`, `ImageModel`, and `VectorStore`.