Package com.linecorp.armeria.server.logging.kafka

Class KafkaAccessLogWriter<K,V>

java.lang.Object

com.linecorp.armeria.server.logging.kafka.KafkaAccessLogWriter<K,V>

All Implemented Interfaces:

AccessLogWriter

public final class KafkaAccessLogWriter<K,V>
extends Object
implements AccessLogWriter

An AccessLogWriter that sends access logs to a Kafka backend.

This method returns immediately after the Producer.send(ProducerRecord, Callback) returns rather than waiting for returned Future completes so logs which are written and are not yet flushed can be lost if an application crashes in unclean way.

Constructor Summary

Constructors

Constructor	Description
KafkaAccessLogWriter(Producer<K,V> producer, String topic, Function<? super RequestLog,? extends K> keyExtractor, Function<? super RequestLog,? extends V> valueExtractor)	Creates a new instance.
KafkaAccessLogWriter(Producer<K,V> producer, String topic, Function<? super RequestLog,? extends V> valueExtractor)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	log(RequestLog log)	Logs the specified RequestLog.
CompletableFuture<Void>	shutdown()	Shuts down this AccessLogWriter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.logging.AccessLogWriter

andThen

Constructor Details

KafkaAccessLogWriter

public KafkaAccessLogWriter(Producer<K,V> producer, String topic, Function<? super RequestLog,? extends V> valueExtractor)

Creates a new instance.

Parameters:

producer - a Kafka Producer which is used to send logs to Kafka

topic - the name of topic which is used to send logs

valueExtractor - a Function that extracts a V-typed record value from a RequestLog. The Function is allowed to return null to skip logging for the given RequestLog.

KafkaAccessLogWriter

public KafkaAccessLogWriter(Producer<K,V> producer, String topic, Function<? super RequestLog,? extends K> keyExtractor, Function<? super RequestLog,? extends V> valueExtractor)

Creates a new instance.

Parameters:

producer - a Kafka Producer which is used to send logs to Kafka

topic - the name of topic which is used to send logs

keyExtractor - a Function that extracts a K-typed record key from a RequestLog. The Function is allowed to return null to leave the record key unspecified.

valueExtractor - a Function that extracts a V-typed record value from a RequestLog. The Function is allowed to return null to skip logging for the given RequestLog.

Method Details

log

public void log(RequestLog log)

Description copied from interface: AccessLogWriter

Logs the specified RequestLog.

Specified by:

log in interface AccessLogWriter

shutdown

public CompletableFuture<Void> shutdown()

Description copied from interface: AccessLogWriter

Shuts down this AccessLogWriter.

Specified by:

shutdown in interface AccessLogWriter

Returns:

the CompletableFuture which is completed when this AccessLogWriter has been shut down.