Package brave.kafka.streams

Class KafkaStreamsTracing

java.lang.Object

brave.kafka.streams.KafkaStreamsTracing

public final class KafkaStreamsTracing
extends java.lang.Object

Use this class to decorate Kafka Stream Topologies and enable Tracing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KafkaStreamsTracing.Builder

Method Summary

Modifier and Type	Method	Description
static KafkaStreamsTracing	create(brave.Tracing tracing)
org.apache.kafka.streams.KafkaStreams	kafkaStreams(org.apache.kafka.streams.Topology topology, java.util.Properties streamsConfig)	Creates a KafkaStreams instance with a tracing-enabled KafkaClientSupplier.
<K,V> org.apache.kafka.streams.processor.ProcessorSupplier<K,V>	processor(java.lang.String name, org.apache.kafka.streams.processor.Processor<K,V> processor)	Create a tracing-decorated ProcessorSupplier
<K,V,R> org.apache.kafka.streams.kstream.TransformerSupplier<K,V,R>	transformer(java.lang.String name, org.apache.kafka.streams.kstream.Transformer<K,V,R> transformer)	Create a tracing-decorated TransformerSupplier
<V,VR> org.apache.kafka.streams.kstream.ValueTransformerSupplier<V,VR>	valueTransformer(java.lang.String name, org.apache.kafka.streams.kstream.ValueTransformer<V,VR> valueTransformer)	Create a tracing-decorated ValueTransformerSupplier
<K,V,VR> org.apache.kafka.streams.kstream.ValueTransformerWithKeySupplier<K,V,VR>	valueTransformerWithKey(java.lang.String name, org.apache.kafka.streams.kstream.ValueTransformerWithKey<K,V,VR> valueTransformerWithKey)	Create a tracing-decorated ValueTransformerWithKeySupplier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static KafkaStreamsTracing create(brave.Tracing tracing)

kafkaStreams

public org.apache.kafka.streams.KafkaStreams kafkaStreams(org.apache.kafka.streams.Topology topology,
                                                          java.util.Properties streamsConfig)

Creates a KafkaStreams instance with a tracing-enabled KafkaClientSupplier. All Topology Sources and Sinks (including internal Topics) will create Spans on records processed (i.e. send or consumed). Use this instead of KafkaStreams constructor.

Simple example:

 // KafkaStreams with tracing-enabled KafkaClientSupplier
 KafkaStreams kafkaStreams = kafkaStreamsTracing.kafkaStreams(topology, streamsConfig);
 

See Also:

TracingKafkaClientSupplier

processor

public <K,V> org.apache.kafka.streams.processor.ProcessorSupplier<K,V> processor(java.lang.String name,
                                                                                 org.apache.kafka.streams.processor.Processor<K,V> processor)

Create a tracing-decorated ProcessorSupplier

Simple example using Kafka Streams DSL:

 StreamsBuilder builder = new StreamsBuilder();
 builder.stream(inputTopic)
        .process(kafkaStreamsTracing.processor("my-processor", myProcessor);
 

See Also:

TracingKafkaClientSupplier

transformer

public <K,V,R> org.apache.kafka.streams.kstream.TransformerSupplier<K,V,R> transformer(java.lang.String name,
                                                                                       org.apache.kafka.streams.kstream.Transformer<K,V,R> transformer)

Create a tracing-decorated TransformerSupplier

Simple example using Kafka Streams DSL:

 StreamsBuilder builder = new StreamsBuilder();
 builder.stream(inputTopic)
        .transform(kafkaStreamsTracing.transformer("my-transformer", myTransformer)
        .to(outputTopic);
 

valueTransformer

public <V,VR> org.apache.kafka.streams.kstream.ValueTransformerSupplier<V,VR> valueTransformer(java.lang.String name,
                                                                                               org.apache.kafka.streams.kstream.ValueTransformer<V,VR> valueTransformer)

Create a tracing-decorated ValueTransformerSupplier

Simple example using Kafka Streams DSL:

 StreamsBuilder builder = new StreamsBuilder();
 builder.stream(inputTopic)
        .transformValues(kafkaStreamsTracing.valueTransformer("my-transformer", myTransformer)
        .to(outputTopic);
 

valueTransformerWithKey

public <K,V,VR> org.apache.kafka.streams.kstream.ValueTransformerWithKeySupplier<K,V,VR> valueTransformerWithKey(java.lang.String name,
                                                                                                                 org.apache.kafka.streams.kstream.ValueTransformerWithKey<K,V,VR> valueTransformerWithKey)

Create a tracing-decorated ValueTransformerWithKeySupplier

Simple example using Kafka Streams DSL:

 StreamsBuilder builder = new StreamsBuilder();
 builder.stream(inputTopic)
        .transformValues(kafkaStreamsTracing.valueTransformerWithKey("my-transformer", myTransformer)
        .to(outputTopic);