Skip to content

WIP: customizer all the things #1436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
codefromthecrypt wants to merge 1 commit into from
Closed

WIP: customizer all the things #1436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion benchmarks/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<maven.compiler.target>1.8</maven.compiler.target>
<maven.compiler.source>1.8</maven.compiler.source>
<spring-boot.version>2.2.0.BUILD-SNAPSHOT</spring-boot.version>
<brave.version>5.6.9</brave.version>
<brave.version>5.7.0</brave.version>
</properties>

<dependencyManagement>
Expand Down
21 changes: 21 additions & 0 deletions ...ore/src/main/java/org/springframework/cloud/sleuth/autoconfig/TraceAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,12 @@
import brave.ErrorParser;
import brave.Tracer;
import brave.Tracing;
import brave.TracingCustomizer;
import brave.handler.FinishedSpanHandler;
import brave.propagation.B3Propagation;
import brave.propagation.CurrentTraceContext;
import brave.propagation.CurrentTraceContextCustomizer;
import brave.propagation.ExtraFieldCustomizer;
import brave.propagation.ExtraFieldPropagation;
import brave.propagation.Propagation;
import brave.propagation.ThreadLocalCurrentTraceContext;
Expand Down Expand Up @@ -87,6 +90,15 @@ public class TraceAutoConfiguration {
@Autowired(required = false)
ExtraFieldPropagation.FactoryBuilder extraFieldPropagationFactoryBuilder;

@Autowired(required = false)
List<TracingCustomizer> tracingCustomizers = new ArrayList<>();

@Autowired(required = false)
List<CurrentTraceContextCustomizer> currentTraceContextCustomizers = new ArrayList<>();

@Autowired(required = false)
List<ExtraFieldCustomizer> extraFieldCustomizers = new ArrayList<>();

@Bean
@ConditionalOnMissingBean
// NOTE: stable bean name as might be used outside sleuth
Expand All @@ -107,6 +119,9 @@ Tracing tracing(
for (FinishedSpanHandler finishedSpanHandlerFactory : this.finishedSpanHandlers) {
builder.addFinishedSpanHandler(finishedSpanHandlerFactory);
}
for (TracingCustomizer customizer : this.tracingCustomizers) {
Copy link
Contributor Author

@codefromthecrypt codefromthecrypt Sep 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ps without tests this is subtle. it is important these apply last as they can rejig the reporter config, something needed for secondary sampling to work. ex we want to flip default reporter to noop but reuse the normal reporter as a finished span handler. this stuff works when customizes hit last before build

customizer.customize(builder);
}
return builder.build();
}

Expand Down Expand Up @@ -160,6 +175,9 @@ Propagation.Factory sleuthPropagation(SleuthProperties sleuthProperties) {
factoryBuilder = factoryBuilder.addRedactedField(key);
}
}
for (ExtraFieldCustomizer customizer : this.extraFieldCustomizers) {
customizer.customize(factoryBuilder);
}
return factoryBuilder.build();
}

Expand All @@ -168,6 +186,9 @@ CurrentTraceContext sleuthCurrentTraceContext(CurrentTraceContext.Builder builde
for (CurrentTraceContext.ScopeDecorator scopeDecorator : this.scopeDecorators) {
builder.addScopeDecorator(scopeDecorator);
}
for (CurrentTraceContextCustomizer customizer : this.currentTraceContextCustomizers) {
customizer.customize(builder);
}
return builder.build();
}

Expand Down
16 changes: 14 additions & 2 deletions ...main/java/org/springframework/cloud/sleuth/instrument/web/TraceHttpAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,19 @@

package org.springframework.cloud.sleuth.instrument.web;

import java.util.ArrayList;
import java.util.List;

import brave.ErrorParser;
import brave.Tracing;
import brave.http.HttpAdapter;
import brave.http.HttpClientParser;
import brave.http.HttpSampler;
import brave.http.HttpServerParser;
import brave.http.HttpTracing;
import brave.http.HttpTracingCustomizer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
Expand Down Expand Up @@ -51,6 +56,9 @@ public class TraceHttpAutoConfiguration {

static final int TRACING_FILTER_ORDER = Ordered.HIGHEST_PRECEDENCE + 5;

@Autowired(required = false)
List<HttpTracingCustomizer> httpTracingCustomizers = new ArrayList<>();

@Bean
@ConditionalOnMissingBean
// NOTE: stable bean name as might be used outside sleuth
Expand All @@ -60,9 +68,13 @@ HttpTracing httpTracing(Tracing tracing, SkipPatternProvider provider,
@Nullable @ServerSampler HttpSampler serverSampler) {
HttpSampler combinedSampler = combineUserProvidedSamplerWithSkipPatternSampler(
serverSampler, provider);
return HttpTracing.newBuilder(tracing).clientParser(clientParser)
HttpTracing.Builder builder = HttpTracing.newBuilder(tracing).clientParser(clientParser)
.serverParser(serverParser).clientSampler(clientSampler)
.serverSampler(combinedSampler).build();
.serverSampler(combinedSampler);
for (HttpTracingCustomizer customizer : this.httpTracingCustomizers) {
customizer.customize(builder);
}
return builder.build();
}

private HttpSampler combineUserProvidedSamplerWithSkipPatternSampler(
Expand Down
2 changes: 1 addition & 1 deletion spring-cloud-sleuth-dependencies/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<name>spring-cloud-sleuth-dependencies</name>
<description>Spring Cloud Sleuth Dependencies</description>
<properties>
<brave.version>5.6.10</brave.version>
<brave.version>5.7.0</brave.version>
<brave.opentracing.version>0.34.1</brave.opentracing.version>
<grpc.spring.boot.version>3.4.1</grpc.spring.boot.version>
</properties>
Expand Down