Package org.forgerock.openig.filter

Class MetricsFilter

java.lang.Object

org.forgerock.openig.filter.MetricsFilter

All Implemented Interfaces:

Filter

public class MetricsFilter
extends Object
implements Filter

Collect request processing metrics.

Constructor Summary

Constructors

Constructor	Description
MetricsFilter(org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry)	Construct a MetricsFilter with meters registered with the supplied MeterRegistry.

Method Summary

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.
long	getActiveRequestCount()	Get the active request count.
long	getErrorsResponseCount()	Get the errors response count.
long	getNullResponseCount()	Get the null response count.
org.forgerock.monitoring.api.instrument.Timer	getResponseTime()	Get the response time.
long	getStatusResponseCount(Status.Family family)	Get the response count by status family.
long	getTotalRequestCount()	Get the total request count.
long	getTotalResponseCount()	Get the total response count.

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsFilter

public MetricsFilter(org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry)

Construct a MetricsFilter with meters registered with the supplied MeterRegistry.

Parameters:

meterRegistry - MeterRegistry to manage the meters

Method Details

filter

public Promise<Response,NeverThrowsException> filter(Context context,
 Request request,
 Handler next)

Description copied from interface: Filter

Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls next.handle(context, request).

This method may elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to next.handle(context, request) and creating its own response object. The filter is also at liberty to replace a response with another of its own by intercepting the response returned by the next handler.

Specified by:

filter in interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.

getTotalResponseCount

public long getTotalResponseCount()

Get the total response count.

Returns:

the total response count

getErrorsResponseCount

public long getErrorsResponseCount()

Get the errors response count.

Returns:

the errors response count

getNullResponseCount

public long getNullResponseCount()

Get the null response count.

Returns:

the null response count

getTotalRequestCount

public long getTotalRequestCount()

Get the total request count.

Returns:

the total request count

getStatusResponseCount

public long getStatusResponseCount(Status.Family family)

Get the response count by status family.

Parameters:

family - the status family

Returns:

the response count by status family

getActiveRequestCount

public long getActiveRequestCount()

Get the active request count.

Returns:

the active request count

getResponseTime

public org.forgerock.monitoring.api.instrument.Timer getResponseTime()

Get the response time.

Returns:

the response time