基于spring cloud 1.2.1版本java
spring cloud的基础是spring boot,而spring boot能够零配置初始化spring。当咱们引入spring-cloud-starter-sleuth依赖的时候,会附带spring-cloud-sleuth-core依赖。spring boot扫描spring-cloud-sleuth-core依赖下的spring.factories文件,以下:web
# Auto Configuration org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.cloud.sleuth.autoconfig.TraceAutoConfiguration,\ org.springframework.cloud.sleuth.metric.TraceMetricsAutoConfiguration,\ org.springframework.cloud.sleuth.log.SleuthLogAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.messaging.TraceSpanMessagingAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.messaging.TraceSpringIntegrationAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.messaging.websocket.TraceWebSocketAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.async.AsyncCustomAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.async.AsyncDefaultAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.hystrix.SleuthHystrixAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.scheduling.TraceSchedulingAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.web.TraceHttpAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.web.TraceWebAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.web.client.TraceWebClientAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.web.client.TraceWebAsyncClientAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.web.client.feign.TraceFeignClientAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.zuul.TraceZuulAutoConfiguration,\ org.springframework.cloud.sleuth.instrument.rxjava.RxJavaAutoConfiguration,\ org.springframework.cloud.sleuth.annotation.SleuthAnnotationAutoConfiguration # Environment Post Processor org.springframework.boot.env.EnvironmentPostProcessor=\ org.springframework.cloud.sleuth.autoconfig.TraceEnvironmentPostProcessor
这些是自动装配bean的javaConfig,下面首先分析TraceAutoConfiguration。spring
@Configuration @ConditionalOnProperty(value="spring.sleuth.enabled", matchIfMissing=true) @EnableConfigurationProperties({TraceKeys.class, SleuthProperties.class}) public class TraceAutoConfiguration { @Autowired SleuthProperties properties; @Bean @ConditionalOnMissingBean public Random randomForSpanIds() { return new Random(); } @Bean @ConditionalOnMissingBean public Sampler defaultTraceSampler() { return NeverSampler.INSTANCE; } @Bean @ConditionalOnMissingBean(Tracer.class) public DefaultTracer sleuthTracer(Sampler sampler, Random random, SpanNamer spanNamer, SpanLogger spanLogger, SpanReporter spanReporter, TraceKeys traceKeys) { return new DefaultTracer(sampler, random, spanNamer, spanLogger, spanReporter, this.properties.isTraceId128(), traceKeys); } @Bean @ConditionalOnMissingBean public SpanNamer spanNamer() { return new DefaultSpanNamer(); } @Bean @ConditionalOnMissingBean public SpanReporter defaultSpanReporter() { return new NoOpSpanReporter(); } @Bean @ConditionalOnMissingBean public SpanAdjuster defaultSpanAdjuster() { return new NoOpSpanAdjuster(); } }
@Configuration与@Bean结合起来使用能够以javaConfig方式生成bean,@Bean annotation下面的方法会生成一个bean,方法名为bean的name,而入参则是建立该bean依赖的的ref bean。
@ConditionalOnProperty(value="spring.sleuth.enabled", matchIfMissing=true)注解的意思是该类生成bean须要的条件,这里条件是当spring.sleuth.enabled为true时(没有设置默认为true即条件符合,也就是显式设置为false才算不符合条件),才会触发生成bean。spring.sleuth.enabled的值在SleuthProperties中设置的,它会读取配置文件中以spring.sleuth为前缀的信息并设置到field中,好比enabled等。apache
@ConfigurationProperties("spring.sleuth") public class SleuthProperties { private boolean enabled = true; /** When true, generate 128-bit trace IDs instead of 64-bit ones. */ private boolean traceId128 = false; public boolean isEnabled() { return this.enabled; } public void setEnabled(boolean enabled) { this.enabled = enabled; } public boolean isTraceId128() { return this.traceId128; } public void setTraceId128(boolean traceId128) { this.traceId128 = traceId128; } }
@EnableConfigurationProperties({TraceKeys.class, SleuthProperties.class})注解则是支持将@ConfigurationProperties注解的bean注册到本类当中,这里是将TraceKey、SleuthProperties对应的bean注册到本类当中。websocket
下面分析每一个@Bean annotaded method,首先解释下@ConditionalOnMissingBean的含义。它的意思很明显,就是当不存在该类型的bean时才会触发。若是在其余地方定义了此类型的bean,那就不会执行该方法产生bean了。mvc
sleuth的基础config分析完后,下面分析instrumnet的配置,即如何在应用中织入trace埋点的配置。app
正经常使用到的trace span有三种类型:dom
一、2中的span属于remote span,而3中的span属于local span。异步
好的,下面分析web的基础配置,也就是涉及到跨节点的trace配置。socket
@Configuration @ConditionalOnBean(Tracer.class) @AutoConfigureAfter(TraceAutoConfiguration.class) @EnableConfigurationProperties({ TraceKeys.class, SleuthWebProperties.class }) public class TraceHttpAutoConfiguration { @Bean @ConditionalOnMissingBean public HttpTraceKeysInjector httpTraceKeysInjector(Tracer tracer, TraceKeys traceKeys) { return new HttpTraceKeysInjector(tracer, traceKeys); } @Bean @ConditionalOnMissingBean public HttpSpanExtractor httpSpanExtractor(SleuthWebProperties sleuthWebProperties) { return new ZipkinHttpSpanExtractor(Pattern.compile(sleuthWebProperties.getSkipPattern())); } @Bean @ConditionalOnMissingBean public HttpSpanInjector httpSpanInjector() { return new ZipkinHttpSpanInjector(); } }
@ConditionalOnBean(Tracer.class)意思是当存在Trace bean的时候才会触发。
@AutoConfigureAfter(TraceAutoConfiguration.class)意思是在TraceAutoConfiguration处理完后再触发。
@EnableConfigurationProperties({ TraceKeys.class, SleuthWebProperties.class })意思是将TraceKey、SleuthWebProperties对应的config注入到该类中,以便后期直接使用这些java config对象。
前面分析的TraceHttpAutoConfiguration生成的bean只是一些核心基础的bean,但没有具体应用到web服务当中。而此类会进行相关配置。
@Configuration @ConditionalOnProperty(value = "spring.sleuth.web.enabled", matchIfMissing = true) @ConditionalOnWebApplication @ConditionalOnBean(Tracer.class) @AutoConfigureAfter(TraceHttpAutoConfiguration.class) public class TraceWebAutoConfiguration { /** * Nested config that configures Web MVC if it's present (without adding a runtime * dependency to it) */ @Configuration @ConditionalOnClass(WebMvcConfigurerAdapter.class) @Import(TraceWebMvcConfigurer.class) protected static class TraceWebMvcAutoConfiguration { } @Bean public TraceWebAspect traceWebAspect(Tracer tracer, TraceKeys traceKeys, SpanNamer spanNamer) { return new TraceWebAspect(tracer, spanNamer, traceKeys); } @Bean @ConditionalOnClass(name = "org.springframework.data.rest.webmvc.support.DelegatingHandlerMapping") public TraceSpringDataBeanPostProcessor traceSpringDataBeanPostProcessor( BeanFactory beanFactory) { return new TraceSpringDataBeanPostProcessor(beanFactory); } @Bean public FilterRegistrationBean traceWebFilter(TraceFilter traceFilter) { FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean( traceFilter); filterRegistrationBean.setDispatcherTypes(ASYNC, ERROR, FORWARD, INCLUDE, REQUEST); filterRegistrationBean.setOrder(TraceFilter.ORDER); return filterRegistrationBean; } @Bean public TraceFilter traceFilter(Tracer tracer, TraceKeys traceKeys, SkipPatternProvider skipPatternProvider, SpanReporter spanReporter, HttpSpanExtractor spanExtractor, HttpTraceKeysInjector httpTraceKeysInjector) { return new TraceFilter(tracer, traceKeys, skipPatternProvider.skipPattern(), spanReporter, spanExtractor, httpTraceKeysInjector); } @Configuration @ConditionalOnClass(ManagementServerProperties.class) @ConditionalOnMissingBean(SkipPatternProvider.class) @EnableConfigurationProperties(SleuthWebProperties.class) protected static class SkipPatternProviderConfig { @Bean @ConditionalOnBean(ManagementServerProperties.class) public SkipPatternProvider skipPatternForManagementServerProperties( final ManagementServerProperties managementServerProperties, final SleuthWebProperties sleuthWebProperties) { return new SkipPatternProvider() { @Override public Pattern skipPattern() { return getPatternForManagementServerProperties( managementServerProperties, sleuthWebProperties); } }; } /** * Sets or appends {@link ManagementServerProperties#getContextPath()} to the skip * pattern. If neither is available then sets the default one */ static Pattern getPatternForManagementServerProperties( ManagementServerProperties managementServerProperties, SleuthWebProperties sleuthWebProperties) { String skipPattern = sleuthWebProperties.getSkipPattern(); if (StringUtils.hasText(skipPattern) && StringUtils.hasText(managementServerProperties.getContextPath())) { return Pattern.compile(skipPattern + "|" + managementServerProperties.getContextPath() + ".*"); } else if (StringUtils.hasText(managementServerProperties.getContextPath())) { return Pattern .compile(managementServerProperties.getContextPath() + ".*"); } return defaultSkipPattern(skipPattern); } @Bean @ConditionalOnMissingBean(ManagementServerProperties.class) public SkipPatternProvider defaultSkipPatternBeanIfManagementServerPropsArePresent(SleuthWebProperties sleuthWebProperties) { return defaultSkipPatternProvider(sleuthWebProperties.getSkipPattern()); } } @Bean @ConditionalOnMissingClass("org.springframework.boot.actuate.autoconfigure.ManagementServerProperties") @ConditionalOnMissingBean(SkipPatternProvider.class) public SkipPatternProvider defaultSkipPatternBean(SleuthWebProperties sleuthWebProperties) { return defaultSkipPatternProvider(sleuthWebProperties.getSkipPattern()); } private static SkipPatternProvider defaultSkipPatternProvider( final String skipPattern) { return new SkipPatternProvider() { @Override public Pattern skipPattern() { return defaultSkipPattern(skipPattern); } }; } private static Pattern defaultSkipPattern(String skipPattern) { return StringUtils.hasText(skipPattern) ? Pattern.compile(skipPattern) : Pattern.compile(SleuthWebProperties.DEFAULT_SKIP_PATTERN); } interface SkipPatternProvider { Pattern skipPattern(); } }
TraceWebAutoConfiguration执行的条件有这些:
内部静态类TraceWebMvcAutoConfiguration是为了import TraceWebMvcConfigurer的配置,它的条件是存在WebMvcConfigurerAdapter类,此类是spring mvc包中提供给用户自定义拦截器等功能的抽象类。
下面咱们看下TraceWebMvcConfigurer:
@Configuration class TraceWebMvcConfigurer extends WebMvcConfigurerAdapter { @Autowired BeanFactory beanFactory; @Bean public TraceHandlerInterceptor traceHandlerInterceptor(BeanFactory beanFactory) { return new TraceHandlerInterceptor(beanFactory); } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(this.beanFactory.getBean(TraceHandlerInterceptor.class)); } }
TraceWebMvcConfigurer定义了一个TraceHandlerInterceptor拦截器,而后重写addInterceptors方法,将拦截器设置到了spring mvc生命周期中。后期会对TraceHandlerInterceptor拦截器进行分析。
接下来分析TraceWebAutoConfiguration生成的每一个bean。
@Aspect public class TraceWebAspect { private static final Log log = org.apache.commons.logging.LogFactory .getLog(TraceWebAspect.class); private final Tracer tracer; private final SpanNamer spanNamer; private final TraceKeys traceKeys; public TraceWebAspect(Tracer tracer, SpanNamer spanNamer, TraceKeys traceKeys) { this.tracer = tracer; this.spanNamer = spanNamer; this.traceKeys = traceKeys; } @Pointcut("@within(org.springframework.web.bind.annotation.RestController)") private void anyRestControllerAnnotated() { }// NOSONAR @Pointcut("@within(org.springframework.stereotype.Controller)") private void anyControllerAnnotated() { } // NOSONAR @Pointcut("execution(public java.util.concurrent.Callable *(..))") private void anyPublicMethodReturningCallable() { } // NOSONAR @Pointcut("(anyRestControllerAnnotated() || anyControllerAnnotated()) && anyPublicMethodReturningCallable()") private void anyControllerOrRestControllerWithPublicAsyncMethod() { } // NOSONAR @Pointcut("execution(public org.springframework.web.context.request.async.WebAsyncTask *(..))") private void anyPublicMethodReturningWebAsyncTask() { } // NOSONAR @Pointcut("execution(public * org.springframework.web.servlet.HandlerExceptionResolver.resolveException(..)) && args(request, response, handler, ex)") private void anyHandlerExceptionResolver(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { } // NOSONAR @Pointcut("(anyRestControllerAnnotated() || anyControllerAnnotated()) && anyPublicMethodReturningWebAsyncTask()") private void anyControllerOrRestControllerWithPublicWebAsyncTaskMethod() { } // NOSONAR @Around("anyControllerOrRestControllerWithPublicAsyncMethod()") @SuppressWarnings("unchecked") public Object wrapWithCorrelationId(ProceedingJoinPoint pjp) throws Throwable { Callable<Object> callable = (Callable<Object>) pjp.proceed(); if (this.tracer.isTracing()) { if (log.isDebugEnabled()) { log.debug("Wrapping callable with span [" + this.tracer.getCurrentSpan() + "]"); } return new SpanContinuingTraceCallable<>(this.tracer, this.traceKeys, this.spanNamer, callable); } else { return callable; } } @Around("anyControllerOrRestControllerWithPublicWebAsyncTaskMethod()") public Object wrapWebAsyncTaskWithCorrelationId(ProceedingJoinPoint pjp) throws Throwable { final WebAsyncTask<?> webAsyncTask = (WebAsyncTask<?>) pjp.proceed(); if (this.tracer.isTracing()) { try { if (log.isDebugEnabled()) { log.debug("Wrapping callable with span [" + this.tracer.getCurrentSpan() + "]"); } Field callableField = WebAsyncTask.class.getDeclaredField("callable"); callableField.setAccessible(true); callableField.set(webAsyncTask, new SpanContinuingTraceCallable<>(this.tracer, this.traceKeys, this.spanNamer, webAsyncTask.getCallable())); } catch (NoSuchFieldException ex) { log.warn("Cannot wrap webAsyncTask's callable with TraceCallable", ex); } } return webAsyncTask; } @Around("anyHandlerExceptionResolver(request, response, handler, ex)") public Object markRequestForSpanClosing(ProceedingJoinPoint pjp, HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Throwable { Span currentSpan = this.tracer.getCurrentSpan(); try { if (!currentSpan.tags().containsKey(Span.SPAN_ERROR_TAG_NAME)) { this.tracer.addTag(Span.SPAN_ERROR_TAG_NAME, ExceptionUtils.getExceptionMessage(ex)); } return pjp.proceed(); } finally { if (log.isDebugEnabled()) { log.debug("Marking span " + currentSpan + " for closure by Trace Filter"); } request.setAttribute(TraceFilter.TRACE_CLOSE_SPAN_REQUEST_ATTR, true); } }
此bean对两种状况进行了aop拦截:
首先判断是否存在org.springframework.data.rest.webmvc.support.DelegatingHandlerMapping,便是否引入了spring data rest相关依赖包。没有的话则不会生成该bean。
该bean的主要做用是对Spring Data REST Controllers进行了包装,生成TraceDelegatingHandlerMapping代理类,该类对被代理类进行了拦截器设置,拦截器为前部分讲到的TraceHandlerInterceptor。
trace拦截器,对每一个请求进行拦截,在spring mvc的拦截器以前触发。他的主要做用是从request head中获取trace信息,生成span,没有trace信息则生成一个新的span。
将traceFilter注册到servlet容器中。也就是用java config形式代替了在web.xml中配置filter。
spring sleuth的核心配置分析完后,下面分析本章最后的部分-ZipkinAutoConfiguration。
@Configuration @EnableConfigurationProperties({ZipkinProperties.class, SamplerProperties.class}) @ConditionalOnProperty(value = "spring.zipkin.enabled", matchIfMissing = true) @AutoConfigureBefore(TraceAutoConfiguration.class) public class ZipkinAutoConfiguration { @Bean @ConditionalOnMissingBean public ZipkinSpanReporter reporter(SpanMetricReporter spanMetricReporter, ZipkinProperties zipkin, ZipkinRestTemplateCustomizer zipkinRestTemplateCustomizer) { RestTemplate restTemplate = new RestTemplate(); zipkinRestTemplateCustomizer.customize(restTemplate); return new HttpZipkinSpanReporter(restTemplate, zipkin.getBaseUrl(), zipkin.getFlushInterval(), spanMetricReporter); } @Bean @ConditionalOnMissingBean public ZipkinRestTemplateCustomizer zipkinRestTemplateCustomizer(ZipkinProperties zipkinProperties) { return new DefaultZipkinRestTemplateCustomizer(zipkinProperties); } @Bean @ConditionalOnMissingBean public Sampler defaultTraceSampler(SamplerProperties config) { return new PercentageBasedSampler(config); } @Bean public SpanReporter zipkinSpanListener(ZipkinSpanReporter reporter, EndpointLocator endpointLocator, Environment environment, List<SpanAdjuster> spanAdjusters) { return new ZipkinSpanListener(reporter, endpointLocator, environment, spanAdjusters); } @Configuration @ConditionalOnMissingBean(EndpointLocator.class) @ConditionalOnProperty(value = "spring.zipkin.locator.discovery.enabled", havingValue = "false", matchIfMissing = true) protected static class DefaultEndpointLocatorConfiguration { @Autowired(required=false) private ServerProperties serverProperties; @Autowired private ZipkinProperties zipkinProperties; @Autowired(required=false) private InetUtils inetUtils; @Value("${spring.application.name:unknown}") private String appName; @Bean public EndpointLocator zipkinEndpointLocator() { return new ServerPropertiesEndpointLocator(this.serverProperties, this.appName, this.zipkinProperties, this.inetUtils); } } @Configuration @ConditionalOnClass(DiscoveryClient.class) @ConditionalOnMissingBean(EndpointLocator.class) @ConditionalOnProperty(value = "spring.zipkin.locator.discovery.enabled", havingValue = "true") protected static class DiscoveryClientEndpointLocatorConfiguration { @Autowired(required=false) private ServerProperties serverProperties; @Autowired private ZipkinProperties zipkinProperties; @Autowired(required=false) private InetUtils inetUtils; @Value("${spring.application.name:unknown}") private String appName; @Autowired(required=false) private DiscoveryClient client; @Bean public EndpointLocator zipkinEndpointLocator() { return new FallbackHavingEndpointLocator(discoveryClientEndpointLocator(), new ServerPropertiesEndpointLocator(this.serverProperties, this.appName, this.zipkinProperties, this.inetUtils)); } private DiscoveryClientEndpointLocator discoveryClientEndpointLocator() { if (this.client!=null) { return new DiscoveryClientEndpointLocator(this.client, this.zipkinProperties); } return null; } } }
ZipkinAutoConfiguration上的annotation就不一一说明,前部分已经涉及到了。下面直接分析生成的bean。
返回HttpZipkinSpanReporter类型bean,内部会初始化sender以及delegate。sender是以何种方式将zipkin span发送到zipkin server。delegate是一个委托类,内部建立一个有界队列,异步将zipkin span发送到zipkin server。
建立reporter bean时须要依赖的sender。这里zipkin使用restTemplate做为sender提交span。
默认采样器,以前在TraceAutoConfiguration中也声明建立defaultTraceSampler,但因为ZipkinAutoConfiguration上有这样的注解:@AutoConfigureBefore(TraceAutoConfiguration.class),意思是在TraceAutoConfiguration以前执行,因此默认采样器使用的是ZipkinAutoConfiguration中生成的采样器即PercentageBasedSampler,它能够设置百分比来进行采样。
sleuth event监听器,上报sleuth span,而后转换成zipkin span,再经过zipkin reporter上报到zipkin server。
本章就到此结束了,其实还有hystrix、async相关模块的配置没讲,本章只讲了web相关的,后期有机会再讲。