Skip to content

Commit 5a387a8

Browse files
izeyemhalbritter
authored andcommitted
Polish gh-40023
See gh-41208
1 parent 448089f commit 5a387a8

File tree

8 files changed

+55
-85
lines changed

8 files changed

+55
-85
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/PrometheusSimpleclientMetricsExportAutoConfiguration.java

+2-4
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@
2222
import java.util.Map;
2323

2424
import io.micrometer.core.instrument.Clock;
25-
import io.micrometer.prometheus.PrometheusConfig;
26-
import io.micrometer.prometheus.PrometheusMeterRegistry;
2725
import io.prometheus.client.CollectorRegistry;
2826
import io.prometheus.client.exemplars.DefaultExemplarSampler;
2927
import io.prometheus.client.exemplars.ExemplarSampler;
@@ -69,14 +67,14 @@
6967
before = { CompositeMeterRegistryAutoConfiguration.class, SimpleMetricsExportAutoConfiguration.class },
7068
after = { MetricsAutoConfiguration.class, PrometheusMetricsExportAutoConfiguration.class })
7169
@ConditionalOnBean(Clock.class)
72-
@ConditionalOnClass(PrometheusMeterRegistry.class)
70+
@ConditionalOnClass(io.micrometer.prometheus.PrometheusMeterRegistry.class)
7371
@ConditionalOnEnabledMetricsExport("prometheus")
7472
@EnableConfigurationProperties(PrometheusProperties.class)
7573
public class PrometheusSimpleclientMetricsExportAutoConfiguration {
7674

7775
@Bean
7876
@ConditionalOnMissingBean
79-
PrometheusConfig simpleclientPrometheusConfig(PrometheusProperties prometheusProperties) {
77+
io.micrometer.prometheus.PrometheusConfig simpleclientPrometheusConfig(PrometheusProperties prometheusProperties) {
8078
return new PrometheusSimpleclientPropertiesConfigAdapter(prometheusProperties);
8179
}
8280

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/DualPrometheusMetricsExportAutoConfigurationTests.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,8 @@ void scrapeEndpointNotAddedToManagementContextWhenNotExposed() {
192192
@Test
193193
void scrapeEndpointCanBeDisabled() {
194194
this.contextRunner.withConfiguration(AutoConfigurations.of(ManagementContextAutoConfiguration.class))
195-
.withPropertyValues("management.endpoints.web.exposure.include=prometheus")
196-
.withPropertyValues("management.endpoint.prometheus.enabled=false")
195+
.withPropertyValues("management.endpoints.web.exposure.include=prometheus",
196+
"management.endpoint.prometheus.enabled=false")
197197
.withUserConfiguration(BaseConfiguration.class)
198198
.run((context) -> assertThat(context).doesNotHaveBean(PrometheusSimpleclientScrapeEndpoint.class)
199199
.doesNotHaveBean(PrometheusScrapeEndpoint.class));

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/PrometheusMetricsExportAutoConfigurationTests.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ void scrapeEndpointNotAddedToManagementContextWhenNotExposed() {
138138
@Test
139139
void scrapeEndpointCanBeDisabled() {
140140
this.contextRunner.withConfiguration(AutoConfigurations.of(ManagementContextAutoConfiguration.class))
141-
.withPropertyValues("management.endpoints.web.exposure.include=prometheus")
142-
.withPropertyValues("management.endpoint.prometheus.enabled=false")
141+
.withPropertyValues("management.endpoints.web.exposure.include=prometheus",
142+
"management.endpoint.prometheus.enabled=false")
143143
.withUserConfiguration(BaseConfiguration.class)
144144
.run((context) -> assertThat(context).doesNotHaveBean(PrometheusScrapeEndpoint.class));
145145
}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/PrometheusSimpleclientMetricsExportAutoConfigurationTests.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,8 @@ void scrapeEndpointNotAddedToManagementContextWhenNotExposed() {
165165
@Test
166166
void scrapeEndpointCanBeDisabled() {
167167
this.contextRunner.withConfiguration(AutoConfigurations.of(ManagementContextAutoConfiguration.class))
168-
.withPropertyValues("management.endpoints.web.exposure.include=prometheus")
169-
.withPropertyValues("management.endpoint.prometheus.enabled=false")
168+
.withPropertyValues("management.endpoints.web.exposure.include=prometheus",
169+
"management.endpoint.prometheus.enabled=false")
170170
.withUserConfiguration(BaseConfiguration.class)
171171
.run((context) -> assertThat(context).doesNotHaveBean(PrometheusSimpleclientScrapeEndpoint.class));
172172
}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/prometheus/LazyTracingSpanContextTests.java

+11-11
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,21 @@ public Tracer getIfUnique() throws BeansException {
6262

6363
};
6464

65-
private final LazyTracingSpanContext spanContextSupplier = new LazyTracingSpanContext(this.objectProvider);
65+
private final LazyTracingSpanContext spanContext = new LazyTracingSpanContext(this.objectProvider);
6666

6767
@Test
6868
void whenCurrentSpanIsNullThenSpanIdIsNull() {
69-
assertThat(this.spanContextSupplier.getCurrentSpanId()).isNull();
69+
assertThat(this.spanContext.getCurrentSpanId()).isNull();
7070
}
7171

7272
@Test
7373
void whenCurrentSpanIsNullThenTraceIdIsNull() {
74-
assertThat(this.spanContextSupplier.getCurrentTraceId()).isNull();
74+
assertThat(this.spanContext.getCurrentTraceId()).isNull();
7575
}
7676

7777
@Test
7878
void whenCurrentSpanIsNullThenSampledIsFalse() {
79-
assertThat(this.spanContextSupplier.isCurrentSpanSampled()).isFalse();
79+
assertThat(this.spanContext.isCurrentSpanSampled()).isFalse();
8080
}
8181

8282
@Test
@@ -86,7 +86,7 @@ void whenCurrentSpanHasSpanIdThenSpanIdIsFromSpan() {
8686
TraceContext traceContext = mock(TraceContext.class);
8787
given(traceContext.spanId()).willReturn("span-id");
8888
given(span.context()).willReturn(traceContext);
89-
assertThat(this.spanContextSupplier.getCurrentSpanId()).isEqualTo("span-id");
89+
assertThat(this.spanContext.getCurrentSpanId()).isEqualTo("span-id");
9090
}
9191

9292
@Test
@@ -96,7 +96,7 @@ void whenCurrentSpanHasTraceIdThenTraceIdIsFromSpan() {
9696
TraceContext traceContext = mock(TraceContext.class);
9797
given(traceContext.traceId()).willReturn("trace-id");
9898
given(span.context()).willReturn(traceContext);
99-
assertThat(this.spanContextSupplier.getCurrentTraceId()).isEqualTo("trace-id");
99+
assertThat(this.spanContext.getCurrentTraceId()).isEqualTo("trace-id");
100100
}
101101

102102
@Test
@@ -105,7 +105,7 @@ void whenCurrentSpanHasNoSpanIdThenSpanIdIsNull() {
105105
given(this.tracer.currentSpan()).willReturn(span);
106106
TraceContext traceContext = mock(TraceContext.class);
107107
given(span.context()).willReturn(traceContext);
108-
assertThat(this.spanContextSupplier.getCurrentSpanId()).isNull();
108+
assertThat(this.spanContext.getCurrentSpanId()).isNull();
109109
}
110110

111111
@Test
@@ -114,7 +114,7 @@ void whenCurrentSpanHasNoTraceIdThenTraceIdIsNull() {
114114
given(this.tracer.currentSpan()).willReturn(span);
115115
TraceContext traceContext = mock(TraceContext.class);
116116
given(span.context()).willReturn(traceContext);
117-
assertThat(this.spanContextSupplier.getCurrentTraceId()).isNull();
117+
assertThat(this.spanContext.getCurrentTraceId()).isNull();
118118
}
119119

120120
@Test
@@ -124,7 +124,7 @@ void whenCurrentSpanIsSampledThenSampledIsTrue() {
124124
TraceContext traceContext = mock(TraceContext.class);
125125
given(traceContext.sampled()).willReturn(true);
126126
given(span.context()).willReturn(traceContext);
127-
assertThat(this.spanContextSupplier.isCurrentSpanSampled()).isTrue();
127+
assertThat(this.spanContext.isCurrentSpanSampled()).isTrue();
128128
}
129129

130130
@Test
@@ -134,7 +134,7 @@ void whenCurrentSpanIsNotSampledThenSampledIsFalse() {
134134
TraceContext traceContext = mock(TraceContext.class);
135135
given(traceContext.sampled()).willReturn(false);
136136
given(span.context()).willReturn(traceContext);
137-
assertThat(this.spanContextSupplier.isCurrentSpanSampled()).isFalse();
137+
assertThat(this.spanContext.isCurrentSpanSampled()).isFalse();
138138
}
139139

140140
@Test
@@ -144,7 +144,7 @@ void whenCurrentSpanHasDeferredSamplingThenSampledIsFalse() {
144144
TraceContext traceContext = mock(TraceContext.class);
145145
given(traceContext.sampled()).willReturn(null);
146146
given(span.context()).willReturn(traceContext);
147-
assertThat(this.spanContextSupplier.isCurrentSpanSampled()).isFalse();
147+
assertThat(this.spanContext.isCurrentSpanSampled()).isFalse();
148148
}
149149

150150
}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/prometheus/PrometheusExemplarsAutoConfigurationTests.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ void shouldSupplyCustomBeans() {
8080
this.contextRunner.withUserConfiguration(CustomConfiguration.class)
8181
.run((context) -> assertThat(context).hasSingleBean(SpanContext.class)
8282
.getBean(SpanContext.class)
83-
.isSameAs(CustomConfiguration.SUPPLIER));
83+
.isSameAs(CustomConfiguration.SPAN_CONTEXT));
8484
}
8585

8686
@Test
@@ -145,11 +145,11 @@ void prometheusOpenMetricsOutputShouldContainExemplars() {
145145
@Configuration(proxyBeanMethods = false)
146146
private static final class CustomConfiguration {
147147

148-
static final SpanContext SUPPLIER = mock(SpanContext.class);
148+
static final SpanContext SPAN_CONTEXT = mock(SpanContext.class);
149149

150150
@Bean
151151
SpanContext customSpanContext() {
152-
return SUPPLIER;
152+
return SPAN_CONTEXT;
153153
}
154154

155155
}

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/export/prometheus/SecondCustomPrometheusScrapeEndpointIntegrationTests.java

+31-59
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,14 @@ class SecondCustomPrometheusScrapeEndpointIntegrationTests {
4747

4848
@WebEndpointTest
4949
void scrapeHasContentTypeText004ByDefault(WebTestClient client) {
50+
scrapeHasContentTypeText004ByDefault(client, "/actuator/prometheus");
51+
scrapeHasContentTypeText004ByDefault(client, "/actuator/prometheussc");
52+
}
53+
54+
private void scrapeHasContentTypeText004ByDefault(WebTestClient client, String uri) {
5055
String expectedContentType = PrometheusTextFormatWriter.CONTENT_TYPE;
5156
client.get()
52-
.uri("/actuator/prometheus")
53-
.exchange()
54-
.expectStatus()
55-
.isOk()
56-
.expectHeader()
57-
.contentType(MediaType.parseMediaType(expectedContentType))
58-
.expectBody(String.class)
59-
.value((body) -> assertThat(body).contains("counter1_total")
60-
.contains("counter2_total")
61-
.contains("counter3_total"));
62-
client.get()
63-
.uri("/actuator/prometheussc")
57+
.uri(uri)
6458
.exchange()
6559
.expectStatus()
6660
.isOk()
@@ -74,22 +68,16 @@ void scrapeHasContentTypeText004ByDefault(WebTestClient client) {
7468

7569
@WebEndpointTest
7670
void scrapeHasContentTypeText004ByDefaultWhenClientAcceptsWildcardWithParameter(WebTestClient client) {
71+
scrapeHasContentTypeText004ByDefaultWhenClientAcceptsWildcardWithParameter(client, "/actuator/prometheus");
72+
scrapeHasContentTypeText004ByDefaultWhenClientAcceptsWildcardWithParameter(client, "/actuator/prometheussc");
73+
}
74+
75+
private void scrapeHasContentTypeText004ByDefaultWhenClientAcceptsWildcardWithParameter(WebTestClient client,
76+
String uri) {
7777
String expectedContentType = PrometheusTextFormatWriter.CONTENT_TYPE;
7878
String accept = "*/*;q=0.8";
7979
client.get()
80-
.uri("/actuator/prometheus")
81-
.accept(MediaType.parseMediaType(accept))
82-
.exchange()
83-
.expectStatus()
84-
.isOk()
85-
.expectHeader()
86-
.contentType(MediaType.parseMediaType(expectedContentType))
87-
.expectBody(String.class)
88-
.value((body) -> assertThat(body).contains("counter1_total")
89-
.contains("counter2_total")
90-
.contains("counter3_total"));
91-
client.get()
92-
.uri("/actuator/prometheussc")
80+
.uri(uri)
9381
.accept(MediaType.parseMediaType(accept))
9482
.exchange()
9583
.expectStatus()
@@ -104,21 +92,14 @@ void scrapeHasContentTypeText004ByDefaultWhenClientAcceptsWildcardWithParameter(
10492

10593
@WebEndpointTest
10694
void scrapeCanProduceOpenMetrics100(WebTestClient client) {
95+
scrapeCanProduceOpenMetrics100(client, "/actuator/prometheus");
96+
scrapeCanProduceOpenMetrics100(client, "/actuator/prometheussc");
97+
}
98+
99+
private void scrapeCanProduceOpenMetrics100(WebTestClient client, String uri) {
107100
MediaType openMetrics = MediaType.parseMediaType(OpenMetricsTextFormatWriter.CONTENT_TYPE);
108101
client.get()
109-
.uri("/actuator/prometheus")
110-
.accept(openMetrics)
111-
.exchange()
112-
.expectStatus()
113-
.isOk()
114-
.expectHeader()
115-
.contentType(openMetrics)
116-
.expectBody(String.class)
117-
.value((body) -> assertThat(body).contains("counter1_total")
118-
.contains("counter2_total")
119-
.contains("counter3_total"));
120-
client.get()
121-
.uri("/actuator/prometheussc")
102+
.uri(uri)
122103
.accept(openMetrics)
123104
.exchange()
124105
.expectStatus()
@@ -133,18 +114,15 @@ void scrapeCanProduceOpenMetrics100(WebTestClient client) {
133114

134115
@WebEndpointTest
135116
void scrapePrefersToProduceOpenMetrics100(WebTestClient client) {
117+
scrapePrefersToProduceOpenMetrics100(client, "/actuator/prometheus");
118+
scrapePrefersToProduceOpenMetrics100(client, "/actuator/prometheussc");
119+
}
120+
121+
private void scrapePrefersToProduceOpenMetrics100(WebTestClient client, String uri) {
136122
MediaType openMetrics = MediaType.parseMediaType(OpenMetricsTextFormatWriter.CONTENT_TYPE);
137123
MediaType textPlain = MediaType.parseMediaType(PrometheusTextFormatWriter.CONTENT_TYPE);
138124
client.get()
139-
.uri("/actuator/prometheus")
140-
.accept(openMetrics, textPlain)
141-
.exchange()
142-
.expectStatus()
143-
.isOk()
144-
.expectHeader()
145-
.contentType(openMetrics);
146-
client.get()
147-
.uri("/actuator/prometheussc")
125+
.uri(uri)
148126
.accept(openMetrics, textPlain)
149127
.exchange()
150128
.expectStatus()
@@ -155,19 +133,13 @@ void scrapePrefersToProduceOpenMetrics100(WebTestClient client) {
155133

156134
@WebEndpointTest
157135
void scrapeWithIncludedNames(WebTestClient client) {
136+
scrapeWithIncludedNames(client, "/actuator/prometheus?includedNames=counter1,counter2");
137+
scrapeWithIncludedNames(client, "/actuator/prometheussc?includedNames=counter1_total,counter2_total");
138+
}
139+
140+
private void scrapeWithIncludedNames(WebTestClient client, String uri) {
158141
client.get()
159-
.uri("/actuator/prometheus?includedNames=counter1,counter2")
160-
.exchange()
161-
.expectStatus()
162-
.isOk()
163-
.expectHeader()
164-
.contentType(MediaType.parseMediaType(PrometheusTextFormatWriter.CONTENT_TYPE))
165-
.expectBody(String.class)
166-
.value((body) -> assertThat(body).contains("counter1_total")
167-
.contains("counter2_total")
168-
.doesNotContain("counter3_total"));
169-
client.get()
170-
.uri("/actuator/prometheussc?includedNames=counter1_total,counter2_total")
142+
.uri(uri)
171143
.exchange()
172144
.expectStatus()
173145
.isOk()

spring-boot-project/spring-boot-dependencies/build.gradle

+2-2
Original file line numberDiff line numberDiff line change
@@ -1492,12 +1492,12 @@ bom {
14921492
library("Prometheus Client", "1.2.1") {
14931493
group("io.prometheus") {
14941494
imports = [
1495-
"prometheus-metrics-bom"
1495+
"prometheus-metrics-bom"
14961496
]
14971497
}
14981498
links {
14991499
site("https://github.com/prometheus/client_java")
1500-
releaseNotes("https://github.com/prometheus/client_java/releases/tag/parent-{version}")
1500+
releaseNotes("https://github.com/prometheus/client_java/releases/tag/v{version}")
15011501
}
15021502
}
15031503
library("Prometheus Simpleclient", "0.16.0") {

0 commit comments

Comments
 (0)