Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-07-05 00:56:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Polish "Add auto-configuration for OTLP gRPC format when using tracing"

Browse Source 
See gh-41213
This commit is contained in:
Moritz Halbritter 2024-07-04 09:53:30 +02:00
parent 6b50d6783b
commit abf923ee9a
4 changed files with 23 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/otlp/OtlpProperties.java
View File

@ -45,7 +45,7 @@ public class OtlpProperties {
private Duration timeout = Duration.ofSeconds(10);
/**
* Transport used to send the spans. Defaults to HTTP.
* Transport used to send the spans.
*/
private Transport transport = Transport.HTTP;
@ -99,21 +99,21 @@ public class OtlpProperties {
this.headers = headers;
}
enum Transport {
public enum Transport {
/**
* HTTP exporter.
* HTTP transport.
*/
HTTP,
/**
* gRPC exporter.
* gRPC transport.
*/
GRPC
}
enum Compression {
public enum Compression {
/**
* Gzip compression.

9
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/otlp/OtlpTracingConfigurations.java
View File

@ -68,12 +68,12 @@ class OtlpTracingConfigurations {
}
@Configuration(proxyBeanMethods = false)
@ConditionalOnMissingBean({ OtlpGrpcSpanExporter.class, OtlpHttpSpanExporter.class })
@ConditionalOnBean(OtlpTracingConnectionDetails.class)
@ConditionalOnEnabledTracing("otlp")
static class Exporters {
@Bean
@ConditionalOnMissingBean({ OtlpGrpcSpanExporter.class, OtlpHttpSpanExporter.class })
@ConditionalOnBean(OtlpTracingConnectionDetails.class)
@ConditionalOnEnabledTracing("otlp")
@ConditionalOnProperty(prefix = "management.otlp.tracing", name = "transport", havingValue = "http",
matchIfMissing = true)
OtlpHttpSpanExporter otlpHttpSpanExporter(OtlpProperties properties,
@ -89,9 +89,6 @@ class OtlpTracingConfigurations {
}
@Bean
@ConditionalOnMissingBean({ OtlpGrpcSpanExporter.class, OtlpHttpSpanExporter.class })
@ConditionalOnBean(OtlpTracingConnectionDetails.class)
@ConditionalOnEnabledTracing("otlp")
@ConditionalOnProperty(prefix = "management.otlp.tracing", name = "transport", havingValue = "grpc")
OtlpGrpcSpanExporter otlpGrpcSpanExporter(OtlpProperties properties,
OtlpTracingConnectionDetails connectionDetails) {

4
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
View File

@ -2102,6 +2102,10 @@
"type": "java.lang.Boolean",
"description": "Whether auto-configuration of tracing is enabled to export OTLP traces."
},
{
"name": "management.otlp.tracing.transport",
"defaultValue": "http"
},
{
"name": "management.prometheus.metrics.export.histogram-flavor",
"defaultValue": "prometheus"

35
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/otlp/OtlpAutoConfigurationIntegrationTests.java
View File

@ -16,7 +16,6 @@
package org.springframework.boot.actuate.autoconfigure.tracing.otlp;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.BlockingQueue;
@ -53,7 +52,6 @@ import org.springframework.boot.actuate.autoconfigure.tracing.MicrometerTracingA
import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpAutoConfigurationIntegrationTests.MockGrpcServer.RecordedGrpcRequest;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.util.StreamUtils;
import static org.assertj.core.api.Assertions.assertThat;
@ -76,23 +74,15 @@ class OtlpAutoConfigurationIntegrationTests {
private final MockGrpcServer mockGrpcServer = new MockGrpcServer();
@BeforeEach
void startMockWebServer() throws IOException {
void startServers() throws Exception {
this.mockWebServer.start();
}
@BeforeEach
void startMockGrpcServer() throws Exception {
this.mockGrpcServer.start();
}
@AfterEach
void stopMockWebServer() throws IOException {
void stopServers() throws Exception {
this.mockWebServer.close();
}
@AfterEach
void stopMockGrpcServer() throws Exception {
this.mockGrpcServer.stop();
this.mockGrpcServer.close();
}
@Test
@ -142,7 +132,7 @@ class OtlpAutoConfigurationIntegrationTests {
}
@Test
void grpcSpanExporter() {
void grpcSpanExporterShouldExportSpans() {
this.contextRunner
.withPropertyValues(
"management.otlp.tracing.endpoint=http://localhost:%d".formatted(this.mockGrpcServer.getPort()),
@ -155,7 +145,7 @@ class OtlpAutoConfigurationIntegrationTests {
assertThat(request).isNotNull();
assertThat(request.headers().get("Content-Type")).isEqualTo("application/grpc");
assertThat(request.headers().get("custom")).isEqualTo("42");
assertThat(request.body()).contains("org.springframework.boot");
assertThat(request.bodyAsString()).contains("org.springframework.boot");
});
}
@ -169,7 +159,7 @@ class OtlpAutoConfigurationIntegrationTests {
this.server.start();
}
void stop() throws Exception {
void close() throws Exception {
this.server.stop();
}
@ -189,7 +179,6 @@ class OtlpAutoConfigurationIntegrationTests {
Server server = new Server();
server.addConnector(createConnector(server));
server.setHandler(new GrpcHandler());
return server;
}
@ -197,7 +186,6 @@ class OtlpAutoConfigurationIntegrationTests {
ServerConnector connector = new ServerConnector(server,
new HTTP2CServerConnectionFactory(new HttpConfiguration()));
connector.setPort(0);
return connector;
}
@ -206,21 +194,20 @@ class OtlpAutoConfigurationIntegrationTests {
@Override
public boolean handle(Request request, Response response, Callback callback) throws Exception {
try (InputStream in = Content.Source.asInputStream(request)) {
recordRequest(new RecordedGrpcRequest(request.getHeaders(),
StreamUtils.copyToString(in, StandardCharsets.UTF_8)));
recordRequest(new RecordedGrpcRequest(request.getHeaders(), in.readAllBytes()));
}
response.getHeaders().add("Content-Type", "application/grpc");
response.getHeaders().add("Grpc-Status", "0");
callback.succeeded();
return true;
}
}
record RecordedGrpcRequest(HttpFields headers, String body) {
record RecordedGrpcRequest(HttpFields headers, byte[] body) {
String bodyAsString() {
return new String(this.body, StandardCharsets.UTF_8);
}
}
}