org.springframework.cloud.sleuth.zipkin2

Class ZipkinAutoConfiguration

java.lang.Object

org.springframework.cloud.sleuth.zipkin2.ZipkinAutoConfiguration

@Configuration
 @EnableConfigurationProperties(value={ZipkinProperties.class,org.springframework.cloud.sleuth.sampler.SamplerProperties.class})
 @ConditionalOnProperty(value="spring.zipkin.enabled",
                       matchIfMissing=true)
 @AutoConfigureBefore(value=org.springframework.cloud.sleuth.autoconfig.TraceAutoConfiguration.class)
 @Import(value=ZipkinSenderConfigurationImportSelector.class)
public class ZipkinAutoConfiguration
extends Object

Auto-configuration enables reporting to Zipkin via HTTP. Has a default Sampler set as ProbabilityBasedSampler. The ZipkinRestTemplateCustomizer allows you to customize the RestTemplate that is used to send Spans to Zipkin. Its default implementation - DefaultZipkinRestTemplateCustomizer adds the GZip compression.

Since:

1.0.0

Author:

Spencer Gibb

See Also:

ProbabilityBasedSampler, ZipkinRestTemplateCustomizer, DefaultZipkinRestTemplateCustomizer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ZipkinAutoConfiguration.DefaultEndpointLocatorConfiguration
protected static class	ZipkinAutoConfiguration.NonRefreshScopeProbabilityBasedSamplerConfiguration
protected static class	ZipkinAutoConfiguration.RefreshScopedProbabilityBasedSamplerConfiguration
protected static class	ZipkinAutoConfiguration.RegistrationEndpointLocatorConfiguration

Constructor Summary

Constructors

Constructor and Description
ZipkinAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
zipkin2.reporter.Reporter<zipkin2.Span>	reporter(zipkin2.reporter.ReporterMetrics reporterMetrics, ZipkinProperties zipkin, zipkin2.reporter.Sender sender, zipkin2.codec.BytesEncoder<zipkin2.Span> spanBytesEncoder) Accepts a sender so you can plug-in any standard one.
zipkin2.codec.BytesEncoder<zipkin2.Span>	spanBytesEncoder(ZipkinProperties zipkinProperties)
ZipkinRestTemplateCustomizer	zipkinRestTemplateCustomizer(ZipkinProperties zipkinProperties)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZipkinAutoConfiguration

public ZipkinAutoConfiguration()

Method Detail

reporter

@Bean
 @ConditionalOnMissingBean
public zipkin2.reporter.Reporter<zipkin2.Span> reporter(zipkin2.reporter.ReporterMetrics reporterMetrics,
                                                                                         ZipkinProperties zipkin,
                                                                                         zipkin2.reporter.Sender sender,
                                                                                         zipkin2.codec.BytesEncoder<zipkin2.Span> spanBytesEncoder)

Accepts a sender so you can plug-in any standard one. Returns a Reporter so you can also replace with a standard one.

spanBytesEncoder

@Bean
 @ConditionalOnMissingBean
public zipkin2.codec.BytesEncoder<zipkin2.Span> spanBytesEncoder(ZipkinProperties zipkinProperties)

zipkinRestTemplateCustomizer

@Bean
 @ConditionalOnMissingBean
public ZipkinRestTemplateCustomizer zipkinRestTemplateCustomizer(ZipkinProperties zipkinProperties)