root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Fix broken content negotiation for Prometheus with OpenMetrics 

Update Prometheus `TextOutputFormat` so that OpenMetrics is used in
preference to text output when an appropriate accept header is found.

If the accept header contains `*/*` or is missing then the text format
will be used.

See gh-28130
This commit is contained in:
Andy Wilkinson 2021-10-04 20:10:46 +01:00
parent d8141e6a8d
commit 437a1601ef
2 changed files with 25 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/export/prometheus/TextOutputFormat.java
View File

@ -35,18 +35,6 @@ import org.springframework.util.MimeTypeUtils;
*/ */
public enum TextOutputFormat implements Producible<TextOutputFormat> { public enum TextOutputFormat implements Producible<TextOutputFormat> {
/**
* OpenMetrics text version 1.0.0.
*/
CONTENT_TYPE_OPENMETRICS_100(TextFormat.CONTENT_TYPE_OPENMETRICS_100) {
@Override
void write(Writer writer, Enumeration<MetricFamilySamples> samples) throws IOException {
TextFormat.writeOpenMetrics100(writer, samples);
}
},
/** /**
* Prometheus text version 0.0.4. * Prometheus text version 0.0.4.
*/ */
@ -57,6 +45,23 @@ public enum TextOutputFormat implements Producible<TextOutputFormat> {
TextFormat.write004(writer, samples); TextFormat.write004(writer, samples);
} }
@Override
public boolean isDefault() {
return true;
}
},
/**
* OpenMetrics text version 1.0.0.
*/
CONTENT_TYPE_OPENMETRICS_100(TextFormat.CONTENT_TYPE_OPENMETRICS_100) {
@Override
void write(Writer writer, Enumeration<MetricFamilySamples> samples) throws IOException {
TextFormat.writeOpenMetrics100(writer, samples);
}
}; };
private final MimeType mimeType; private final MimeType mimeType;

8
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/export/prometheus/PrometheusScrapeEndpointIntegrationTests.java
View File

@ -55,6 +55,14 @@ class PrometheusScrapeEndpointIntegrationTests {
.contains("counter1_total").contains("counter2_total").contains("counter3_total")); .contains("counter1_total").contains("counter2_total").contains("counter3_total"));
} }
@WebEndpointTest
void scrapePrefersToProduceOpenMetrics100(WebTestClient client) {
MediaType openMetrics = MediaType.parseMediaType(TextFormat.CONTENT_TYPE_OPENMETRICS_100);
MediaType textPlain = MediaType.parseMediaType(TextFormat.CONTENT_TYPE_004);
client.get().uri("/actuator/prometheus").accept(openMetrics, textPlain).exchange().expectStatus().isOk()
.expectHeader().contentType(openMetrics);
}
@WebEndpointTest @WebEndpointTest
void scrapeWithIncludedNames(WebTestClient client) { void scrapeWithIncludedNames(WebTestClient client) {
client.get().uri("/actuator/prometheus?includedNames=counter1_total,counter2_total").exchange().expectStatus() client.get().uri("/actuator/prometheus?includedNames=counter1_total,counter2_total").exchange().expectStatus()