Skip to content

Commit ea727f0

Browse files
committed
Polish "Update links to Micrometer reference docs"
See gh-39114
1 parent 6c5fea7 commit ea727f0

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ This section briefly describes each of the supported monitoring systems.
8585
[[actuator.metrics.export.appoptics]]
8686
==== AppOptics
8787
By default, the AppOptics registry periodically pushes metrics to `https://api.appoptics.com/v1/measurements`.
88-
To export metrics to SaaS {micrometer-registry-docs}/appOptics[AppOptics], your API token must be provided:
88+
To export metrics to SaaS {micrometer-implementation-docs}/appOptics[AppOptics], your API token must be provided:
8989

9090
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
9191
----
@@ -100,7 +100,7 @@ To export metrics to SaaS {micrometer-registry-docs}/appOptics[AppOptics], your
100100

101101
[[actuator.metrics.export.atlas]]
102102
==== Atlas
103-
By default, metrics are exported to {micrometer-registry-docs}/atlas[Atlas] running on your local machine.
103+
By default, metrics are exported to {micrometer-implementation-docs}/atlas[Atlas] running on your local machine.
104104
You can provide the location of the https://github.com/Netflix/atlas[Atlas server]:
105105

106106
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -117,7 +117,7 @@ You can provide the location of the https://github.com/Netflix/atlas[Atlas serve
117117
[[actuator.metrics.export.datadog]]
118118
==== Datadog
119119
A Datadog registry periodically pushes metrics to https://www.datadoghq.com[datadoghq].
120-
To export metrics to {micrometer-registry-docs}/datadog[Datadog], you must provide your API key:
120+
To export metrics to {micrometer-implementation-docs}/datadog[Datadog], you must provide your API key:
121121

122122
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
123123
----
@@ -167,7 +167,7 @@ You can also change the interval at which metrics are sent to Datadog:
167167

168168
[[actuator.metrics.export.dynatrace]]
169169
==== Dynatrace
170-
Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-registry-docs}/dynatrace[Micrometer].
170+
Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-implementation-docs}/dynatrace[Micrometer].
171171
You can find the Dynatrace documentation on Micrometer metrics ingest {dynatrace-docs}/micrometer-metrics-ingest[here].
172172
Configuration properties in the `v1` namespace apply only when exporting to the {dynatrace-docs}/api-metrics[Timeseries v1 API].
173173
Configuration properties in the `v2` namespace apply only when exporting to the {dynatrace-docs}/api-metrics-v2-post-datapoints[Metrics v2 API].
@@ -256,7 +256,7 @@ In this scenario, the automatically configured endpoint is used:
256256
===== v1 API (Legacy)
257257
The Dynatrace v1 API metrics registry pushes metrics to the configured URI periodically by using the {dynatrace-docs}/api-metrics[Timeseries v1 API].
258258
For backwards-compatibility with existing setups, when `device-id` is set (required for v1, but not used in v2), metrics are exported to the Timeseries v1 endpoint.
259-
To export metrics to {micrometer-registry-docs}/dynatrace[Dynatrace], your API token, device ID, and URI must be provided:
259+
To export metrics to {micrometer-implementation-docs}/dynatrace[Dynatrace], your API token, device ID, and URI must be provided:
260260

261261
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
262262
----
@@ -289,13 +289,13 @@ The following example sets the export interval to 30 seconds:
289289
step: "30s"
290290
----
291291

292-
You can find more information on how to set up the Dynatrace exporter for Micrometer in the {micrometer-registry-docs}/dynatrace[Micrometer documentation] and the {dynatrace-docs}/micrometer-metrics-ingest[Dynatrace documentation].
292+
You can find more information on how to set up the Dynatrace exporter for Micrometer in the {micrometer-implementation-docs}/dynatrace[Micrometer documentation] and the {dynatrace-docs}/micrometer-metrics-ingest[Dynatrace documentation].
293293

294294

295295

296296
[[actuator.metrics.export.elastic]]
297297
==== Elastic
298-
By default, metrics are exported to {micrometer-registry-docs}/elastic[Elastic] running on your local machine.
298+
By default, metrics are exported to {micrometer-implementation-docs}/elastic[Elastic] running on your local machine.
299299
You can provide the location of the Elastic server to use by using the following property:
300300

301301
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -309,7 +309,7 @@ You can provide the location of the Elastic server to use by using the following
309309

