com.google.cloud.spring.autoconfigure.trace

Class StackdriverTraceAutoConfiguration

java.lang.Object

com.google.cloud.spring.autoconfigure.trace.StackdriverTraceAutoConfiguration

@Configuration(proxyBeanMethods=false)
 @EnableConfigurationProperties(value=GcpTraceProperties.class)
 @ConditionalOnProperty(value={"spring.sleuth.enabled","spring.cloud.gcp.trace.enabled"},
                       matchIfMissing=true)
 @ConditionalOnClass(value=zipkin2.reporter.stackdriver.StackdriverSender.class)
 @AutoConfigureBefore(value=org.springframework.cloud.sleuth.autoconfig.brave.BraveAutoConfiguration.class)
public class StackdriverTraceAutoConfiguration
extends Object

Config for Stackdriver Trace.

Author:

Ray Tsang, João André Martins, Mike Eltsufin, Chengyuan Zhao, Tim Ysewyn, Vinesh Prasanna M

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StackdriverTraceAutoConfiguration.StackdriverTraceHttpAutoconfiguration Configuration for Sleuth.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOMIZER_BEAN_NAME Stackdriver customizer bean name.
static String	REPORTER_BEAN_NAME Stackdriver reporter bean name.
static String	SENDER_BEAN_NAME Stackdriver sender bean name.
static String	SPAN_HANDLER_BEAN_NAME Stackdriver span handler bean name.

Constructor Summary

Constructors

Constructor and Description
StackdriverTraceAutoConfiguration(GcpProjectIdProvider gcpProjectIdProvider, com.google.api.gax.core.CredentialsProvider credentialsProvider, GcpTraceProperties gcpTraceProperties)

Method Summary

Modifier and Type	Method and Description
brave.baggage.BaggagePropagation.FactoryBuilder	baggagePropagationFactoryBuilder()
void	closeScheduler()
zipkin2.reporter.Reporter<zipkin2.Span>	stackdriverReporter(zipkin2.reporter.ReporterMetrics reporterMetrics, GcpTraceProperties trace, zipkin2.reporter.Sender sender)
zipkin2.reporter.Sender	stackdriverSender(GcpTraceProperties traceProperties, com.google.api.gax.core.ExecutorProvider executorProvider, io.grpc.ManagedChannel channel)
io.grpc.ManagedChannel	stackdriverSenderChannel()
brave.handler.SpanHandler	stackdriverSpanHandler(zipkin2.reporter.Reporter<zipkin2.Span> stackdriverReporter)
brave.TracingCustomizer	stackdriverTracingCustomizer(brave.handler.SpanHandler spanHandler)
com.google.api.gax.core.ExecutorProvider	traceExecutorProvider(GcpTraceProperties traceProperties, Optional<org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler> userProvidedScheduler)

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

Stackdriver 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

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

See Also:

Constant Field Values

SPAN_HANDLER_BEAN_NAME

public static final String SPAN_HANDLER_BEAN_NAME

Stackdriver span handler bean name. Name of the bean matters for supporting multiple tracing systems.

See Also:

Constant Field Values

CUSTOMIZER_BEAN_NAME

public static final String CUSTOMIZER_BEAN_NAME

Stackdriver customizer bean name. Name of the bean matters for supporting multiple tracing systems.

See Also:

Constant Field Values

Constructor Detail

StackdriverTraceAutoConfiguration

public StackdriverTraceAutoConfiguration(GcpProjectIdProvider gcpProjectIdProvider,
                                         com.google.api.gax.core.CredentialsProvider credentialsProvider,
                                         GcpTraceProperties gcpTraceProperties)
                                  throws IOException

Throws:

IOException

Method Detail

stackdriverTracingCustomizer

@Bean(value="stackdriverTracingCustomizer")
 @ConditionalOnMissingBean(name="stackdriverTracingCustomizer")
public brave.TracingCustomizer stackdriverTracingCustomizer(@Qualifier(value="stackdriverSpanHandler")
                                                                                                                                                                        brave.handler.SpanHandler spanHandler)

stackdriverSpanHandler

@Bean(value="stackdriverSpanHandler")
 @ConditionalOnMissingBean(name="stackdriverSpanHandler")
public brave.handler.SpanHandler stackdriverSpanHandler(@Qualifier(value="stackdriverReporter")
                                                                                                                                                        zipkin2.reporter.Reporter<zipkin2.Span> stackdriverReporter)

traceExecutorProvider

@Bean
 @ConditionalOnMissingBean(name="traceExecutorProvider")
public com.google.api.gax.core.ExecutorProvider traceExecutorProvider(GcpTraceProperties traceProperties,
                                                                                                                                     @Qualifier(value="traceSenderThreadPool")
                                                                                                                                     Optional<org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler> userProvidedScheduler)

stackdriverSenderChannel

@Bean(destroyMethod="shutdownNow")
 @ConditionalOnMissingBean(name="stackdriverSenderChannel")
public io.grpc.ManagedChannel stackdriverSenderChannel()

stackdriverReporter

@Bean(value="stackdriverReporter")
 @ConditionalOnMissingBean(name="stackdriverReporter")
public zipkin2.reporter.Reporter<zipkin2.Span> stackdriverReporter(zipkin2.reporter.ReporterMetrics reporterMetrics,
                                                                                                                                                             GcpTraceProperties trace,
                                                                                                                                                             @Qualifier(value="stackdriverSender")
                                                                                                                                                             zipkin2.reporter.Sender sender)

stackdriverSender

@Bean(value="stackdriverSender")
 @ConditionalOnMissingBean(name="stackdriverSender")
public zipkin2.reporter.Sender stackdriverSender(GcpTraceProperties traceProperties,
                                                                                                                                       @Qualifier(value="traceExecutorProvider")
                                                                                                                                       com.google.api.gax.core.ExecutorProvider executorProvider,
                                                                                                                                       @Qualifier(value="stackdriverSenderChannel")
                                                                                                                                       io.grpc.ManagedChannel channel)
                                                                                                                                throws IOException

Throws:

IOException

baggagePropagationFactoryBuilder

@Bean
 @ConditionalOnMissingBean
public brave.baggage.BaggagePropagation.FactoryBuilder baggagePropagationFactoryBuilder()

closeScheduler

@PreDestroy
public void closeScheduler()