brave.context.slf4j.MDCScopeDecorator Java Examples

/** Controls aspects of tracing such as the service name that shows up in the UI */
@Bean Tracing tracing(@Value("${spring.application.name}") String serviceName) {
  return Tracing.newBuilder()
      .localServiceName(serviceName)
      .propagationFactory(ExtraFieldPropagation.newFactory(B3Propagation.FACTORY, "user-name"))
      .currentTraceContext(ThreadLocalCurrentTraceContext.newBuilder()
          .addScopeDecorator(MDCScopeDecorator.create()) // puts trace IDs into logs
          .build()
      )
      .spanReporter(spanReporter()).build();
}
 

@Bean
@ConditionalOnMissingBean(CorrelationScopeDecorator.class)
@ConditionalOnBean(CorrelationScopeDecorator.Builder.class)
@ConditionalOnProperty(value = "spring.sleuth.baggage.correlation-enabled",
		matchIfMissing = true)
ScopeDecorator correlationScopeDecorator(
		@Qualifier(WHITELISTED_MDC_KEYS) List<String> whiteListedMDCKeys,
		SleuthBaggageProperties sleuthBaggageProperties,
		@Nullable List<CorrelationScopeCustomizer> correlationScopeCustomizers) {

	Set<String> correlationFields = redirectOldPropertyToNew(WHITELISTED_MDC_KEYS,
			whiteListedMDCKeys, "spring.sleuth.baggage.correlation-fields",
			sleuthBaggageProperties.getCorrelationFields());

	// Add fields from properties
	CorrelationScopeDecorator.Builder builder = MDCScopeDecorator.newBuilder();
	for (String field : correlationFields) {
		builder.add(SingleCorrelationField.newBuilder(BaggageField.create(field))
				.build());
	}

	// handle user overrides
	if (correlationScopeCustomizers != null) {
		for (CorrelationScopeCustomizer customizer : correlationScopeCustomizers) {
			customizer.customize(builder);
		}
	}
	return builder.build();
}
 

private static HttpTracing createHttpTracing(String serviceName, AsyncReporter<Span> reporter) {
    final Tracing tracing = Tracing
        .newBuilder()
        .localServiceName(serviceName)
        .currentTraceContext(
            ThreadLocalCurrentTraceContext
                .newBuilder()
                .addScopeDecorator(MDCScopeDecorator.create()) 
                .build()
          )
        .spanReporter(reporter)
        .build();
    
    return HttpTracing.create(tracing);
}
 

@Bean
CurrentTraceContext currentTraceContext() {
  return ThreadLocalCurrentTraceContext.newBuilder().addScopeDecorator(MDCScopeDecorator.create()).build();
}
 

/**
 * Build a new {@link HttpTracing} instance for interfacing with Zipkin
 *
 * @param environment Environment
 * @param reporter reporter
 * @return HttpTracing instance
 */
protected Optional<HttpTracing> buildTracing(
    final Environment environment, final SpanHandler reporter) {

  LOGGER.info(
      "Registering Zipkin service ({}) at <{}:{}>", serviceName, serviceHost, servicePort);

  final Tracing tracing =
      Tracing.newBuilder()
          .currentTraceContext(
              ThreadLocalCurrentTraceContext.newBuilder()
                  .addScopeDecorator(MDCScopeDecorator.get())
                  .build())
          .localIp(serviceHost)
          .localPort(servicePort)
          .addSpanHandler(reporter)
          .localServiceName(serviceName)
          .sampler(getSampler())
          .traceId128Bit(traceId128Bit)
          .build();

  final HttpTracing.Builder httpTracingBuilder = HttpTracing.newBuilder(tracing);
  if (clientParser != null) httpTracingBuilder.clientParser(clientParser);
  if (clientRequestParser != null) httpTracingBuilder.clientRequestParser(clientRequestParser);
  if (clientResponseParser != null) httpTracingBuilder.clientResponseParser(clientResponseParser);
  if (serverRequestParser != null) httpTracingBuilder.serverRequestParser(serverRequestParser);
  if (serverResponseParser != null) httpTracingBuilder.serverResponseParser(serverResponseParser);
  if (serverParser != null) httpTracingBuilder.serverParser(serverParser);
  if (clientSampler != null) httpTracingBuilder.clientSampler(clientSampler);
  if (serverSampler != null) httpTracingBuilder.serverSampler(serverSampler);

  final HttpTracing httpTracing = httpTracingBuilder.build();

  // Register the tracing feature for client and server requests
  environment.jersey().register(TracingApplicationEventListener.create(httpTracing));
  environment
      .lifecycle()
      .manage(
          new Managed() {
            @Override
            public void start() {
              // nothing to start
            }

            @Override
            public void stop() {
              tracing.close();
            }
          });

  return Optional.of(httpTracing);
}
 

public static CurrentTraceContext getDefaultCurrentTraceContext() {
    return ThreadLocalCurrentTraceContext.newBuilder()
            .addScopeDecorator(MDCScopeDecorator.create())
            .build();
}
 

@Bean
@ConditionalOnMissingBean
@ConditionalOnClass(MDC.class)
CorrelationScopeDecorator.Builder correlationScopeDecoratorBuilder() {
	return MDCScopeDecorator.newBuilder();
}
 

/** Allows log patterns to use {@code %{traceId}} {@code %{spanId}} and {@code %{userName}} */
@Bean ScopeDecorator correlationScopeDecorator() {
  return MDCScopeDecorator.newBuilder()
      .add(SingleCorrelationField.create(USER_NAME)).build();
}