310310
[[actuator.metrics.export.ganglia]]
311311
==== Ganglia
312-
By default, metrics are exported to {micrometer-registry-docs}/ganglia[Ganglia] running on your local machine.
312+
By default, metrics are exported to {micrometer-implementation-docs}/ganglia[Ganglia] running on your local machine.
313313
You can provide the http://ganglia.sourceforge.net[Ganglia server] host and port, as the following example shows:
314314

315315
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -326,7 +326,7 @@ You can provide the http://ganglia.sourceforge.net[Ganglia server] host and port
326326

327327
[[actuator.metrics.export.graphite]]
328328
==== Graphite
329-
By default, metrics are exported to {micrometer-registry-docs}/graphite[Graphite] running on your local machine.
329+
By default, metrics are exported to {micrometer-implementation-docs}/graphite[Graphite] running on your local machine.
330330
You can provide the https://graphiteapp.org[Graphite server] host and port, as the following example shows:
331331

332332
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -339,7 +339,7 @@ You can provide the https://graphiteapp.org[Graphite server] host and port, as t
339339
port: 9004
340340
----
341341

342-
Micrometer provides a default `HierarchicalNameMapper` that governs how a dimensional meter ID is {micrometer-registry-docs}/graphite#_hierarchical_name_mapping[mapped to flat hierarchical names].
342+
Micrometer provides a default `HierarchicalNameMapper` that governs how a dimensional meter ID is {micrometer-implementation-docs}/graphite#_hierarchical_name_mapping[mapped to flat hierarchical names].
343343

344344
[TIP]
345345
====
@@ -354,7 +354,7 @@ include::code:MyGraphiteConfiguration[]
354354
[[actuator.metrics.export.humio]]
355355
==== Humio
356356
By default, the Humio registry periodically pushes metrics to https://cloud.humio.com.
357-
To export metrics to SaaS {micrometer-registry-docs}/humio[Humio], you must provide your API token:
357+
To export metrics to SaaS {micrometer-implementation-docs}/humio[Humio], you must provide your API token:
358358

359359
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
360360
----
@@ -382,7 +382,7 @@ You should also configure one or more tags to identify the data source to which
382382

383383
[[actuator.metrics.export.influx]]
384384
==== Influx
385-
By default, metrics are exported to an {micrometer-registry-docs}/influx[Influx] v1 instance running on your local machine with the default configuration.
385+
By default, metrics are exported to an {micrometer-implementation-docs}/influx[Influx] v1 instance running on your local machine with the default configuration.
386386
To export metrics to InfluxDB v2, configure the `org`, `bucket`, and authentication `token` for writing metrics.
387387
You can provide the location of the https://www.influxdata.com[Influx server] to use by using:
388388

@@ -399,7 +399,7 @@ You can provide the location of the https://www.influxdata.com[Influx server] to
399399

400400
[[actuator.metrics.export.jmx]]
401401
==== JMX
402-
Micrometer provides a hierarchical mapping to {micrometer-registry-docs}/jmx[JMX], primarily as a cheap and portable way to view metrics locally.
402+
Micrometer provides a hierarchical mapping to {micrometer-implementation-docs}/jmx[JMX], primarily as a cheap and portable way to view metrics locally.
403403
By default, metrics are exported to the `metrics` JMX domain.
404404
You can provide the domain to use by using:
405405

@@ -412,7 +412,7 @@ You can provide the domain to use by using:
412412
domain: "com.example.app.metrics"
413413
----
414414

415-
Micrometer provides a default `HierarchicalNameMapper` that governs how a dimensional meter ID is {micrometer-registry-docs}/jmx#_hierarchical_name_mapping[mapped to flat hierarchical names].
415+
Micrometer provides a default `HierarchicalNameMapper` that governs how a dimensional meter ID is {micrometer-implementation-docs}/jmx#_hierarchical_name_mapping[mapped to flat hierarchical names].
416416

417417
[TIP]
418418
====
@@ -426,7 +426,7 @@ include::code:MyJmxConfiguration[]
426426

427427
[[actuator.metrics.export.kairos]]
428428
==== KairosDB
429-
By default, metrics are exported to {micrometer-registry-docs}/kairos[KairosDB] running on your local machine.
429+
By default, metrics are exported to {micrometer-implementation-docs}/kairos[KairosDB] running on your local machine.
430430
You can provide the location of the https://kairosdb.github.io/[KairosDB server] to use by using:
431431

432432
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -442,7 +442,7 @@ You can provide the location of the https://kairosdb.github.io/[KairosDB server]
442442

