org.springframework.cloud.sleuth.zipkin2

Class ZipkinAutoConfiguration

java.lang.Object

org.springframework.cloud.sleuth.zipkin2.ZipkinAutoConfiguration

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

Auto-configuration enables reporting to Zipkin via HTTP. Has a default sampler set from the SamplerAutoConfiguration 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, Tim Ysewyn

See Also:

SamplerAutoConfiguration, ZipkinRestTemplateCustomizer, DefaultZipkinRestTemplateCustomizer

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPORTER_BEAN_NAME Zipkin reporter bean name.
static String	SENDER_BEAN_NAME Zipkin sender bean name.

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)
ZipkinRestTemplateCustomizer	zipkinRestTemplateCustomizer(ZipkinProperties zipkinProperties)

Methods inherited from class java.lang.Object

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

Field Detail

REPORTER_BEAN_NAME

public static final String REPORTER_BEAN_NAME

Zipkin reporter bean name. Name of the bean matters for supporting multiple tracing systems.

See Also:

Constant Field Values

SENDER_BEAN_NAME

public static final String SENDER_BEAN_NAME

Zipkin sender bean name. Name of the bean matters for supporting multiple tracing systems.

See Also:

Constant Field Values

Constructor Detail

ZipkinAutoConfiguration

public ZipkinAutoConfiguration()

Method Detail

reporter

@Bean(value="zipkinReporter")
 @ConditionalOnMissingBean(name="zipkinReporter")
public zipkin2.reporter.Reporter<zipkin2.Span> reporter(zipkin2.reporter.ReporterMetrics reporterMetrics,
                                                                                                                                        ZipkinProperties zipkin,
                                                                                                                                        @Qualifier(value="zipkinSender")
                                                                                                                                        zipkin2.reporter.Sender sender)

zipkinRestTemplateCustomizer

@Bean
 @ConditionalOnMissingBean
public ZipkinRestTemplateCustomizer zipkinRestTemplateCustomizer(ZipkinProperties zipkinProperties)