README.md

brave-instrumentation-spring-rabbit

Tracing for Spring Rabbit

This module provides instrumentation for spring-rabbit based services.

Common Configuration

To use this instrumentation, first define the common tracing configuration, e.g:

@Bean
public Tracing tracing() {
  return Tracing.newBuilder()
      .localServiceName("spring-amqp-producer")
      .build();
}

@Bean
public MessagingTracing messagingTracing(Tracing tracing) {
  return MessagingTracing.create(tracing);
}

@Bean
public SpringRabbitTracing springRabbitTracing(MessagingTracing messagingTracing) {
  return SpringRabbitTracing.newBuilder(messagingTracing)
                            .writeB3SingleFormat(true) // for more efficient propagation
                            .remoteServiceName("my-mq-service")
                            .build();
}

Sampling Policy

The default sampling policy is to use the default (trace ID) sampler for producer and consumer requests.

You can use an MessagingRuleSampler to override this based on JMS destination names.

Ex. Here's a sampler that traces 100 consumer requests per second, except for the "alerts" topic. Other requests will use a global rate provided by the Tracing component.

import brave.sampler.Matchers;

import static brave.messaging.MessagingRequestMatchers.channelNameEquals;

@Bean
public MessagingTracing messagingTracing(Tracing tracing) {
  return MessagingTracing.newBuilder(tracing)
    .consumerSampler(MessagingRuleSampler.newBuilder()
      .putRule(channelNameEquals("alerts"), Sampler.NEVER_SAMPLE)
      .putRule(Matchers.alwaysMatch(), RateLimitingSampler.create(100))
      .build())
    .build();
}

Message Producer

This module contains a tracing interceptor for RabbitTemplate. TracingMessagePostProcessor adds trace headers to outgoing rabbit messages. It then reports to Zipkin how long each request takes. To use, define a RabbitTemplate in a Spring config class:

@Bean
public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory,
    SpringRabbitTracing springRabbitTracing) {
  RabbitTemplate rabbitTemplate = springRabbitTracing.newRabbitTemplate(connectionFactory);
  // other customizations as required
  return rabbitTemplate;
}

You can also use SpringRabbitTracing.decorateRabbitTemplate() to add tracing to an existing template.

Message Consumer

Tracing is supported for spring-rabbit @RabbitListener based services. To configure tracing for rabbit listeners, use the following factory to create a SimpleRabbitListenerContainerFactory. As with the RabbitTemplate, you may provide additional customizations required on the this object as required. Note that the tracing functionality is provided through the adviceChain, so if other advices are required for this ListenerContainerFactory, ensure that they are appended to the adviceChain.

@Bean
public SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory(
    ConnectionFactory connectionFactory,
    SpringRabbitTracing springRabbitTracing
) {
  return springRabbitTracing.newSimpleRabbitListenerContainerFactory(connectionFactory);
}

You can also use SpringRabbitTracing.decorateSimpleRabbitListenerContainerFactory() to add tracing to an existing factory.