443443
[[actuator.metrics.export.newrelic]]
444444
==== New Relic
445-
A New Relic registry periodically pushes metrics to {micrometer-registry-docs}/new-relic[New Relic].
445+
A New Relic registry periodically pushes metrics to {micrometer-implementation-docs}/new-relic[New Relic].
446446
To export metrics to https://newrelic.com[New Relic], you must provide your API key and account ID:
447447

448448
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -483,7 +483,7 @@ Finally, you can take full control by defining your own `NewRelicClientProvider`
483483

484484
[[actuator.metrics.export.otlp]]
485485
==== OpenTelemetry
486-
By default, metrics are exported to {micrometer-registry-docs}/otlp[OpenTelemetry] running on your local machine.
486+
By default, metrics are exported to {micrometer-implementation-docs}/otlp[OpenTelemetry] running on your local machine.
487487
You can provide the location of the https://opentelemetry.io/[OpenTelemetry metric endpoint] to use by using:
488488

489489
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -499,7 +499,7 @@ You can provide the location of the https://opentelemetry.io/[OpenTelemetry metr
499499

500500
[[actuator.metrics.export.prometheus]]
501501
==== Prometheus
502-
{micrometer-registry-docs}/prometheus[Prometheus] expects to scrape or poll individual application instances for metrics.
502+
{micrometer-implementation-docs}/prometheus[Prometheus] expects to scrape or poll individual application instances for metrics.
503503
Spring Boot provides an actuator endpoint at `/actuator/prometheus` to present a https://prometheus.io[Prometheus scrape] with the appropriate format.
504504

505505
TIP: By default, the endpoint is not available and must be exposed. See <<actuator#actuator.endpoints.exposing,exposing endpoints>> for more details.
@@ -541,7 +541,7 @@ For advanced configuration, you can also provide your own `PrometheusPushGateway
541541

542542
[[actuator.metrics.export.signalfx]]
543543
==== SignalFx
544-
SignalFx registry periodically pushes metrics to {micrometer-registry-docs}/signalFx[SignalFx].
544+
SignalFx registry periodically pushes metrics to {micrometer-implementation-docs}/signalFx[SignalFx].
545545
To export metrics to https://www.signalfx.com[SignalFx], you must provide your access token:
546546

547547
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -588,7 +588,7 @@ You can also disable it explicitly:
588588
[[actuator.metrics.export.stackdriver]]
589589
==== Stackdriver
590590
The Stackdriver registry periodically pushes metrics to https://cloud.google.com/stackdriver/[Stackdriver].
591-
To export metrics to SaaS {micrometer-registry-docs}/stackdriver[Stackdriver], you must provide your Google Cloud project ID:
591+
To export metrics to SaaS {micrometer-implementation-docs}/stackdriver[Stackdriver], you must provide your Google Cloud project ID:
592592

593593
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
594594
----
@@ -615,7 +615,7 @@ You can also change the interval at which metrics are sent to Stackdriver:
615615
[[actuator.metrics.export.statsd]]
616616
==== StatsD
617617
The StatsD registry eagerly pushes metrics over UDP to a StatsD agent.
618-
By default, metrics are exported to a {micrometer-registry-docs}/statsD[StatsD] agent running on your local machine.
618+
By default, metrics are exported to a {micrometer-implementation-docs}/statsD[StatsD] agent running on your local machine.
619619
You can provide the StatsD agent host, port, and protocol to use by using:
620620

621621
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
@@ -644,7 +644,7 @@ You can also change the StatsD line protocol to use (it defaults to Datadog):
644644

645645
[[actuator.metrics.export.wavefront]]
646646
==== Wavefront
647-
The Wavefront registry periodically pushes metrics to {micrometer-registry-docs}/wavefront[Wavefront].
647+
The Wavefront registry periodically pushes metrics to {micrometer-implementation-docs}/wavefront[Wavefront].
648648
If you are exporting metrics to https://www.wavefront.com/[Wavefront] directly, you must provide your API token:
649649

650650
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]

spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
:lettuce-docs: https://lettuce.io/core/{lettuce-version}/reference/index.html
109109
:micrometer-docs: https://docs.micrometer.io/micrometer/reference
110110
:micrometer-concepts-docs: {micrometer-docs}/concepts
111-
:micrometer-registry-docs: {micrometer-docs}/registry
111+
:micrometer-implementation-docs: {micrometer-docs}/implementations
112112
:tomcat-docs: https://tomcat.apache.org/tomcat-{tomcat-version}-doc
113113
:graal-version: 22.3
114114
:graal-native-image-docs: https://www.graalvm.org/{graal-version}/reference-manual/native-image

0 commit comments

Comments
 (0)