Add a new module supporting jaeger - opentracing

pom.xml

@@ -79,13 +79,15 @@
 		<module>spring-cloud-kubernetes-discovery</module>
 		<module>spring-cloud-kubernetes-ribbon</module>
 		<module>spring-cloud-kubernetes-zipkin</module>
+		<module>spring-cloud-kubernetes-jaeger</module>
 		<module>spring-cloud-kubernetes-hystrix</module>
 		<module>spring-cloud-kubernetes-archaius</module>
 		<module>spring-cloud-starter-kubernetes</module>
 		<module>spring-cloud-starter-kubernetes-config</module>
 		<module>spring-cloud-starter-kubernetes-netflix</module>
 		<module>spring-cloud-starter-kubernetes-zipkin</module>
 		<module>spring-cloud-starter-kubernetes-all</module>
+		<module>spring-cloud-starter-kubernetes-jaeger</module>
 		<module>spring-cloud-kubernetes-examples</module>
 	</modules>
 

spring-cloud-kubernetes-dependencies/pom.xml

@@ -20,6 +20,9 @@
 		<mockwebserver.version>0.0.12</mockwebserver.version>
 		<restassured.version>3.0.2</restassured.version>
 		<spock-spring.version>1.0-groovy-2.3</spock-spring.version>
+		<version.jaeger>0.19.0</version.jaeger>
+		<io.opentracing.version>0.22.0</io.opentracing.version>
+		<io.opentracing.contrib.spring.autoconfigure.version>0.0.4</io.opentracing.contrib.spring.autoconfigure.version>
 	</properties>
 	<dependencyManagement>
 		<dependencies>
@@ -74,6 +77,11 @@
 				<version>${project.version}</version>
 			</dependency>
 
+			<dependency>
+				<groupId>org.springframework.cloud</groupId>
+				<artifactId>spring-cloud-kubernetes-jaeger</artifactId>
+				<version>${project.version}</version>
+			</dependency>
 
 			<!-- Own dependencies - Starters -->
 			<dependency>
@@ -106,6 +114,27 @@
 				<version>${project.version}</version>
 			</dependency>
 
+			<!-- OpenTracing -->
+			<dependency>
+				<groupId>io.opentracing</groupId>
+				<artifactId>opentracing-noop</artifactId>
+				<version>${io.opentracing.version}</version>
+			</dependency>
+
+			<dependency>
+				<groupId>io.opentracing.contrib</groupId>
+				<artifactId>opentracing-spring-web-autoconfigure</artifactId>
+				<version>${io.opentracing.contrib.spring.autoconfigure.version}</version>
+			</dependency>
+
+			<!-- OpenTracing implementation - Jaeger -->
+			<dependency>
+				<groupId>com.uber.jaeger</groupId>
+				<artifactId>jaeger-core</artifactId>
+				<version>${version.jaeger}</version>
+			</dependency>
+
+
 			<!-- Testing Dependencies -->
 			<dependency>
 				<groupId>org.jboss.arquillian.junit</groupId>
@@ -159,6 +188,8 @@
 				<artifactId>spock-spring</artifactId>
 				<version>${spock-spring.version}</version>
 			</dependency>
+
+
 		</dependencies>
 	</dependencyManagement>
 	<profiles>

spring-cloud-kubernetes-jaeger/pom.xml

