Move Zipkin Docker Compose support into spring-boot-zipkin

This commit is contained in:
Phillip Webb
2025-05-23 14:54:46 -07:00
parent 86a0d9b64d
commit 232ab3dedb
7 changed files with 9 additions and 8 deletions

View File

@@ -14,11 +14,13 @@ dependencies {
api("io.zipkin.reporter2:zipkin-reporter-brave")
optional(project(":spring-boot-project:spring-boot-autoconfigure"))
optional(project(":spring-boot-project:spring-boot-docker-compose"))
optional(project(":spring-boot-project:spring-boot-testcontainers"))
optional("io.zipkin.reporter2:zipkin-reporter-brave")
dockerTestImplementation(project(":spring-boot-project:spring-boot-test"))
dockerTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support-docker"))
dockerTestImplementation(testFixtures(project(":spring-boot-project:spring-boot-docker-compose")))
dockerTestImplementation("org.testcontainers:junit-jupiter")
testImplementation(project(":spring-boot-project:spring-boot-test"))

View File

@@ -0,0 +1,39 @@
/*
* Copyright 2012-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.zipkin.docker.compose;
import org.springframework.boot.docker.compose.service.connection.test.DockerComposeTest;
import org.springframework.boot.testsupport.container.TestImage;
import org.springframework.boot.zipkin.autoconfigure.ZipkinConnectionDetails;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for {@link ZipkinDockerComposeConnectionDetailsFactory}.
*
* @author Moritz Halbritter
* @author Andy Wilkinson
* @author Phillip Webb
*/
class ZipkinDockerComposeConnectionDetailsFactoryIntegrationTests {
@DockerComposeTest(composeFile = "zipkin-compose.yaml", image = TestImage.ZIPKIN)
void runCreatesConnectionDetails(ZipkinConnectionDetails connectionDetails) {
assertThat(connectionDetails.getSpanEndpoint()).startsWith("http://").endsWith("/api/v2/spans");
}
}

View File

@@ -0,0 +1,5 @@
services:
zipkin:
image: '{imageName}'
ports:
- '9411'

View File

@@ -0,0 +1,69 @@
/*
* Copyright 2012-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.zipkin.docker.compose;
import org.springframework.boot.docker.compose.core.RunningService;
import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory;
import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionSource;
import org.springframework.boot.zipkin.autoconfigure.ZipkinConnectionDetails;
/**
* {@link DockerComposeConnectionDetailsFactory} to create {@link ZipkinConnectionDetails}
* for a {@code zipkin} service.
*
* @author Moritz Halbritter
* @author Andy Wilkinson
* @author Phillip Webb
*/
class ZipkinDockerComposeConnectionDetailsFactory
extends DockerComposeConnectionDetailsFactory<ZipkinConnectionDetails> {
private static final int ZIPKIN_PORT = 9411;
ZipkinDockerComposeConnectionDetailsFactory() {
super("openzipkin/zipkin", "org.springframework.boot.zipkin.autoconfigure.ZipkinAutoConfiguration");
}
@Override
protected ZipkinConnectionDetails getDockerComposeConnectionDetails(DockerComposeConnectionSource source) {
return new ZipkinDockerComposeConnectionDetails(source.getRunningService());
}
/**
* {@link ZipkinConnectionDetails} backed by a {@code zipkin} {@link RunningService}.
*/
static class ZipkinDockerComposeConnectionDetails extends DockerComposeConnectionDetails
implements ZipkinConnectionDetails {
private final String host;
private final int port;
ZipkinDockerComposeConnectionDetails(RunningService source) {
super(source);
this.host = source.host();
this.port = source.ports().get(ZIPKIN_PORT);
}
@Override
public String getSpanEndpoint() {
return "http://" + this.host + ":" + this.port + "/api/v2/spans";
}
}
}

View File

@@ -0,0 +1,20 @@
/*
* Copyright 2012-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Support for Docker Compose Zipkin service connections.
*/
package org.springframework.boot.zipkin.docker.compose;

View File

@@ -1,3 +1,4 @@
# Connection Details Factories
org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
org.springframework.boot.zipkin.docker.compose.ZipkinDockerComposeConnectionDetailsFactory,\
org.springframework.boot.zipkin.testcontainers.ZipkinContainerConnectionDetailsFactory