Skip to content

Commit d22986b

Browse files
committed
Merge remote-tracking branch 'origin/main'
2 parents 394a268 + c0f3a61 commit d22986b

File tree

24 files changed

+230
-63
lines changed

24 files changed

+230
-63
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ given the ability to merge pull requests.
1717

1818
## Code of Conduct
1919
This project adheres to the Contributor Covenant [code of
20-
conduct](https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/src/main/asciidoc/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report
20+
conduct](https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/modules/ROOT/partials/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report
2121
unacceptable behavior to spring-code-of-conduct@pivotal.io.
2222

2323
## Code Conventions and Housekeeping

.github/workflows/maven.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
- name: Build with Maven
3232
run: ./mvnw -s .settings.xml clean org.jacoco:jacoco-maven-plugin:prepare-agent install -U -P sonar -nsu --batch-mode -Dmaven.test.redirectTestOutputToFile=true -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn
3333
- name: Publish Test Report
34-
uses: mikepenz/action-junit-report@v4
34+
uses: mikepenz/action-junit-report@v5
3535
if: always() # always run even if the previous step fails
3636
with:
3737
report_paths: '**/surefire-reports/TEST-*.xml'

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ given the ability to merge pull requests.
121121

122122
[[code-of-conduct]]
123123
== Code of Conduct
124-
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/src/main/asciidoc/code-of-conduct.adoc[code of
124+
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/modules/ROOT/partials/code-of-conduct.adoc[code of
125125
conduct]. By participating, you are expected to uphold this code. Please report
126-
unacceptable behavior to spring-code-of-conduct@pivotal.io.
126+
unacceptable behavior to code-of-conduct@spring.io.
127127

128128
[[code-conventions-and-housekeeping]]
129129
== Code Conventions and Housekeeping

docs/antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav:
66
ext:
77
collector:
88
run:
9-
command: ./mvnw --no-transfer-progress -B process-resources -Pdocs -pl docs -Dantora-maven-plugin.phase=none -Dgenerate-docs.phase=none -Dgenerate-readme.phase=none -Dgenerate-cloud-resources.phase=none -Dmaven-dependency-plugin-for-docs.phase=none -Dmaven-dependency-plugin-for-docs-classes.phase=none -DskipTests
9+
command: ./mvnw --no-transfer-progress -B process-resources -Pdocs -pl docs -Dantora-maven-plugin.phase=none -Dgenerate-docs.phase=none -Dgenerate-readme.phase=none -Dgenerate-cloud-resources.phase=none -Dmaven-dependency-plugin-for-docs.phase=none -Dmaven-dependency-plugin-for-docs-classes.phase=none -DskipTests -DdisableConfigurationProperties
1010
local: true
1111
scan:
1212
dir: ./target/classes/antora-resources/

docs/modules/ROOT/pages/spring-cloud-commons/loadbalancer.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,12 @@ set the value of the `spring.cloud.loadbalancer.stats.micrometer.enabled` to `tr
506506

507507
Additional information regarding the service instances, request data, and response data is added to metrics via tags whenever available.
508508

509+
NOTE: For `WebClient` and `RestClient`-backed load-balancing, we use `uriTemplate` for the `uri` tag whenever available.
510+
511+
TIP: It is possible to disable adding `path` to `uri` tag by setting `spring.cloud.loadbalancer.stats.include-path` to `false`.
512+
513+
WARNING: As with `RestTemplate`-backed load-balancing, we don't have access to `uriTemplate`, full path is always used in the `uri` tag. In order to avoid high cardinality issues, if path is a high cardinality value (for example, `/orders/\{id\}`, where `id` takes a big number of values), it is strongly recommended to disable adding path to `uri` tag by setting `spring.cloud.loadbalancer.stats.include-path` to `false`.
514+
509515
NOTE: For some implementations, such as `BlockingLoadBalancerClient`, request and response data might not be available, as we establish generic types from arguments and might not be able to determine the types and read the data.
510516

511517
NOTE: The meters are registered in the registry when at least one record is added for a given meter.

docs/modules/ROOT/partials/_configprops.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
|spring.cloud.loadbalancer.retry.retryable-exceptions | `+++{}+++` | A `Set` of `Throwable` classes that should trigger a retry.
6767
|spring.cloud.loadbalancer.retry.retryable-status-codes | `+++{}+++` | A `Set` of status codes that should trigger a retry.
6868
|spring.cloud.loadbalancer.service-discovery.timeout | | String representation of Duration of the timeout for calls to service discovery.
69+
|spring.cloud.loadbalancer.stats.include-path | `+++true+++` | Indicates whether the {@code path} should be added to {@code uri} tag in metrics. When {@link RestTemplate} is used to execute load-balanced requests with high cardinality paths, setting it to {@code false} is recommended.
6970
|spring.cloud.loadbalancer.stats.micrometer.enabled | `+++false+++` | Enables Spring Cloud LoadBalancer Micrometer stats.
7071
|spring.cloud.loadbalancer.sticky-session.add-service-instance-cookie | `+++false+++` | Indicates whether a cookie with the newly selected instance should be added by LoadBalancer.
7172
|spring.cloud.loadbalancer.sticky-session.instance-id-cookie-name | `+++sc-lb-instance-id+++` | The name of the cookie holding the preferred instance id.

docs/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"dependencies": {
3-
"antora": "3.2.0-alpha.6",
3+
"antora": "3.2.0-alpha.8",
44
"@antora/atlas-extension": "1.0.0-alpha.2",
5-
"@antora/collector-extension": "1.0.0-beta.3",
5+
"@antora/collector-extension": "1.0.1",
66
"@asciidoctor/tabs": "1.0.0-beta.6",
77
"@springio/antora-extensions": "1.14.2",
88
"@springio/asciidoctor-extensions": "1.0.0-alpha.14"

docs/pom.xml

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<parent>
99
<groupId>org.springframework.cloud</groupId>
1010
<artifactId>spring-cloud-commons-parent</artifactId>
11-
<version>4.2.0-SNAPSHOT</version>
11+
<version>4.2.1-SNAPSHOT</version>
1212
</parent>
1313
<packaging>jar</packaging>
1414
<name>Spring Cloud Commons Docs</name>
@@ -26,20 +26,28 @@
2626
<micrometer-docs-generator.inclusionPattern>.*</micrometer-docs-generator.inclusionPattern>
2727
<micrometer-docs-generator.outputPath>${maven.multiModuleProjectDirectory}/docs/modules/ROOT/partials/</micrometer-docs-generator.outputPath>
2828
</properties>
29-
<dependencies>
30-
<dependency>
31-
<groupId>${project.groupId}</groupId>
32-
<artifactId>spring-cloud-starter</artifactId>
33-
</dependency>
34-
<dependency>
35-
<groupId>${project.groupId}</groupId>
36-
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
37-
</dependency>
38-
</dependencies>
3929
<build>
4030
<sourceDirectory>src/main/asciidoc</sourceDirectory>
4131
</build>
4232
<profiles>
33+
<profile>
34+
<id>enable-configuration-properties</id>
35+
<activation>
36+
<property>
37+
<name>!disableConfigurationProperties</name>
38+
</property>
39+
</activation>
40+
<dependencies>
41+
<dependency>
42+
<groupId>${project.groupId}</groupId>
43+
<artifactId>spring-cloud-starter</artifactId>
44+
</dependency>
45+
<dependency>
46+
<groupId>${project.groupId}</groupId>
47+
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
48+
</dependency>
49+
</dependencies>
50+
</profile>
4351
<profile>
4452
<id>docs</id>
4553
<build>

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
<modelVersion>4.0.0</modelVersion>
66
<groupId>org.springframework.cloud</groupId>
77
<artifactId>spring-cloud-commons-parent</artifactId>
8-
<version>4.2.0-SNAPSHOT</version>
8+
<version>4.2.1-SNAPSHOT</version>
99
<packaging>pom</packaging>
1010
<name>Spring Cloud Commons Parent</name>
1111
<description>Spring Cloud Commons Parent</description>
1212
<url>https://projects.spring.io/spring-cloud/</url>
1313
<parent>
1414
<groupId>org.springframework.cloud</groupId>
1515
<artifactId>spring-cloud-build</artifactId>
16-
<version>4.2.0-SNAPSHOT</version>
16+
<version>4.2.1-SNAPSHOT</version>
1717
<relativePath/> <!-- lookup parent from repository -->
1818
</parent>
1919
<scm>

spring-cloud-commons-dependencies/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<parent>
77
<artifactId>spring-cloud-dependencies-parent</artifactId>
88
<groupId>org.springframework.cloud</groupId>
9-
<version>4.2.0-SNAPSHOT</version>
9+
<version>4.2.1-SNAPSHOT</version>
1010
<relativePath/>
1111
</parent>
1212
<artifactId>spring-cloud-commons-dependencies</artifactId>
13-
<version>4.2.0-SNAPSHOT</version>
13+
<version>4.2.1-SNAPSHOT</version>
1414
<packaging>pom</packaging>
1515
<name>spring-cloud-commons-dependencies</name>
1616
<description>Spring Cloud Commons Dependencies</description>

0 commit comments

Comments
 (0)