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

  • Constructor Details

    • StatisticsHandler

      public StatisticsHandler()

    • StatisticsHandler

      public StatisticsHandler(Handler handler)

  • Method Details

    • 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:

    • 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:

    • 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:

    • onResponseBegin

      protected void onResponseBegin(Request request, int status, org.eclipse.jetty.http.HttpFields headers)
      Description copied from class: EventsHandler
      Invoked just before the response is line written to the network (i.e. from within the first call to Response.write(boolean, ByteBuffer, Callback)).
      Overrides:
      onResponseBegin 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
      See Also:

    • 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:

    • onComplete

      protected void onComplete(Request request, 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.
      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

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

    • getRequestsActive

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

    • getRequestsActiveMax

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

    • 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 during handling") public int getHandlingFailures()

    • getRequestTimeTotal

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

    • getRequestTimeMax

      @ManagedAttribute("maximum time spend executing requests (in ns)") public long getRequestTimeMax()

    • getRequestTimeMean

      @ManagedAttribute("mean time spent executing requests (in ns)") public double getRequestTimeMean()

    • getRequestTimeStdDev

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

    • getBytesRead

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

    • getBytesWritten

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