com.linecorp.armeria.server.logging.structured

Class StructuredLoggingService<L>

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Service<T_I,T_O>>

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

com.linecorp.armeria.server.SimpleDecoratingService<HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingHttpService

com.linecorp.armeria.server.logging.structured.StructuredLoggingService<L>

Type Parameters:

L - the type of the structured log representation

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public abstract class StructuredLoggingService<L>
extends SimpleDecoratingHttpService

A decorating service which provides support of structured and optionally externalized request/response content logging.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StructuredLoggingService(HttpService delegate, StructuredLogBuilder<L> logBuilder) Creates a new StructuredLoggingService.

Method Summary

Modifier and Type	Method and Description
protected void	close() Cleanup resources which were opened for logging.
HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req) Serves an incoming Request.
void	serviceAdded(ServiceConfig cfg) Invoked when this service has been added to a Server with the specified configuration.
protected abstract void	writeLog(RequestLog log, L structuredLog) Writes given structuredLog to the underlying system.

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

shouldCachePath

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, delegate, 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.HttpService

decorate, decorate

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

as, decorate, shouldCachePath

Constructor Detail

StructuredLoggingService

protected StructuredLoggingService(HttpService delegate,
                                   StructuredLogBuilder<L> logBuilder)

Creates a new StructuredLoggingService.

Parameters:

delegate - the HttpService being decorated

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

Method Detail

serviceAdded

public void serviceAdded(ServiceConfig cfg)
                  throws Exception

Description copied from interface: Service

Invoked when this service has been added to a Server with the specified configuration. Please note that this method can be invoked more than once if this service has been added more than once.

Specified by:

serviceAdded in interface Service<HttpRequest,HttpResponse>

Overrides:

serviceAdded in class DecoratingService<HttpRequest,HttpResponse,HttpRequest,HttpResponse>

Throws:

Exception

serve

public HttpResponse serve(ServiceRequestContext ctx,
                          HttpRequest req)
                   throws Exception

Description copied from interface: Service

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception

writeLog

protected abstract void writeLog(RequestLog log,
                                 L structuredLog)

Writes given structuredLog to the underlying system.

Parameters:

log - the RequestLog which is a source of constructed structuredLog

structuredLog - the content of a structuredLog

close

protected void close()

Cleanup resources which were opened for logging.