com.linecorp.armeria.server.logging.structured.kafka

Class KafkaStructuredLoggingService<I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L>

java.lang.Object

com.linecorp.armeria.server.DecoratingService<I,O,I,O>

com.linecorp.armeria.server.SimpleDecoratingService<I,O>

com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>

com.linecorp.armeria.server.logging.structured.kafka.KafkaStructuredLoggingService<I,O,L>

All Implemented Interfaces:

com.linecorp.armeria.server.Service<I,O>

public class KafkaStructuredLoggingService<I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L>
extends com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>

Kafka backend for service log logging. This class enable Kafka as a service log logging 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.

Refer variety of newDecorator(org.apache.kafka.clients.producer.Producer<byte[], L>, java.lang.String, com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L>, com.linecorp.armeria.server.logging.structured.kafka.KafkaStructuredLoggingService.KeySelector<L>) methods to see how to enable Kafka based structured logging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KafkaStructuredLoggingService.KeySelector<E> Implements "key" selector of Kafka based service log writer.

Method Summary

Modifier and Type	Method and Description
protected void	close()
static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>>	newDecorator(Producer<byte[],L> producer, String topic, com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder) Creates a decorator which provides StructuredLoggingService with defaulting key to null.
static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>>	newDecorator(Producer<byte[],L> producer, String topic, com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder, KafkaStructuredLoggingService.KeySelector<L> keySelector) Creates a decorator which provides StructuredLoggingService with full set of arguments.
static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>>	newDecorator(String bootstrapServers, String topic, com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder) Creates a decorator which provides StructuredLoggingService with default Producer and defaulting key to null.
static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>>	newDecorator(String bootstrapServers, String topic, com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder, KafkaStructuredLoggingService.KeySelector<L> keySelector) Creates a decorator which provides StructuredLoggingService with default Producer.
protected void	writeLog(com.linecorp.armeria.common.logging.RequestLog log, L structuredLog)

Methods inherited from class com.linecorp.armeria.server.logging.structured.StructuredLoggingService

serve, serviceAdded

Methods inherited from class com.linecorp.armeria.server.DecoratingService

as, delegate, shouldCachePath, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.Service

decorate, decorate, decorate

Method Detail

newDecorator

public static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>> newDecorator(Producer<byte[],L> producer,
                                                                                                                                                                                                                                                              String topic,
                                                                                                                                                                                                                                                              com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder,
                                                                                                                                                                                                                                                              @Nullable
                                                                                                                                                                                                                                                              KafkaStructuredLoggingService.KeySelector<L> keySelector)

Creates a decorator which provides StructuredLoggingService with full set of arguments.

Type Parameters:

I - the Request type

O - the Response type

L - the type of the structured log representation

Parameters:

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

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

logBuilder - an instance of StructuredLogBuilder which is used to construct a log entry

keySelector - a KafkaStructuredLoggingService.KeySelector which is used to decide what key to use for the log

Returns:

a service decorator which adds structured logging support integrated to Kafka

newDecorator

public static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>> newDecorator(Producer<byte[],L> producer,
                                                                                                                                                                                                                                                              String topic,
                                                                                                                                                                                                                                                              com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder)

Creates a decorator which provides StructuredLoggingService with defaulting key to null.

Type Parameters:

I - the Request type

O - the Response type

L - the type of the structured log representation

Parameters:

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

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

logBuilder - an instance of StructuredLogBuilder which is used to construct a log entry

Returns:

a service decorator which adds structured logging support integrated to Kafka

newDecorator

public static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>> newDecorator(String bootstrapServers,
                                                                                                                                                                                                                                                              String topic,
                                                                                                                                                                                                                                                              com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder,
                                                                                                                                                                                                                                                              @Nullable
                                                                                                                                                                                                                                                              KafkaStructuredLoggingService.KeySelector<L> keySelector)

Creates a decorator which provides StructuredLoggingService with default Producer.

Type Parameters:

I - the Request type

O - the Response type

L - the type of the structured log representation

Parameters:

bootstrapServers - a bootstrap.servers config to specify destination Kafka cluster

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

logBuilder - an instance of StructuredLogBuilder which is used to construct a log entry

keySelector - a KafkaStructuredLoggingService.KeySelector which is used to decide what key to use for the log

Returns:

a service decorator which adds structured logging support integrated to Kafka

newDecorator

public static <I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L> Function<com.linecorp.armeria.server.Service<I,O>,com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I,O,L>> newDecorator(String bootstrapServers,
                                                                                                                                                                                                                                                              String topic,
                                                                                                                                                                                                                                                              com.linecorp.armeria.server.logging.structured.StructuredLogBuilder<L> logBuilder)

Creates a decorator which provides StructuredLoggingService with default Producer and defaulting key to null.

Type Parameters:

I - the Request type

O - the Response type

L - the type of the structured log representation

Parameters:

bootstrapServers - a bootstrap.servers config to specify destination Kafka cluster

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

logBuilder - an instance of StructuredLogBuilder which is used to construct a log entry

Returns:

a service decorator which adds structured logging support integrated to Kafka

writeLog

protected void writeLog(com.linecorp.armeria.common.logging.RequestLog log,
                        L structuredLog)

Specified by:

writeLog in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L>

close

protected void close()

Overrides:

close in class com.linecorp.armeria.server.logging.structured.StructuredLoggingService<I extends com.linecorp.armeria.common.Request,O extends com.linecorp.armeria.common.Response,L>