Package zipkin2.reporter.kafka

Class KafkaSender

java.lang.Object

zipkin2.Component

zipkin2.reporter.Sender

zipkin2.reporter.kafka.KafkaSender

All Implemented Interfaces:

Closeable, AutoCloseable

public final class KafkaSender
extends Sender

This sends (usually json v2) encoded spans to a Kafka topic.

Usage

This type is designed for the async reporter.

Here's a simple configuration, configured for json:

 sender = KafkaSender.create("localhost:9092");
 

Here's an example that overrides properties and protocol buffers encoding:

 Properties overrides = new Properties();
 overrides.put(ProducerConfig.MAX_BLOCK_MS_CONFIG, 5000);
 sender = KafkaSender.newBuilder()
   .bootstrapServers("host1:9092,host2:9092")
   .overrides(overrides)
   .encoding(Encoding.PROTO3)
   .build();
 

Compatibility with Zipkin Server

Zipkin server should be v1.26 or higher.

Implementation Notes

This sender is thread-safe. This sender is linked against Kafka 0.10.2+, which allows it to work with Kafka 0.10+ brokers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KafkaSender.Builder	Configuration including defaults needed to send spans to a Kafka topic.

Method Summary

Modifier and Type	Method	Description
zipkin2.CheckResult	check()	Ensures there are no problems reading metadata about the topic.
void	close()
static KafkaSender	create(String bootstrapServers)	Creates a sender that sends Encoding.JSON messages.
zipkin2.codec.Encoding	encoding()
int	messageMaxBytes()
int	messageSizeInBytes(int encodedSizeInBytes)
int	messageSizeInBytes(List<byte[]> encodedSpans)
static KafkaSender.Builder	newBuilder()
zipkin2.Call<Void>	sendSpans(List<byte[]> encodedSpans)	This sends all of the spans as a single message.
KafkaSender.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static KafkaSender create(String bootstrapServers)

Creates a sender that sends Encoding.JSON messages.

newBuilder

public static KafkaSender.Builder newBuilder()

toBuilder

public KafkaSender.Builder toBuilder()

messageSizeInBytes

public int messageSizeInBytes(List<byte[]> encodedSpans)

Specified by:

messageSizeInBytes in class Sender

messageSizeInBytes

public int messageSizeInBytes(int encodedSizeInBytes)

Overrides:

messageSizeInBytes in class Sender

encoding

public zipkin2.codec.Encoding encoding()

Specified by:

encoding in class Sender

messageMaxBytes

public int messageMaxBytes()

Specified by:

messageMaxBytes in class Sender

sendSpans

public zipkin2.Call<Void> sendSpans(List<byte[]> encodedSpans)

This sends all of the spans as a single message.

NOTE: this blocks until the metadata server is available.

Specified by:

sendSpans in class Sender

check

public zipkin2.CheckResult check()

Ensures there are no problems reading metadata about the topic.

Overrides:

check in class zipkin2.Component

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class zipkin2.Component

toString

public final String toString()

Overrides:

toString in class Object