@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (C) 2016 to the original 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
+
+          http://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.
+
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<parent>
+		<artifactId>spring-cloud-kubernetes</artifactId>
+		<groupId>org.springframework.cloud</groupId>
+		<version>0.2.0.BUILD-SNAPSHOT</version>
+	</parent>
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>org.springframework.cloud</groupId>
+	<artifactId>spring-cloud-kubernetes-jaeger</artifactId>
+	<name>Spring Cloud Kubernetes :: Jaeger</name>
+
+	<dependencies>
+
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-kubernetes-discovery</artifactId>
+			<version>${project.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-autoconfigure</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-logging</artifactId>
+			<optional>true</optional>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-commons</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-context</artifactId>
+			<optional>true</optional>
+		</dependency>
+
+		<!-- OpenTracing -->
+		<dependency>
+			<groupId>io.opentracing</groupId>
+			<artifactId>opentracing-noop</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>io.opentracing.contrib</groupId>
+			<artifactId>opentracing-spring-web-autoconfigure</artifactId>
+		</dependency>
+
+		<!-- OpenTracing implementation - Jaeger -->
+		<dependency>
+			<groupId>com.uber.jaeger</groupId>
+			<artifactId>jaeger-core</artifactId>
+		</dependency>
+
+
+	</dependencies>
+
+</project>

spring-cloud-kubernetes-jaeger/src/main/java/org/springframework/cloud/kubernetes/jaeger/JaegerKubernetesAutoConfiguration.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright (C) 2016 to the original 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
+ *
+ *         http://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.cloud.kubernetes.jaeger;
+
+import java.net.URL;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import com.uber.jaeger.metrics.Metrics;
+import com.uber.jaeger.metrics.NullStatsReporter;
+import com.uber.jaeger.metrics.StatsFactoryImpl;
+import com.uber.jaeger.reporters.RemoteReporter;
+import com.uber.jaeger.samplers.ProbabilisticSampler;
+import com.uber.jaeger.senders.Sender;
+import com.uber.jaeger.senders.UdpSender;
+import io.fabric8.kubernetes.api.model.Endpoints;
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.utils.Utils;
+import io.opentracing.NoopTracerFactory;
+import io.opentracing.Tracer;
+import io.opentracing.contrib.spring.web.autoconfig.TracerAutoConfiguration;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.cloud.client.ServiceInstance;
+import org.springframework.cloud.kubernetes.discovery.KubernetesServiceInstance;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.util.Assert;
+
+@Configuration
+@AutoConfigureBefore(TracerAutoConfiguration.class)
+@EnableConfigurationProperties(KubernetesJaegerDiscoveryProperties.class)
+public class JaegerKubernetesAutoConfiguration {
+
+	private static final Log LOG = LogFactory.getLog(JaegerKubernetesAutoConfiguration.class);
+
+    @Bean
+    public Tracer tracer(KubernetesClient client, KubernetesJaegerDiscoveryProperties discoveryProperties) throws Exception {
+
+    	String serviceName = discoveryProperties.getServiceName();
+    	String traceServerName = discoveryProperties.getTracerServerName();
+		String serviceNamespace = Utils.isNotNullOrEmpty(discoveryProperties.getServiceNamespace()) ? discoveryProperties.getServiceNamespace() : client.getNamespace();
+
+        List<ServiceInstance> services = getInstances(client, traceServerName, serviceNamespace);
+        String serviceUrl = services.stream()
+                .findFirst()
+                .map(s -> s.getUri().toString())
+                .orElse(null);
+
+        if (serviceUrl == null || serviceUrl.isEmpty()) {
+			LOG.info("Jaeger k8s starter creating Noop Tracer");
+            return NoopTracerFactory.create();
+        }
+
+        return  jaegerTracer(serviceUrl, serviceName);
+    }
+
+    private static List<ServiceInstance> getInstances(KubernetesClient client, String name, String namespace) {
+        Assert.notNull(name, "[Assertion failed] - the service name must not be null");
+
+        return Optional.ofNullable(client.endpoints().inNamespace(namespace).withName(name).get())
+                .orElse(new Endpoints())
+                .getSubsets()
+                .stream()
+                .flatMap(s -> s.getAddresses().stream().map(a -> (ServiceInstance) new KubernetesServiceInstance(name, a ,s.getPorts().stream().findFirst().orElseThrow(IllegalStateException::new), false)))
+                .collect(Collectors.toList());
+    }
+
+	private Tracer jaegerTracer(String serviceURL, String serviceName) throws Exception {
+		URL url = new URL(serviceURL);
+		Sender sender = new UdpSender(url.getHost(), url.getPort(), 0);
+		return new com.uber.jaeger.Tracer.Builder(serviceName,
+			new RemoteReporter(sender, 100, 50,
+				new Metrics(new StatsFactoryImpl(new NullStatsReporter()))),
+			new ProbabilisticSampler(1.0))
+			.build();
+	}
+
+}

spring-cloud-kubernetes-jaeger/src/main/java/org/springframework/cloud/kubernetes/jaeger/KubernetesJaegerDiscoveryProperties.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2016 to the original 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
+ *
+ *         http://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.cloud.kubernetes.jaeger;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * @author <a href="mailto:[email protected]">Charles Moulliard</a>
+ */
+@ConfigurationProperties("spring.cloud.kubernetes.jaeger.discovery")
+public class KubernetesJaegerDiscoveryProperties {
+
+	private String tracerServerName = "jaeger-all-in-one";
+	private String serviceName;
+	private String serviceNamespace;
+
+	public String getServiceName() {
+		return serviceName;
+	}
+
+	public void setServiceName(String serviceName) {
+		this.serviceName = serviceName;
+	}
+
+	public String getTracerServerName() {
+		return tracerServerName;
+	}
+
+	public void setTracerServerName(String tracerServerName) {
+		this.tracerServerName = tracerServerName;
+	}
+
+	public String getServiceNamespace() {
+		return serviceNamespace;
+	}
+
+	public void setServiceNamespace(String serviceNamespace) {
+		this.serviceNamespace = serviceNamespace;
+	}
+
+}

spring-cloud-kubernetes-jaeger/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+org.springframework.cloud.kubernetes.jaeger.JaegerKubernetesAutoConfiguration

spring-cloud-starter-kubernetes-jaeger/pom.xml

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (C) 2016 to the original 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
+
+          http://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.
+
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<parent>
+		<artifactId>spring-cloud-kubernetes</artifactId>
+		<groupId>org.springframework.cloud</groupId>
+		<version>0.2.0.BUILD-SNAPSHOT</version>
+	</parent>
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>org.springframework.cloud</groupId>
+	<artifactId>spring-cloud-starter-kubernetes-jaeger</artifactId>
+	<name>Spring Cloud Kubernetes :: Starter :: Jaeger</name>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-kubernetes-core</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-kubernetes-discovery</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-kubernetes-jaeger</artifactId>
+		</dependency>
+	</dependencies>
+
+</project>