zipkin.collector.kafka

Class KafkaCollector.Builder

java.lang.Object

zipkin.collector.kafka.KafkaCollector.Builder

All Implemented Interfaces:

CollectorComponent.Builder

Enclosing class:

KafkaCollector

public static final class KafkaCollector.Builder
extends Object
implements CollectorComponent.Builder

Configuration including defaults needed to consume spans from a Kafka topic.

Method Summary

Modifier and Type	Method and Description
KafkaCollector	build()
KafkaCollector.Builder	groupId(String groupId) The consumer group this process is consuming on behalf of.
KafkaCollector.Builder	maxMessageSize(int bytes) Maximum size of a message containing spans in bytes.
KafkaCollector.Builder	metrics(CollectorMetrics metrics)
KafkaCollector.Builder	overrides(Map<String,String> overrides) By default, a consumer will be built from properties derived from builder defaults, as well "auto.offset.reset" -> "smallest".
KafkaCollector.Builder	sampler(CollectorSampler sampler)
KafkaCollector.Builder	storage(StorageComponent storage)
KafkaCollector.Builder	streams(int streams) Count of threads/streams consuming the topic.
KafkaCollector.Builder	topic(String topic) Topic zipkin spans will be consumed from.
KafkaCollector.Builder	zookeeper(String zookeeper) The zookeeper connect string, ex.

Methods inherited from class java.lang.Object

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

Method Detail

storage

public KafkaCollector.Builder storage(StorageComponent storage)

Specified by:

storage in interface CollectorComponent.Builder

sampler

public KafkaCollector.Builder sampler(CollectorSampler sampler)

Specified by:

sampler in interface CollectorComponent.Builder

metrics

public KafkaCollector.Builder metrics(CollectorMetrics metrics)

Specified by:

metrics in interface CollectorComponent.Builder

topic

public KafkaCollector.Builder topic(String topic)

Topic zipkin spans will be consumed from. Defaults to "zipkin"

zookeeper

public KafkaCollector.Builder zookeeper(String zookeeper)

The zookeeper connect string, ex. 127.0.0.1:2181. No default

groupId

public KafkaCollector.Builder groupId(String groupId)

The consumer group this process is consuming on behalf of. Defaults to "zipkin"

streams

public KafkaCollector.Builder streams(int streams)

Count of threads/streams consuming the topic. Defaults to 1

maxMessageSize

public KafkaCollector.Builder maxMessageSize(int bytes)

Maximum size of a message containing spans in bytes. Defaults to 1 MiB

overrides

public final KafkaCollector.Builder overrides(Map<String,String> overrides)

By default, a consumer will be built from properties derived from builder defaults, as well "auto.offset.reset" -> "smallest". Any properties set here will override the consumer config.

For example: Only consume spans since you connected by setting the below.

 Map<String, String> overrides = new LinkedHashMap<>();
 overrides.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "largest");
 builder.overrides(overrides);
 

See Also:

ConsumerConfig

build

public KafkaCollector build()

Specified by:

build in interface CollectorComponent.Builder