smartthings.brave.kafka.consumers

Class BaseTracingConsumerInterceptor<K>

java.lang.Object

smartthings.brave.kafka.consumers.BaseTracingConsumerInterceptor<K>

Type Parameters:

K - key type

All Implemented Interfaces:

org.apache.kafka.clients.consumer.ConsumerInterceptor<K,byte[]>, org.apache.kafka.common.Configurable

Direct Known Subclasses:

DefaultTracingConsumerInterceptor

public abstract class BaseTracingConsumerInterceptor<K>
extends Object
implements org.apache.kafka.clients.consumer.ConsumerInterceptor<K,byte[]>

An abstract interceptor that extracts any tracing context and the original record from the received record, annotates and flushes "wr" for each, and finally returns them to the consumer as TracedConsumerRecord. Extraction is left abstract to match the injection strategy used. Due to the batch nature of ConsumerInterceptor.onConsume(org.apache.kafka.clients.consumer.ConsumerRecords), this interceptor cannot propagate the trace context for each record. The consumer should be responsible for propagating the extracted context. Required: A Tracer in config as "brave.tracer". Optional: A SpanNameProvider in config as "brave.span.name.provider" to customize span name. Optional: A Endpoint in config as "brave.span.remote.endpoint" to customize span remote endpoint.

Constructor Summary

Constructors

Constructor and Description
BaseTracingConsumerInterceptor()

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(Map<String,?> configs)
protected abstract TracedConsumerRecord<K,byte[]>	getTracedConsumerRecord(org.apache.kafka.clients.consumer.ConsumerRecord<K,byte[]> record) Abstract method for extracting original consumer record and tracing context from a received consumer record, which was potentially mutated by a producer interceptor to have a tracing context injected
void	onCommit(Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets)
org.apache.kafka.clients.consumer.ConsumerRecords<K,byte[]>	onConsume(org.apache.kafka.clients.consumer.ConsumerRecords<K,byte[]> records)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTracingConsumerInterceptor

public BaseTracingConsumerInterceptor()

Method Detail

getTracedConsumerRecord

protected abstract TracedConsumerRecord<K,byte[]> getTracedConsumerRecord(org.apache.kafka.clients.consumer.ConsumerRecord<K,byte[]> record)
                                                                   throws ExtractException

Abstract method for extracting original consumer record and tracing context from a received consumer record, which was potentially mutated by a producer interceptor to have a tracing context injected

Parameters:

record - received records, may have trace context injected

Returns:

TracedConsumerRecord

Throws:

ExtractException

onConsume

public org.apache.kafka.clients.consumer.ConsumerRecords<K,byte[]> onConsume(org.apache.kafka.clients.consumer.ConsumerRecords<K,byte[]> records)

Specified by:

onConsume in interface org.apache.kafka.clients.consumer.ConsumerInterceptor<K,byte[]>

onCommit

public void onCommit(Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets)

Specified by:

onCommit in interface org.apache.kafka.clients.consumer.ConsumerInterceptor<K,byte[]>

close

public void close()

Specified by:

close in interface org.apache.kafka.clients.consumer.ConsumerInterceptor<K,byte[]>

configure

public void configure(Map<String,?> configs)

Specified by:

configure in interface org.apache.kafka.common.Configurable