From 17832d433d775d8a5700254ed618f290cc3f60c4 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Wed, 18 Sep 2019 12:34:41 +0200 Subject: [PATCH] Qualified string for the Zipkin localServiceName; fixes gh-1441 --- .../cloud/sleuth/LocalServiceName.java | 40 +++++++++++++++++++ .../autoconfig/TraceAutoConfiguration.java | 9 ++--- 2 files changed, 44 insertions(+), 5 deletions(-) create mode 100644 spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/LocalServiceName.java diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/LocalServiceName.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/LocalServiceName.java new file mode 100644 index 000000000..26c16148e --- /dev/null +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/LocalServiceName.java @@ -0,0 +1,40 @@ +/* + * Copyright 2013-2019 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.cloud.sleuth; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import org.springframework.beans.factory.annotation.Value; + +/** + * Injects the service name for this application. + * + * @author Marcin Grzejszczak + * @since 2.2.0 + */ +@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, + ElementType.ANNOTATION_TYPE }) +@Retention(RetentionPolicy.RUNTIME) +@Documented +@Value("${spring.zipkin.service.name:${spring.application.name:default}}") +public @interface LocalServiceName { + +} diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/autoconfig/TraceAutoConfiguration.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/autoconfig/TraceAutoConfiguration.java index 31c39abe4..b3ccd1565 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/autoconfig/TraceAutoConfiguration.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/autoconfig/TraceAutoConfiguration.java @@ -42,11 +42,11 @@ import zipkin2.reporter.Reporter; import zipkin2.reporter.ReporterMetrics; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.cloud.sleuth.DefaultSpanNamer; +import org.springframework.cloud.sleuth.LocalServiceName; import org.springframework.cloud.sleuth.SpanAdjuster; import org.springframework.cloud.sleuth.SpanNamer; import org.springframework.context.annotation.Bean; @@ -102,10 +102,9 @@ public class TraceAutoConfiguration { @Bean @ConditionalOnMissingBean // NOTE: stable bean name as might be used outside sleuth - Tracing tracing( - @Value("${spring.zipkin.service.name:${spring.application.name:default}}") String serviceName, - Propagation.Factory factory, CurrentTraceContext currentTraceContext, - Sampler sampler, ErrorParser errorParser, SleuthProperties sleuthProperties, + Tracing tracing(@LocalServiceName String serviceName, Propagation.Factory factory, + CurrentTraceContext currentTraceContext, Sampler sampler, + ErrorParser errorParser, SleuthProperties sleuthProperties, @Nullable List> spanReporters) { Tracing.Builder builder = Tracing.newBuilder().sampler(sampler) .errorParser(errorParser)