com.yahoo.bard.webservice.web.filters

Class BardLoggingFilter

java.lang.Object

com.yahoo.bard.webservice.web.filters.BardLoggingFilter

All Implemented Interfaces:

javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.client.ClientResponseFilter, javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.container.ContainerResponseFilter, javax.ws.rs.ext.WriterInterceptor

@PreMatching
 @Singleton
 @Priority(value=1)
public class BardLoggingFilter
extends Object
implements javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.container.ContainerResponseFilter, javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.client.ClientResponseFilter, javax.ws.rs.ext.WriterInterceptor

Logs request/response in this format.

    Request: GET, length=-1
     http://localhost:9998/test/data?metrics=pageViews&dateTime=2014-06-11%2F2014-06-12
     > user-agent=Jersey/2.9 (HttpUrlConnection 1.7.0_55)
     > host=localhost:9998
     > accept=text/html, image/gif, image/jpeg, *; q=.2,
     > connection=keep-alive
     < Content-Type=application/json
    Response: 200, OK, 1020.253 ms
    length=2
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_TOTAL_TIMER
static double	MILLISECONDS_PER_NANOSECOND
static String	TOTAL_TIMER
static String	X_REQUEST_ID_HEADER

Constructor Summary

Constructors

Constructor and Description
BardLoggingFilter()

Method Summary

Modifier and Type	Method and Description
void	aroundWriteTo(javax.ws.rs.ext.WriterInterceptorContext writerInterceptorContext) This allows us to compute the length of the output stream when stream is closed.
void	filter(javax.ws.rs.client.ClientRequestContext request) Intercept Client request and add start timestamp.
void	filter(javax.ws.rs.client.ClientRequestContext request, javax.ws.rs.client.ClientResponseContext response)
void	filter(javax.ws.rs.container.ContainerRequestContext request) Intercept the Container request to add length of request and a start timestamp.
void	filter(javax.ws.rs.container.ContainerRequestContext request, javax.ws.rs.container.ContainerResponseContext response) Intercept the Container request/response and log.
protected String	renderUri(URI uri) Render the URI as a string.

Methods inherited from class java.lang.Object

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

Field Detail

MILLISECONDS_PER_NANOSECOND

public static final double MILLISECONDS_PER_NANOSECOND

See Also:

Constant Field Values

TOTAL_TIMER

public static final String TOTAL_TIMER

See Also:

Constant Field Values

CLIENT_TOTAL_TIMER

public static final String CLIENT_TOTAL_TIMER

See Also:

Constant Field Values

X_REQUEST_ID_HEADER

public static final String X_REQUEST_ID_HEADER

See Also:

Constant Field Values

Constructor Detail

BardLoggingFilter

public BardLoggingFilter()

Method Detail

filter

public void filter(javax.ws.rs.container.ContainerRequestContext request)
            throws IOException

Intercept the Container request to add length of request and a start timestamp.

Specified by:

filter in interface javax.ws.rs.container.ContainerRequestFilter

Parameters:

request - Request to intercept

Throws:

IOException - if there's a problem processing the request

filter

public void filter(javax.ws.rs.container.ContainerRequestContext request,
                   javax.ws.rs.container.ContainerResponseContext response)
            throws IOException

Intercept the Container request/response and log.

If output is streamed, also hook the output stream.

Specified by:

filter in interface javax.ws.rs.container.ContainerResponseFilter

Parameters:

request - Request to intercept

response - Response to intercept

Throws:

IOException - if there's a problem processing the request or response

filter

public void filter(javax.ws.rs.client.ClientRequestContext request)
            throws IOException

Intercept Client request and add start timestamp.

Specified by:

filter in interface javax.ws.rs.client.ClientRequestFilter

Parameters:

request - Request to intercept

Throws:

IOException - if there's a problem processing the request

filter

public void filter(javax.ws.rs.client.ClientRequestContext request,
                   javax.ws.rs.client.ClientResponseContext response)
            throws IOException

Specified by:

filter in interface javax.ws.rs.client.ClientResponseFilter

Throws:

IOException

renderUri

protected String renderUri(URI uri)

Render the URI as a string.

Parameters:

uri - The URI to render

Returns:

A String representation of the URI

aroundWriteTo

public void aroundWriteTo(javax.ws.rs.ext.WriterInterceptorContext writerInterceptorContext)
                   throws IOException

This allows us to compute the length of the output stream when stream is closed.

Specified by:

aroundWriteTo in interface javax.ws.rs.ext.WriterInterceptor

Parameters:

writerInterceptorContext - Interceptor to use for intercepting the entity being written

Throws:

IOException - if there's a problem processing the request