From 3274205709a41ebac9c76b0353d0f673bdedc011 Mon Sep 17 00:00:00 2001 From: Wzy19930507 <1208931582@qq.com> Date: Mon, 15 Jan 2024 10:10:58 +0800 Subject: [PATCH 1/2] Use the term "tags" in documentation consistently See gh-39125 --- .../src/docs/asciidoc/actuator/observability.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/observability.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/observability.adoc index 68187d94296..2cf79a176d7 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/observability.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/observability.adoc @@ -9,7 +9,7 @@ To create your own observations (which will lead to metrics and traces), you can include::code:MyCustomObservation[] -NOTE: Low cardinality key-values will be added to metrics and traces, while high cardinality key-values will only be added to traces. +NOTE: Low cardinality tags will be added to metrics and traces, while high cardinality tags will only be added to traces. Beans of type `ObservationPredicate`, `GlobalObservationConvention`, `ObservationFilter` and `ObservationHandler` will be automatically registered on the `ObservationRegistry`. You can additionally register any number of `ObservationRegistryCustomizer` beans to further configure the registry. @@ -27,10 +27,10 @@ Read more about it https://jdbc-observations.github.io/datasource-micrometer/doc TIP: Observability for R2DBC is built into Spring Boot. To enable it, add the `io.r2dbc:r2dbc-proxy` dependency to your project. -[[actuator.observability.common-key-values]] -=== Common Key-Values -Common key-values are generally used for dimensional drill-down on the operating environment, such as host, instance, region, stack, and others. -Common key-values are applied to all observations as low cardinality key-values and can be configured, as the following example shows: +[[actuator.observability.common-tags]] +=== Common tags +Common tags are generally used for dimensional drill-down on the operating environment, such as host, instance, region, stack, and others. +Common tags are applied to all observations as low cardinality tags and can be configured, as the following example shows: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] ---- @@ -41,7 +41,7 @@ Common key-values are applied to all observations as low cardinality key-values stack: "prod" ---- -The preceding example adds `region` and `stack` key-values to all observations with a value of `us-east-1` and `prod`, respectively. +The preceding example adds `region` and `stack` tags to all observations with a value of `us-east-1` and `prod`, respectively. [[actuator.observability.preventing-observations]] === Preventing Observations From 5a38662f5f69bce6889e4a0b94d81a4a87f56e51 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Tue, 16 Jan 2024 11:16:02 -0800 Subject: [PATCH 2/2] Polish 'Use the term "tags" in documentation consistently' See gh-39125 --- .../src/docs/asciidoc/anchor-rewrite.properties | 3 +++ 1 file changed, 3 insertions(+) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties index 783ff820a90..593f2ec75ae 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties @@ -1043,3 +1043,6 @@ features.testing.testcontainers.at-development-time=features.testcontainers.at-d features.testing.testcontainers.at-development-time.dynamic-properties=features.testcontainers.at-development-time.dynamic-properties features.testing.testcontainers.at-development-time.importing-container-declarations=features.testcontainers.at-development-time.importing-container-declarations features.testing.testcontainers.at-development-time.devtools=features.testcontainers.at-development-time.devtools + +# gh-39125 +actuator.observability.common-key-values=actuator.observability.common-tags