org.avaje.metric

Interface RequestTimingManager

All Known Subinterfaces:

SpiMetricManager

public interface RequestTimingManager

API for requesting and

Method Summary

Modifier and Type	Method and Description
List<RequestTiming>	collectRequestTimings() Return the request timings that have been collected since the last collection.
List<TimingMetricInfo>	getAllTimingMetrics(String nameMatchExpression) Return the list of all timing metrics that match the name expression.
List<TimingMetricInfo>	getRequestTimingMetrics(String nameMatchExpression) Return all the timing metrics that are currently collecting per request timings and whose name matches the name expression.
boolean	setRequestTimingCollection(Class<?> cls, String name, int collectionCount) Set request timing on for a metric matching the class and name.
boolean	setRequestTimingCollection(String metricName, int collectionCount) Set request timing on for a metric matching the name.
List<TimingMetricInfo>	setRequestTimingCollectionUsingMatch(String nameMatchExpression, int collectionCount) Set request timing on all the timed metrics whose name starts with a given prefix.

Method Detail

collectRequestTimings

List<RequestTiming> collectRequestTimings()

Return the request timings that have been collected since the last collection.

getRequestTimingMetrics

List<TimingMetricInfo> getRequestTimingMetrics(String nameMatchExpression)

Return all the timing metrics that are currently collecting per request timings and whose name matches the name expression.

If the name match expression is null or empty then all timing metrics are returned.

These are TimingMetric that have TimedMetric.getRequestTimingCollection() greater than 0.

Example name match expressions:

  // starts with web.
  "web.*"

  // end with resource
  "*resource"

  // starts with web. and contains customer
  "web.*customer*"

  // starts with web. and contains customer and ends with resource
  "web.*customer*resource"

Parameters:

nameMatchExpression - the expression used to match/filter metric names. Null or empty means match all.

Returns:

timing metrics that are actively collecting request timings.

getAllTimingMetrics

List<TimingMetricInfo> getAllTimingMetrics(String nameMatchExpression)

Return the list of all timing metrics that match the name expression.

If the name match expression is null or empty then all timing metrics are returned.

Example name match expressions:

  // starts with web.
  "web.*"

  // end with resource
  "*resource"

  // starts with web. and contains customer
  "web.*customer*"

  // starts with web. and contains customer and ends with resource
  "web.*customer*resource"

Parameters:

nameMatchExpression - the expression used to match/filter metric names. Null or empty means match all.

Returns:

all timing metrics those name matches the expression.

setRequestTimingCollection

boolean setRequestTimingCollection(String metricName,
                                   int collectionCount)

Set request timing on for a metric matching the name.

Parameters:

collectionCount - the number of requests to collect request timings for

Returns:

true if request timing was set, false if the metric was not found.

setRequestTimingCollection

boolean setRequestTimingCollection(Class<?> cls,
                                   String name,
                                   int collectionCount)

Set request timing on for a metric matching the class and name.

Parameters:

collectionCount - the number of requests to collect request timings for

Returns:

true if request timing was set, false if the metric was not found.

setRequestTimingCollectionUsingMatch

List<TimingMetricInfo> setRequestTimingCollectionUsingMatch(String nameMatchExpression,
                                                            int collectionCount)

Set request timing on all the timed metrics whose name starts with a given prefix.

If for example all the web endpoints have a prefix of "web." then these can all be set to collect say 10 requests.

Example name match expressions:

  // starts with web.
  "web.*"

  // end with resource
  "*resource"

  // starts with web. and contains customer
  "web.*customer*"

  // starts with web. and contains customer and ends with resource
  "web.*customer*resource"

Parameters:

nameMatchExpression - The expression used to match timing metrics

collectionCount - The number of requests to collect

Returns:

The timing metrics that had the request timing collection set