spring-beans

zipkin-reporter-spring-beans

This module contains Spring Factory Beans that allow you to configure zipkinSpanHandler with only XML. Notably, this requires minimally Spring version 2.5.

Configuration

Bean Factories exist for the following types:

• AsyncReporterFactoryBean - for configuring how often spans are sent to Zipkin

• ActiveMQSenderFactoryBean - for zipkin-sender-activemq-client

• OkHttpSenderFactoryBean - for zipkin-sender-okhttp3

• KafkaSenderFactoryBean - for zipkin-sender-kafka

• RabbitMQSenderFactoryBean - for zipkin-sender-amqp-client

• URLConnectionSenderFactoryBean - for zipkin-sender-urlconnection

• AsyncZipkinSpanHandlerFactoryBean - for brave

• ZipkinSpanHandlerFactoryBeanTest - for brave reporter bridge

• Here's a basic example

  <bean id="spanReporter" class="zipkin2.reporter.beans.AsyncReporterFactoryBean">
    <property name="sender">
      <bean class="zipkin2.reporter.beans.OkHttpSenderFactoryBean">
        <property name="endpoint" value="http://localhost:9411/api/v2/spans"/>
      </bean>
    </property>
  </bean>

Here's an example with Kafka configuration and extended configuration:

  <bean id="sender" class="zipkin2.reporter.beans.KafkaSenderFactoryBean">
    <property name="bootstrapServers" value="192.168.99.100:9092"/>
    <!-- if using a zipkin server 2.8+, you can send in binary format -->
    <property name="encoding" value="PROTO3"/>
    <property name="topic" value="test_zipkin"/>
  </bean>

  <bean id="spanReporter" class="zipkin2.reporter.beans.AsyncReporterFactoryBean">
    <property name="sender" ref="sender"/>
    <!-- wait up to half a second for any in-flight spans on close -->
    <property name="closeTimeout" value="500"/>
  </bean>

Here's an example integrating with Brave 5.12+

  <property name="sender">
    <bean class="zipkin2.reporter.beans.OkHttpSenderFactoryBean">
      <property name="endpoint" value="http://localhost:9411/api/v2/spans"/>
    </bean>
  </property>

  <bean id="zipkinSpanHandler" class="zipkin2.reporter.beans.AsyncZipkinSpanHandlerFactoryBean">
    <property name="sender" ref="sender"/>
  </bean>

  <bean id="tracing" class="brave.spring.beans.TracingFactoryBean">
    <property name="localServiceName" value="${zipkin.service}"/>
    <property name="spanHandlers" ref="zipkinSpanHandler" />
  </bean>