Skip to content

Commit 1589a19

Browse files
Seungpangmhalbritter
authored andcommitted
Replace hard-coded links to Micrometer in documentation
See gh-40967
1 parent 550433e commit 1589a19

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ scrape_configs:
545545
https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage[Prometheus Exemplars] are also supported.
546546
To enable this feature, a `SpanContext` bean should be present.
547547
If you're using the deprecated Prometheus simpleclient support and want to enable that feature, a `SpanContextSupplier` bean should be present.
548-
If you use https://micrometer.io/docs/tracing[Micrometer Tracing], this will be auto-configured for you, but you can always create your own if you want.
548+
If you use {url-micrometer-tracing-docs}[Micrometer Tracing], this will be auto-configured for you, but you can always create your own if you want.
549549
Please check the https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage[Prometheus Docs], since this feature needs to be explicitly enabled on Prometheus' side, and it is only supported using the https://github.com/OpenObservability/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#exemplars[OpenMetrics] format.
550550

551551
For ephemeral or batch jobs that may not exist long enough to be scraped, you can use https://github.com/prometheus/pushgateway[Prometheus Pushgateway] support to expose the metrics to Prometheus.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/observability.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Observability is the ability to observe the internal state of a running system from the outside.
55
It consists of the three pillars logging, metrics and traces.
66

7-
For metrics and traces, Spring Boot uses https://micrometer.io/docs/observation[Micrometer Observation].
7+
For metrics and traces, Spring Boot uses {url-micrometer-docs}/observation[Micrometer Observation].
88
To create your own observations (which will lead to metrics and traces), you can inject an `ObservationRegistry`.
99

1010
include-code::MyCustomObservation[]
@@ -18,7 +18,7 @@ Observability support relies on the https://github.com/micrometer-metrics/contex
1818
By default, `ThreadLocal` values are not automatically reinstated in reactive operators.
1919
This behavior is controlled with the configprop:spring.reactor.context-propagation[] property, which can be set to `auto` to enable automatic propagation.
2020

21-
For more details about observations please see the https://micrometer.io/docs/observation[Micrometer Observation documentation].
21+
For more details about observations please see the {url-micrometer-docs}/observation[Micrometer Observation documentation].
2222

2323
TIP: Observability for JDBC can be configured using a separate project.
2424
The https://github.com/jdbc-observations/datasource-micrometer[Datasource Micrometer project] provides a Spring Boot starter which automatically creates observations when JDBC operations are invoked.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/tracing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[[actuator.micrometer-tracing]]
22
= Tracing
33

4-
Spring Boot Actuator provides dependency management and auto-configuration for https://micrometer.io/docs/tracing[Micrometer Tracing], a facade for popular tracer libraries.
4+
Spring Boot Actuator provides dependency management and auto-configuration for {url-micrometer-tracing-docs}[Micrometer Tracing], a facade for popular tracer libraries.
55

6-
TIP: To learn more about Micrometer Tracing capabilities, see its https://micrometer.io/docs/tracing[reference documentation].
6+
TIP: To learn more about Micrometer Tracing capabilities, see its {url-micrometer-tracing-docs}[reference documentation].
77

88

99

@@ -34,7 +34,7 @@ Now we have to add the following dependencies:
3434

3535
* `org.springframework.boot:spring-boot-starter-actuator`
3636
* `io.micrometer:micrometer-tracing-bridge-otel` - bridges the Micrometer Observation API to OpenTelemetry.
37-
* `io.opentelemetry:opentelemetry-exporter-zipkin` - reports https://micrometer.io/docs/tracing#_glossary[traces] to Zipkin.
37+
* `io.opentelemetry:opentelemetry-exporter-zipkin` - reports {url-micrometer-tracing-docs}/glossary[traces] to Zipkin.
3838

3939
Add the following application properties:
4040

@@ -192,7 +192,7 @@ include-code::CustomObservation[]
192192

193193
This will create an observation named "some-operation" with the tag "some-tag=some-value".
194194

195-
TIP: If you want to create a span without creating a metric, you need to use the https://micrometer.io/docs/tracing#_using_micrometer_tracing_directly[lower-level `Tracer` API] from Micrometer.
195+
TIP: If you want to create a span without creating a metric, you need to use the {url-micrometer-tracing-docs}/api[lower-level `Tracer` API] from Micrometer.
196196

197197

198198

0 commit comments

Comments
 (0)