Skip to content

Commit aab1bef

Browse files
philwebblourw
authored andcommitted
Use reference stubs in Antora playbook for actuator-autoconfigure
Use reference stubs so that we can include a link to the supported metrics backends. Closes spring-projectsgh-45158
1 parent 3cd1790 commit aab1bef

File tree

2 files changed

+5
-1
lines changed
  • spring-boot-project/spring-boot-actuator-autoconfigure

2 files changed

+5
-1
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,10 @@ def documentationTest = tasks.register("documentationTest", Test) {
214214
}
215215
}
216216

217+
tasks.named("generateAntoraPlaybook") {
218+
antoraExtensions.xref.stubs = ["appendix:.*", "api:.*", "reference:.*"]
219+
}
220+
217221
antoraContributions {
218222
'actuator-rest-api' {
219223
aggregateContent {

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The `metrics` endpoint provides access to application metrics to diagnose the metrics the application has recorded.
55
This endpoint should not be "scraped" or used as a metrics backend in production.
66
Its purpose is to show the currently registered metrics so users can see what metrics are available, what their current values are, and if triggering certain operations cause any change in certain values.
7-
If you want to diagnose your applications through the metrics they collect, you should use an external metrics backend.
7+
If you want to diagnose your applications through the metrics they collect, you should use an xref:reference:actuator/metrics.adoc[external metrics backend].
88
In this case, the `metrics` endpoint can still be useful.
99

1010

0 commit comments

Comments
 (0)