Module org.eclipse.jetty.server

Package org.eclipse.jetty.server.handler

Class StatisticsHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.Handler.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

org.eclipse.jetty.server.handler.EventsHandler

org.eclipse.jetty.server.handler.StatisticsHandler

All Implemented Interfaces:

Handler, Handler.Container, Handler.Singleton, Request.Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.util.thread.Invocable

Direct Known Subclasses:

StatisticsHandler.MinimumDataRateHandler

public class StatisticsHandler
extends EventsHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatisticsHandler.MinimumDataRateHandler	Checks that the wrapped handler can read/write at a minimal rate of N bytes per second.

Nested classes/interfaces inherited from class org.eclipse.jetty.server.Handler.Abstract

Handler.Abstract.NonBlocking

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Handler

Handler.Abstract, Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
StatisticsHandler()
StatisticsHandler(Handler handler)

Method Summary

Modifier and Type	Method	Description
protected void	doStart()
void	dump(Appendable out, String indent)
long	getBytesRead()
long	getBytesWritten()
int	getFailures()
int	getHandleActive()
int	getHandleActiveMax()
long	getHandleTimeMax()
double	getHandleTimeMean()
double	getHandleTimeStdDev()
long	getHandleTimeTotal()
int	getHandleTotal()
int	getHandlingFailures()
int	getRequests()	Deprecated. use getRequestTotal() instead.
int	getRequestsActive()
int	getRequestsActiveMax()
long	getRequestTimeMax()
double	getRequestTimeMean()
double	getRequestTimeStdDev()
long	getRequestTimeTotal()
int	getRequestTotal()
int	getResponses1xx()
int	getResponses2xx()
int	getResponses3xx()
int	getResponses4xx()
int	getResponses5xx()
Duration	getStatisticsDuration()
protected void	onAfterHandling(Request request, boolean handled, Throwable failure)	Invoked after application handling (i.e.
protected void	onBeforeHandling(Request request)	Invoked just before calling the server handler tree (i.e.
protected void	onComplete(Request request, int status, org.eclipse.jetty.http.HttpFields headers, Throwable failure)	Invoked when the request and response processing are complete, just before the request and response will be recycled (i.e.
protected void	onRequestRead(Request request, org.eclipse.jetty.io.Content.Chunk chunk)	Invoked every time a request content chunk has been parsed, just before making it available to the application (i.e.
protected void	onResponseWrite(Request request, boolean last, ByteBuffer content)	Invoked before each response content chunk has been written (i.e.
void	reset()

Methods inherited from class org.eclipse.jetty.server.handler.EventsHandler

handle, onComplete, onResponseBegin, onResponseTrailersComplete, onResponseWriteComplete

Methods inherited from class org.eclipse.jetty.server.Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class org.eclipse.jetty.server.Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic, setServer

Methods inherited from class org.eclipse.jetty.server.Handler.Abstract

destroy, doStop, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Destroyable

destroy

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.server.Handler

getServer, setServer

Methods inherited from interface org.eclipse.jetty.server.Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface org.eclipse.jetty.server.Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Constructor Details

StatisticsHandler

public StatisticsHandler()

StatisticsHandler

public StatisticsHandler(Handler handler)

Method Details

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class Handler.Abstract

Throws:

Exception

onBeforeHandling

protected void onBeforeHandling(Request request)

Description copied from class: EventsHandler

Invoked just before calling the server handler tree (i.e. just before the Runnable returned from HttpChannel.onRequest(MetaData.Request) is run).

This is the final state of the request before the handlers are called. This includes any request customization.

Overrides:

onBeforeHandling in class EventsHandler

Parameters:

request - the request object. The read(), demand(Runnable) and fail(Throwable) methods must not be called by the listener.

See Also:

• HttpChannel.onRequest(MetaData.Request)

onAfterHandling

protected void onAfterHandling(Request request,
 boolean handled,
 Throwable failure)

Description copied from class: EventsHandler

Invoked after application handling (i.e. just after the call to the Runnable returned from HttpChannel.onRequest(MetaData.Request) returns).

Overrides:

onAfterHandling in class EventsHandler

Parameters:

request - the request object. The read(), demand(Runnable) and fail(Throwable) methods must not be called by the listener.

handled - if the server handlers handled the request

failure - the exception thrown by the application

See Also:

• HttpChannel.onRequest(MetaData.Request)

onRequestRead

protected void onRequestRead(Request request,
 org.eclipse.jetty.io.Content.Chunk chunk)

Description copied from class: EventsHandler

Invoked every time a request content chunk has been parsed, just before making it available to the application (i.e. from within a call to Request.read()).

Overrides:

onRequestRead in class EventsHandler

Parameters:

request - the request object. The read(), demand(Runnable) and fail(Throwable) methods must not be called by the listener.

chunk - a potentially null request content chunk, including error and Trailers chunks. If a reference to the chunk (or its ByteBuffer) is kept, then Retainable.retain() must be called.

See Also:

• Request.read()

onResponseWrite

protected void onResponseWrite(Request request,
 boolean last,
 ByteBuffer content)

Description copied from class: EventsHandler

Invoked before each response content chunk has been written (i.e. from within the any call to Response.write(boolean, ByteBuffer, Callback)).

Overrides:

onResponseWrite in class EventsHandler

Parameters:

request - the request object. The read(), demand(Runnable) and fail(Throwable) methods must not be called by the listener.

last - indicating last write

content - The ByteBuffer of the response content chunk (readonly).

See Also:

• Response.write(boolean, ByteBuffer, Callback)

onComplete

protected void onComplete(Request request,
 int status,
 org.eclipse.jetty.http.HttpFields headers,
 Throwable failure)

Description copied from class: EventsHandler

Invoked when the request and response processing are complete, just before the request and response will be recycled (i.e. after the Runnable return from HttpChannel.onRequest(MetaData.Request) has returned and the Callback passed to Request.Handler.handle(Request, Response, Callback) has been completed).

Overrides:

onComplete in class EventsHandler

Parameters:

request - the request object. The read(), demand(Runnable) and fail(Throwable) methods must not be called by the listener.

status - the response status.

headers - the immutable fields of the response object.

failure - if there was a failure to complete.

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Overrides:

dump in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

IOException

reset

@ManagedOperation(value="resets the statistics",
                  impact="ACTION")
public void reset()

getRequests

@Deprecated
@ManagedAttribute("number of requests")
public int getRequests()

Deprecated.

use getRequestTotal() instead.

getRequestTotal

@ManagedAttribute("total number of requests")
public int getRequestTotal()

getRequestsActive

@ManagedAttribute("current number of active requests")
public int getRequestsActive()

getRequestsActiveMax

@ManagedAttribute("maximum number of active requests")
public int getRequestsActiveMax()

getRequestTimeTotal

@ManagedAttribute("total time spent in request execution (in ns)")
public long getRequestTimeTotal()

getRequestTimeMax

@ManagedAttribute("maximum request execution time (in ns)")
public long getRequestTimeMax()

getRequestTimeMean

@ManagedAttribute("mean request execution time (in ns)")
public double getRequestTimeMean()

getRequestTimeStdDev

@ManagedAttribute("standard deviation for request execution time (in ns)")
public double getRequestTimeStdDev()

getHandleTotal

@ManagedAttribute("total number of calls to handle()")
public int getHandleTotal()

getHandleActive

@ManagedAttribute("current number of requests in handle()")
public int getHandleActive()

getHandleActiveMax

@ManagedAttribute("maximum number of requests in handle()")
public int getHandleActiveMax()

getHandleTimeMax

@ManagedAttribute("maximum handle() execution time (in ns)")
public long getHandleTimeMax()

getHandleTimeTotal

@ManagedAttribute("total time spent in handle() execution (in ns)")
public long getHandleTimeTotal()

getHandleTimeMean

@ManagedAttribute("mean handle() execution time (in ns)")
public double getHandleTimeMean()

getHandleTimeStdDev

@ManagedAttribute("standard deviation for handle() execution time (in ns)")
public double getHandleTimeStdDev()

getFailures

@ManagedAttribute("number of failed requests")
public int getFailures()

getResponses1xx

@ManagedAttribute("number of requests with 1xx response status")
public int getResponses1xx()

getResponses2xx

@ManagedAttribute("number of requests with 2xx response status")
public int getResponses2xx()

getResponses3xx

@ManagedAttribute("number of requests with 3xx response status")
public int getResponses3xx()

getResponses4xx

@ManagedAttribute("number of requests with 4xx response status")
public int getResponses4xx()

getResponses5xx

@ManagedAttribute("number of requests with 5xx response status")
public int getResponses5xx()

getHandlingFailures

@ManagedAttribute("number of requests that threw an exception from handle()")
public int getHandlingFailures()

getBytesRead

@ManagedAttribute("bytes read count")
public long getBytesRead()

getBytesWritten

@ManagedAttribute("bytes written count")
public long getBytesWritten()

getStatisticsDuration

@ManagedAttribute("duration for which statistics have been collected")
public Duration getStatisticsDuration()