From 6c5fea7341332c082d5964bbee1923e633c9e461 Mon Sep 17 00:00:00 2001 From: Tobias Lippert Date: Fri, 12 Jan 2024 11:40:32 +0100 Subject: [PATCH 1/2] Update links to Micrometer reference docs See gh-39114 --- .../spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/attributes.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc index ddaf2d453ff..c299e599efd 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc @@ -22,7 +22,7 @@ Spring Boot Actuator provides dependency management and auto-configuration for h - <> - <> -TIP: To learn more about Micrometer's capabilities, see its https://micrometer.io/docs[reference documentation], in particular the {micrometer-concepts-docs}[concepts section]. +TIP: To learn more about Micrometer's capabilities, see its {micrometer-docs}[reference documentation], in particular the {micrometer-concepts-docs}[concepts section]. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc index 0df9e72be72..53ab08551cb 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc @@ -106,7 +106,7 @@ :junit5-docs: https://junit.org/junit5/docs/current/user-guide :kotlin-docs: https://kotlinlang.org/docs/reference/ :lettuce-docs: https://lettuce.io/core/{lettuce-version}/reference/index.html -:micrometer-docs: https://micrometer.io/docs +:micrometer-docs: https://docs.micrometer.io/micrometer/reference :micrometer-concepts-docs: {micrometer-docs}/concepts :micrometer-registry-docs: {micrometer-docs}/registry :tomcat-docs: https://tomcat.apache.org/tomcat-{tomcat-version}-doc From ea727f056a531690ed36d4e4dd0f7d44eb109107 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 16 Jan 2024 16:05:09 +0000 Subject: [PATCH 2/2] Polish "Update links to Micrometer reference docs" See gh-39114 --- .../src/docs/asciidoc/actuator/metrics.adoc | 44 +++++++++---------- .../src/docs/asciidoc/attributes.adoc | 2 +- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc index c299e599efd..39a21c43711 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc @@ -85,7 +85,7 @@ This section briefly describes each of the supported monitoring systems. [[actuator.metrics.export.appoptics]] ==== AppOptics By default, the AppOptics registry periodically pushes metrics to `https://api.appoptics.com/v1/measurements`. -To export metrics to SaaS {micrometer-registry-docs}/appOptics[AppOptics], your API token must be provided: +To export metrics to SaaS {micrometer-implementation-docs}/appOptics[AppOptics], your API token must be provided: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] ---- @@ -100,7 +100,7 @@ To export metrics to SaaS {micrometer-registry-docs}/appOptics[AppOptics], your [[actuator.metrics.export.atlas]] ==== Atlas -By default, metrics are exported to {micrometer-registry-docs}/atlas[Atlas] running on your local machine. +By default, metrics are exported to {micrometer-implementation-docs}/atlas[Atlas] running on your local machine. You can provide the location of the https://github.com/Netflix/atlas[Atlas server]: [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 [[actuator.metrics.export.datadog]] ==== Datadog A Datadog registry periodically pushes metrics to https://www.datadoghq.com[datadoghq]. -To export metrics to {micrometer-registry-docs}/datadog[Datadog], you must provide your API key: +To export metrics to {micrometer-implementation-docs}/datadog[Datadog], you must provide your API key: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] ---- @@ -167,7 +167,7 @@ You can also change the interval at which metrics are sent to Datadog: [[actuator.metrics.export.dynatrace]] ==== Dynatrace -Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-registry-docs}/dynatrace[Micrometer]. +Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-implementation-docs}/dynatrace[Micrometer]. You can find the Dynatrace documentation on Micrometer metrics ingest {dynatrace-docs}/micrometer-metrics-ingest[here]. Configuration properties in the `v1` namespace apply only when exporting to the {dynatrace-docs}/api-metrics[Timeseries v1 API]. 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: ===== v1 API (Legacy) The Dynatrace v1 API metrics registry pushes metrics to the configured URI periodically by using the {dynatrace-docs}/api-metrics[Timeseries v1 API]. 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. -To export metrics to {micrometer-registry-docs}/dynatrace[Dynatrace], your API token, device ID, and URI must be provided: +To export metrics to {micrometer-implementation-docs}/dynatrace[Dynatrace], your API token, device ID, and URI must be provided: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] ---- @@ -289,13 +289,13 @@ The following example sets the export interval to 30 seconds: step: "30s" ---- -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]. +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]. [[actuator.metrics.export.elastic]] ==== Elastic -By default, metrics are exported to {micrometer-registry-docs}/elastic[Elastic] running on your local machine. +By default, metrics are exported to {micrometer-implementation-docs}/elastic[Elastic] running on your local machine. You can provide the location of the Elastic server to use by using the following property: [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 [[actuator.metrics.export.ganglia]] ==== Ganglia -By default, metrics are exported to {micrometer-registry-docs}/ganglia[Ganglia] running on your local machine. +By default, metrics are exported to {micrometer-implementation-docs}/ganglia[Ganglia] running on your local machine. You can provide the http://ganglia.sourceforge.net[Ganglia server] host and port, as the following example shows: [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 [[actuator.metrics.export.graphite]] ==== Graphite -By default, metrics are exported to {micrometer-registry-docs}/graphite[Graphite] running on your local machine. +By default, metrics are exported to {micrometer-implementation-docs}/graphite[Graphite] running on your local machine. You can provide the https://graphiteapp.org[Graphite server] host and port, as the following example shows: [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 port: 9004 ---- -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]. +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]. [TIP] ==== @@ -354,7 +354,7 @@ include::code:MyGraphiteConfiguration[] [[actuator.metrics.export.humio]] ==== Humio By default, the Humio registry periodically pushes metrics to https://cloud.humio.com. -To export metrics to SaaS {micrometer-registry-docs}/humio[Humio], you must provide your API token: +To export metrics to SaaS {micrometer-implementation-docs}/humio[Humio], you must provide your API token: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] ---- @@ -382,7 +382,7 @@ You should also configure one or more tags to identify the data source to which [[actuator.metrics.export.influx]] ==== Influx -By default, metrics are exported to an {micrometer-registry-docs}/influx[Influx] v1 instance running on your local machine with the default configuration. +By default, metrics are exported to an {micrometer-implementation-docs}/influx[Influx] v1 instance running on your local machine with the default configuration. To export metrics to InfluxDB v2, configure the `org`, `bucket`, and authentication `token` for writing metrics. You can provide the location of the https://www.influxdata.com[Influx server] to use by using: @@ -399,7 +399,7 @@ You can provide the location of the https://www.influxdata.com[Influx server] to [[actuator.metrics.export.jmx]] ==== JMX -Micrometer provides a hierarchical mapping to {micrometer-registry-docs}/jmx[JMX], primarily as a cheap and portable way to view metrics locally. +Micrometer provides a hierarchical mapping to {micrometer-implementation-docs}/jmx[JMX], primarily as a cheap and portable way to view metrics locally. By default, metrics are exported to the `metrics` JMX domain. You can provide the domain to use by using: @@ -412,7 +412,7 @@ You can provide the domain to use by using: domain: "com.example.app.metrics" ---- -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]. +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]. [TIP] ==== @@ -426,7 +426,7 @@ include::code:MyJmxConfiguration[] [[actuator.metrics.export.kairos]] ==== KairosDB -By default, metrics are exported to {micrometer-registry-docs}/kairos[KairosDB] running on your local machine. +By default, metrics are exported to {micrometer-implementation-docs}/kairos[KairosDB] running on your local machine. You can provide the location of the https://kairosdb.github.io/[KairosDB server] to use by using: [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] [[actuator.metrics.export.newrelic]] ==== New Relic -A New Relic registry periodically pushes metrics to {micrometer-registry-docs}/new-relic[New Relic]. +A New Relic registry periodically pushes metrics to {micrometer-implementation-docs}/new-relic[New Relic]. To export metrics to https://newrelic.com[New Relic], you must provide your API key and account ID: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] @@ -483,7 +483,7 @@ Finally, you can take full control by defining your own `NewRelicClientProvider` [[actuator.metrics.export.otlp]] ==== OpenTelemetry -By default, metrics are exported to {micrometer-registry-docs}/otlp[OpenTelemetry] running on your local machine. +By default, metrics are exported to {micrometer-implementation-docs}/otlp[OpenTelemetry] running on your local machine. You can provide the location of the https://opentelemetry.io/[OpenTelemetry metric endpoint] to use by using: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] @@ -499,7 +499,7 @@ You can provide the location of the https://opentelemetry.io/[OpenTelemetry metr [[actuator.metrics.export.prometheus]] ==== Prometheus -{micrometer-registry-docs}/prometheus[Prometheus] expects to scrape or poll individual application instances for metrics. +{micrometer-implementation-docs}/prometheus[Prometheus] expects to scrape or poll individual application instances for metrics. Spring Boot provides an actuator endpoint at `/actuator/prometheus` to present a https://prometheus.io[Prometheus scrape] with the appropriate format. TIP: By default, the endpoint is not available and must be exposed. See <> for more details. @@ -541,7 +541,7 @@ For advanced configuration, you can also provide your own `PrometheusPushGateway [[actuator.metrics.export.signalfx]] ==== SignalFx -SignalFx registry periodically pushes metrics to {micrometer-registry-docs}/signalFx[SignalFx]. +SignalFx registry periodically pushes metrics to {micrometer-implementation-docs}/signalFx[SignalFx]. To export metrics to https://www.signalfx.com[SignalFx], you must provide your access token: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] @@ -588,7 +588,7 @@ You can also disable it explicitly: [[actuator.metrics.export.stackdriver]] ==== Stackdriver The Stackdriver registry periodically pushes metrics to https://cloud.google.com/stackdriver/[Stackdriver]. -To export metrics to SaaS {micrometer-registry-docs}/stackdriver[Stackdriver], you must provide your Google Cloud project ID: +To export metrics to SaaS {micrometer-implementation-docs}/stackdriver[Stackdriver], you must provide your Google Cloud project ID: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] ---- @@ -615,7 +615,7 @@ You can also change the interval at which metrics are sent to Stackdriver: [[actuator.metrics.export.statsd]] ==== StatsD The StatsD registry eagerly pushes metrics over UDP to a StatsD agent. -By default, metrics are exported to a {micrometer-registry-docs}/statsD[StatsD] agent running on your local machine. +By default, metrics are exported to a {micrometer-implementation-docs}/statsD[StatsD] agent running on your local machine. You can provide the StatsD agent host, port, and protocol to use by using: [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): [[actuator.metrics.export.wavefront]] ==== Wavefront -The Wavefront registry periodically pushes metrics to {micrometer-registry-docs}/wavefront[Wavefront]. +The Wavefront registry periodically pushes metrics to {micrometer-implementation-docs}/wavefront[Wavefront]. If you are exporting metrics to https://www.wavefront.com/[Wavefront] directly, you must provide your API token: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc index 53ab08551cb..f17f32c7eef 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc @@ -108,7 +108,7 @@ :lettuce-docs: https://lettuce.io/core/{lettuce-version}/reference/index.html :micrometer-docs: https://docs.micrometer.io/micrometer/reference :micrometer-concepts-docs: {micrometer-docs}/concepts -:micrometer-registry-docs: {micrometer-docs}/registry +:micrometer-implementation-docs: {micrometer-docs}/implementations :tomcat-docs: https://tomcat.apache.org/tomcat-{tomcat-version}-doc :graal-version: 22.3 :graal-native-image-docs: https://www.graalvm.org/{graal-version}/reference-manual/native-image