StreamingStatsFilter

A filter to export statistics for HTTP streaming requests and responses. A streaming request/response is an HTTP request/response with isChunked set to true.

This filter is included in HTTP stack by default, all metrics defined in this filter are only populated for HTTP streaming requests/responses.

Stats: ---------------Request Stream------------

stream/request/duration_ms: A histogram of the duration of the lifetime of request streams, from the time a stream is initialized until it's closed, in milliseconds. ---------------Response Stream-----------
stream/response/duration_ms: A histogram of the duration of the lifetime of response streams, from the time a stream is initialized until it's closed, in milliseconds. Counters: ---------------Request Stream------------
stream/request/closed: A counter of the number of closed request streams.
stream/request/failures A counter of the number of times any failure has been observed in the middle of a request stream.
stream/request/failures/<exception_name>: A counter of the number of times a specific exception has been thrown in the middle of a request stream.
stream/request/opened: A counter of the number of opened request streams. ---------------Response Stream-----------
stream/response/closed: A counter of the number of closed response streams.
stream/response/failures A counter of the number of times any failure has been observed in the middle of a response stream.
stream/response/failures/<exception_name>: A counter of the number of times a specific exception has been thrown in the middle of a response stream.
stream/response/opened: A counter of the number of opened response streams. Gauges: ---------------Request Stream------------
stream/request/pending: A gauge of the number of pending request streams. ---------------Response Stream------------
stream/response/pending: A gauge of the number of pending response streams.

You could derive the streaming success rate of:

the total number of streams number of successful streams divided by number of total streams
closed streams number of successful streams divided by number of closed streams Here we assume a success stream as a stream terminated without an exception or a stream that has not terminated yet.

Take request stream as an example, assuming your counters are not "latched", which means that their values are monotonically increasing:

Success rate of total number of streams: 1 - (rated_counter(stream/request/failures) / (gauge(stream/request/pending) + rated_counter(stream/request/closed)))
Success rate of number of closed streams: 1 - (rated_counter(stream/request/failures) / rated_counter(stream/request/closed))

Linear Supertypes

SimpleFilter[Request, Response], Filter[Request, Response, Request, Response], (Request, Service[Request, Response]) ⇒ Future[Response], AnyRef, Any

Instance Constructors

new StreamingStatsFilter(stats: StatsReceiver, exceptionStatsHandler: ExceptionStatsHandler, nowMillis: () ⇒ Long = Stopwatch.systemMillis)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def agnosticAndThen(next: TypeAgnostic): Filter[Request, Response, Request, Response]

Definition Classes
Filter
def andThen(factory: ServiceFactory[Request, Response]): ServiceFactory[Request, Response]

Definition Classes
Filter
def andThen(service: Service[Request, Response]): Service[Request, Response]

Definition Classes
Filter
def andThen[Req2, Rep2](next: Filter[Request, Response, Req2, Rep2]): Filter[Request, Response, Req2, Rep2]

Definition Classes
Filter
def andThenIf[Req2 >: Request, Rep2 <: Response](condAndFilter: (Boolean, Filter[Request, Response, Req2, Rep2])): Filter[Request, Response, Req2, Rep2]

Definition Classes
Filter
def andThenIf[Req2 >: Request, Rep2 <: Response](conditional: Boolean, filter: Filter[Request, Response, Req2, Rep2]): Filter[Request, Response, Req2, Rep2]

Definition Classes
Filter
def apply(request: Request, service: Service[Request, Response]): Future[Response]

Definition Classes
StreamingStatsFilter → Filter → Function2
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def curried: (Request) ⇒ (Service[Request, Response]) ⇒ Future[Response]

Definition Classes
Function2
Annotations
@unspecialized()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Filter → Function2 → AnyRef → Any
def tupled: ((Request, Service[Request, Response])) ⇒ Future[Response]

Definition Classes
Function2
Annotations
@unspecialized()
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object StreamingStatsFilter | package filter

class StreamingStatsFilter extends SimpleFilter[Request, Response]

Instance Constructors

new StreamingStatsFilter(stats: StatsReceiver, exceptionStatsHandler: ExceptionStatsHandler, nowMillis: () ⇒ Long = Stopwatch.systemMillis)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def agnosticAndThen(next: TypeAgnostic): Filter[Request, Response, Request, Response]

def andThen(factory: ServiceFactory[Request, Response]): ServiceFactory[Request, Response]

def andThen(service: Service[Request, Response]): Service[Request, Response]

def andThen[Req2, Rep2](next: Filter[Request, Response, Req2, Rep2]): Filter[Request, Response, Req2, Rep2]

def andThenIf[Req2 >: Request, Rep2 <: Response](condAndFilter: (Boolean, Filter[Request, Response, Req2, Rep2])): Filter[Request, Response, Req2, Rep2]

def andThenIf[Req2 >: Request, Rep2 <: Response](conditional: Boolean, filter: Filter[Request, Response, Req2, Rep2]): Filter[Request, Response, Req2, Rep2]

def apply(request: Request, service: Service[Request, Response]): Future[Response]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def curried: (Request) ⇒ (Service[Request, Response]) ⇒ Future[Response]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def tupled: ((Request, Service[Request, Response])) ⇒ Future[Response]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from SimpleFilter[Request, Response]

Inherited from Filter[Request, Response, Request, Response]

Inherited from (Request, Service[Request, Response]) ⇒ Future[Response]

Inherited from AnyRef

Inherited from Any

Ungrouped