A C D E G I J M N O R S T V W

A

addEvent(long) - Method in interface org.avaje.metric.ValueMetric

Add a value (bytes, time, rows etc).

addEventDuration(boolean, long) - Method in interface org.avaje.metric.TimedMetric

Add an event duration in nanoseconds noting if it was a success or failure result.

addEventDuration(String, boolean, long) - Method in interface org.avaje.metric.TimedMetricGroup

Add an event duration in nanoseconds noting if it was a success or failure result.

addEventSince(boolean, long) - Method in interface org.avaje.metric.TimedMetric

Add an event based on a startNanos (determined by System.nanoTime()).

addEventSince(String, boolean, long) - Method in interface org.avaje.metric.TimedMetricGroup

Add an event based on a startNanos (determined by System.nanoTime()).

addSupplier(MetricSupplier) - Static method in class org.avaje.metric.MetricManager

Add a metric supplier to the manager.

addSupplier(MetricSupplier) - Method in interface org.avaje.metric.spi.SpiMetricManager

Add a metric supplier.

AlreadyEnhancedMarker - Annotation Type in org.avaje.metric.spi

Annotation that is used as a marker for classes that are already enhanced.

append(String) - Method in interface org.avaje.metric.MetricName

Create and return another MetricName by appending the suffix.

attributes() - Method in interface org.avaje.metric.TimedMetric

Return extra attributes that can be included in the request logging.

C

clear() - Method in interface org.avaje.metric.Metric

Clear the statistics resetting any internal counters etc.

collect(MetricStatisticsVisitor) - Method in interface org.avaje.metric.Metric

Typically this is only called by the MetricManager and tells the metric to collect its underlying statistics for reporting purposes and in addition resetting and internal counters it has.

collectMetrics() - Method in interface org.avaje.metric.MetricSupplier

Return extra metrics that should be included in metrics reporting.

collectNonEmptyJvmMetrics() - Static method in class org.avaje.metric.MetricManager

Return JVM metrics that are not empty.

collectNonEmptyJvmMetrics() - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the collection of JVM metrics that are non-empty (for reporting).

collectNonEmptyMetrics() - Static method in class org.avaje.metric.MetricManager

Return all the non-JVM registered metrics that are not empty.

collectNonEmptyMetrics() - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the collection of metrics that are considered non-empty.

collectRequestTimings() - Method in interface org.avaje.metric.RequestTimingManager

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

CounterMetric - Interface in org.avaje.metric

Metric based on a counter (long value) typically used to count discrete events.

CounterStatistics - Interface in org.avaje.metric.statistics

Statistics provided by the CounterMetric.

D

decrementCollectionCount() - Method in interface org.avaje.metric.TimedMetric

Decrement the request timing collection count.

E

end(boolean) - Method in interface org.avaje.metric.TimedEvent

End specifying whether the event was successful or in error.

endWithError() - Method in interface org.avaje.metric.TimedEvent

This timed event ended with an error or fault execution (e.g.

endWithSuccess() - Method in interface org.avaje.metric.TimedEvent

This timed event ended with successful execution (e.g.

G

GaugeDouble - Interface in org.avaje.metric

A Gauge returning a double value providing the 'source' for a GaugeDoubleMetric.

GaugeDoubleMetric - Interface in org.avaje.metric

Metric based on a gauge returning double values.

GaugeDoubleStatistics - Interface in org.avaje.metric.statistics

Statistics provided by the GaugeDoubleMetric.

GaugeLong - Interface in org.avaje.metric

A Gauge returning a long value providing the 'source' for a GaugeLongMetric.

GaugeLongMetric - Interface in org.avaje.metric

Metric based on an underlying gauge that reports long values.

GaugeLongStatistics - Interface in org.avaje.metric.statistics

Statistics provided by the GaugeLongMetric.

get(String) - Method in interface org.avaje.metric.MetricNameCache

Return the MetricName from the cache creating it if required.

getAllTimingMetrics(String) - Method in interface org.avaje.metric.RequestTimingManager

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

getBucketRange() - Method in class org.avaje.metric.statistics.TimedAdapter

getBucketRange() - Method in interface org.avaje.metric.statistics.TimedStatistics

Return the bucket range for these statistics.

getBucketRange() - Method in interface org.avaje.metric.TimedMetric

Return the bucket range or empty string if not a bucket.

getCollectionCount() - Method in class org.avaje.metric.TimingMetricInfo

Return the current collection count for this metric.

getCount() - Method in interface org.avaje.metric.CounterMetric

Return the current count.

getCount() - Method in interface org.avaje.metric.statistics.CounterStatistics

Return the count of values collected.

getCount() - Method in class org.avaje.metric.statistics.TimedAdapter

getCount() - Method in interface org.avaje.metric.statistics.ValueStatistics

Return the count of values collected (since the last reset/collection).

getCount() - Method in interface org.avaje.metric.ValueMetric

Return the count of values collected (since the last reset/collection).

getCounterMetric(MetricName) - Static method in class org.avaje.metric.MetricManager

Return a CounterMetric given the name.

getCounterMetric(String) - Static method in class org.avaje.metric.MetricManager

Return a CounterMetric given the name.

getCounterMetric(Class<?>, String) - Static method in class org.avaje.metric.MetricManager

Return a CounterMetric using the Class and name to derive the MetricName.

getCounterMetric(MetricName) - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the CounterMetric using the metric name.

getDepth() - Method in interface org.avaje.metric.RequestTimingEntry

Returns the depth of the entry.

getEndNanos() - Method in interface org.avaje.metric.RequestTimingEntry

Returns the end nanos value for the entry.

getEntries() - Method in interface org.avaje.metric.RequestTiming

Return the entries for the request.

getExecutionNanos() - Method in interface org.avaje.metric.RequestTimingEntry

Return the execution time in nanos for the entry.

getExternalRequestId() - Method in interface org.avaje.metric.RequestTiming

Return the external request id if it had been set.

getJvmMetrics() - Static method in class org.avaje.metric.MetricManager

Return the core JVM metrics.

getJvmMetrics() - Method in interface org.avaje.metric.spi.SpiMetricManager

Return a collection of the JVM metrics.

getMax() - Method in class org.avaje.metric.statistics.TimedAdapter

getMax() - Method in interface org.avaje.metric.statistics.ValueStatistics

Return the Max value collected (since the last reset/collection).

getMax() - Method in interface org.avaje.metric.ValueMetric

Return the Max value collected (since the last reset/collection).

getMean() - Method in class org.avaje.metric.statistics.TimedAdapter

getMean() - Method in interface org.avaje.metric.statistics.ValueStatistics

Return the mean value rounded up for the values collected since the last reset/collection.

getMean() - Method in interface org.avaje.metric.ValueMetric

Return the mean value rounded up for the values collected since the last reset/collection.

getMetric() - Method in interface org.avaje.metric.RequestTimingEntry

Return the metric this entry is from.

getMetricNameCache(Class<?>) - Static method in class org.avaje.metric.MetricManager

Return a MetricNameCache for the given class.

getMetricNameCache(MetricName) - Static method in class org.avaje.metric.MetricManager

Return a MetricNameCache for a given base metric name.

getMetricNameCache(Class<?>) - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the MetricNameCache using the class as a base name.

getMetricNameCache(MetricName) - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the MetricNameCache using a MetricName as a base name.

getMetrics() - Static method in class org.avaje.metric.MetricManager

Return all the non-JVM registered metrics.

getMetrics() - Method in interface org.avaje.metric.spi.SpiMetricManager

Return a collection of all the metrics.

getName() - Method in interface org.avaje.metric.Metric

Return the name of the metric.

getName() - Method in interface org.avaje.metric.statistics.MetricStatistics

Return the associated metric name.

getName() - Method in class org.avaje.metric.statistics.TimedAdapter

getName() - Method in class org.avaje.metric.TimingMetricInfo

Return the metric name.

getReportTime() - Method in interface org.avaje.metric.RequestTiming

Return the time the request was reported.

getRequestTimingCollection() - Method in interface org.avaje.metric.TimedMetric

Return the number of remaining requests to collect detailed timing on.

getRequestTimingMetrics(String) - Method in interface org.avaje.metric.RequestTimingManager

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

getSimpleName() - Method in interface org.avaje.metric.MetricName

Return a simple java like name.

getStartNanos() - Method in interface org.avaje.metric.RequestTimingEntry

Returns the start nanos value for the entry.

getStartTime() - Method in interface org.avaje.metric.statistics.CounterStatistics

Return the time the counter started statistics collection.

getStartTime() - Method in interface org.avaje.metric.statistics.GaugeDoubleStatistics

Return the time the counter started statistics collection.

getStartTime() - Method in interface org.avaje.metric.statistics.GaugeLongStatistics

Return the time the counter started statistics collection.

getStartTime() - Method in class org.avaje.metric.statistics.TimedAdapter

getStartTime() - Method in interface org.avaje.metric.statistics.ValueStatistics

Return the time these statistics were collected from.

getTimedMetric(MetricName, int...) - Static method in class org.avaje.metric.MetricManager

Return a BucketTimedMetric given the name and bucket ranges.

getTimedMetric(Class<?>, String, int...) - Static method in class org.avaje.metric.MetricManager

Return a BucketTimedMetric given the name and bucket ranges.

getTimedMetric(String, int...) - Static method in class org.avaje.metric.MetricManager

Return a BucketTimedMetric given the name and bucket ranges.

getTimedMetric(MetricName) - Static method in class org.avaje.metric.MetricManager

Return a TimedMetric given the name.

getTimedMetric(Class<?>, String) - Static method in class org.avaje.metric.MetricManager

Return a TimedMetric using the Class, name to derive the MetricName.

getTimedMetric(String) - Static method in class org.avaje.metric.MetricManager

Return a TimedMetric given the name.

getTimedMetric(MetricName) - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the TimedMetric using the metric name.

getTimedMetric(MetricName, int...) - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the BucketTimedMetric using the given base metric name and bucketRanges.

getTimedMetric(String) - Method in interface org.avaje.metric.TimedMetricGroup

Return the TimedMetric for the specific name.

getTimedMetricGroup(MetricName) - Static method in class org.avaje.metric.MetricManager

Return the TimedMetricGroup with a based metric name.

getTimedMetricGroup(Class<?>) - Static method in class org.avaje.metric.MetricManager

Return the TimedMetricGroup with a class providing the base metric name.

getTimedMetricGroup(String) - Static method in class org.avaje.metric.MetricManager

Return a TimedMetricGroup with a common group and type name.

getTimedMetricGroup(MetricName) - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the TimedMetricGroup using the given base metric name.

getTotal() - Method in class org.avaje.metric.statistics.TimedAdapter

getTotal() - Method in interface org.avaje.metric.statistics.ValueStatistics

Return the total of all the values (since the last reset/collection).

getTotal() - Method in interface org.avaje.metric.ValueMetric

Return the total of all the values (since the last reset/collection).

getValue() - Method in interface org.avaje.metric.GaugeDouble

Return the current value.

getValue() - Method in interface org.avaje.metric.GaugeDoubleMetric

Return the value.

getValue() - Method in interface org.avaje.metric.GaugeLong

Return the current value.

getValue() - Method in interface org.avaje.metric.GaugeLongMetric

Return the value.

getValue() - Method in interface org.avaje.metric.statistics.GaugeDoubleStatistics

Return the count of values collected.

getValue() - Method in interface org.avaje.metric.statistics.GaugeLongStatistics

Return the count of values collected.

getValueMetric(MetricName) - Static method in class org.avaje.metric.MetricManager

Return a ValueMetric given the name.

getValueMetric(Class<?>, String) - Static method in class org.avaje.metric.MetricManager

Return a ValueMetric using the Class and name to derive the MetricName.

getValueMetric(String) - Static method in class org.avaje.metric.MetricManager

Return a ValueMetric given the name.

getValueMetric(MetricName) - Method in interface org.avaje.metric.spi.SpiMetricManager

Return the ValueMetric using the metric name.

I

isActiveThreadContext() - Method in interface org.avaje.metric.TimedMetric

Return true if this TimedMetric has been pushed onto an active context for this thread.

isBucket() - Method in class org.avaje.metric.statistics.TimedAdapter

isBucket() - Method in interface org.avaje.metric.statistics.TimedStatistics

Return true if this is bucket range based.

isBucket() - Method in interface org.avaje.metric.TimedMetric

Return true if this timed metric is part of a bucket range (and hence only hold statistics for the bucket range returned by bucketRange().

isError() - Method in interface org.avaje.metric.MetricName

Return true if the metric is considered an "error" metric with a name ending in ".error".

J

JvmMetrics - Interface in org.avaje.metric

Standard JVM metrics built in that we often register.

jvmMetrics() - Static method in class org.avaje.metric.MetricManager

Return the built in JVM metrics support to register collection of all or some of the built in JVM metrics.

M

markEvent() - Method in interface org.avaje.metric.CounterMetric

Mark that 1 event has occurred.

markEvents(long) - Method in interface org.avaje.metric.CounterMetric

Mark that numberOfEventsOccurred events have occurred.

Metric - Interface in org.avaje.metric

A Metric that collects statistics on events.

MetricManager - Class in org.avaje.metric

Manages the creation and registration of Metrics.

MetricManager() - Constructor for class org.avaje.metric.MetricManager

MetricName - Interface in org.avaje.metric

The name of the metric.

MetricNameCache - Interface in org.avaje.metric

Cache of MetricNames that share a common base name.

MetricStatistics - Interface in org.avaje.metric.statistics

Common for statistics of all metrics.

MetricStatisticsVisitor - Interface in org.avaje.metric.statistics

Typically used for reporting metrics.

MetricSupplier - Interface in org.avaje.metric

Supplier of additional metrics that should be included in reporting.

N

name(Class<?>, String) - Static method in class org.avaje.metric.MetricManager

Create a MetricName based on a class and name.

name(String) - Static method in class org.avaje.metric.MetricManager

Create a Metric name by parsing a name that is expected to include periods (dot notation similar to package.Class.method).

name(Class<?>, String) - Method in interface org.avaje.metric.spi.SpiMetricManager

Create a MetricName based on the class and name.

name(String) - Method in interface org.avaje.metric.spi.SpiMetricManager

Create a Metric name by parsing a name that is expected to include periods.

O

of(String) - Static method in interface org.avaje.metric.MetricName

Create a Metric name by parsing a name that is expected to include periods (dot notation similar to package.Class.method).

of(Class<?>, String) - Static method in interface org.avaje.metric.MetricName

Create a MetricName based on a class and name.

operationEnd(int, long, boolean) - Method in interface org.avaje.metric.TimedMetric

Add an event duration with opCode indicating success or failure.

operationEnd(int, long) - Method in interface org.avaje.metric.TimedMetric

Add an event duration with opCode indicating success or failure.

org.avaje.metric - package org.avaje.metric

The main public API for Avaje Metrics.

org.avaje.metric.spi - package org.avaje.metric.spi

The service provider API that needs to be implemented by implementors.

org.avaje.metric.statistics - package org.avaje.metric.statistics

R

register(MetricName, GaugeDouble) - Static method in class org.avaje.metric.MetricManager

Create and register a GaugeMetric using the gauge supplied.

register(String, GaugeDouble) - Static method in class org.avaje.metric.MetricManager

Create and register a GaugeMetric using the gauge supplied.

register(MetricName, GaugeLong) - Static method in class org.avaje.metric.MetricManager

Create and register a GaugeCounterMetric using the gauge supplied.

register(String, GaugeLong) - Static method in class org.avaje.metric.MetricManager

Create and register a GaugeCounterMetric using the gauge supplied.

register(MetricName, GaugeDouble) - Method in interface org.avaje.metric.spi.SpiMetricManager

Create and register a GaugeMetric using the gauge supplied (double values).

register(MetricName, GaugeLong) - Method in interface org.avaje.metric.spi.SpiMetricManager

Create and register a GaugeCounterMetric using the gauge supplied (long values).

registerJvmGCMetrics() - Method in interface org.avaje.metric.JvmMetrics

Register metrics for GC activity.

registerJvmMemoryMetrics() - Method in interface org.avaje.metric.JvmMetrics

Register metrics for heap and non-heap memory.

registerJvmOsLoadMetric() - Method in interface org.avaje.metric.JvmMetrics

Register a metric for OS load.

registerJvmProcessMemoryMetrics() - Method in interface org.avaje.metric.JvmMetrics

Register metrics for VMRSS process memory (if supported on the platform).

registerJvmThreadMetrics() - Method in interface org.avaje.metric.JvmMetrics

Register metrics for the total number of threads allocated.

registerLog4JMetrics() - Method in interface org.avaje.metric.JvmMetrics

Register metrics for Log4J error and warning messages.

registerLogbackMetrics() - Method in interface org.avaje.metric.JvmMetrics

Register metrics for Logback error and warning messages.

registerStandardJvmMetrics() - Method in interface org.avaje.metric.JvmMetrics

Register all the standard JVM metrics - memory, threads, gc, os load and process memory.

reportTiming(RequestTiming) - Static method in class org.avaje.metric.MetricManager

When a request completes it is reported to the manager.

reportTiming(RequestTiming) - Method in interface org.avaje.metric.spi.SpiMetricManager

When a request completes it is reported to the manager.

RequestTiming - Interface in org.avaje.metric

Holds the details for a request including it's timing entries.

RequestTimingEntry - Interface in org.avaje.metric

A timing point entry when collecting nested context timing.

requestTimingManager() - Static method in class org.avaje.metric.MetricManager

Return the API for managing request timing.

RequestTimingManager - Interface in org.avaje.metric

API for requesting and

S

setExternalRequestId(String) - Method in interface org.avaje.metric.RequestTiming

Set the external request id (typically obtaining from MDC logging context).

setRequestTimingCollection(String, int) - Method in interface org.avaje.metric.RequestTimingManager

Set request timing on for a metric matching the name.

setRequestTimingCollection(Class<?>, String, int) - Method in interface org.avaje.metric.RequestTimingManager

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

setRequestTimingCollection(int) - Method in interface org.avaje.metric.TimedMetric

Specify to collect per request detailed timing collection.

setRequestTimingCollectionUsingMatch(String, int) - Method in interface org.avaje.metric.RequestTimingManager

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

SpiMetricManager - Interface in org.avaje.metric.spi

The SPI for the underlying implementation that is plugged in via service locator.

start(String) - Method in interface org.avaje.metric.TimedMetricGroup

Start the event for the given name.

startEvent() - Method in interface org.avaje.metric.TimedMetric

Start an event.

startsWith(String) - Method in interface org.avaje.metric.MetricName

Return true if the metric name starts with the given prefix.

T

TimedAdapter - Class in org.avaje.metric.statistics

Can be used by MetricSupplier when adapting metrics from an external source.

TimedAdapter(String, long, long, long, long) - Constructor for class org.avaje.metric.statistics.TimedAdapter

Create with the metric name and values.

TimedEvent - Interface in org.avaje.metric

A TimedEvent that is ended with either success or error.

TimedMetric - Interface in org.avaje.metric

A TimedMetric for measuring execution time for methods and events.

TimedMetricGroup - Interface in org.avaje.metric

A group of TimedMetric that share a common base name.

TimedStatistics - Interface in org.avaje.metric.statistics

Statistics collected by TimedMetric.

TimingMetricInfo - Class in org.avaje.metric

Bean holding timing metric name and collection count.

TimingMetricInfo(String, int) - Constructor for class org.avaje.metric.TimingMetricInfo

Construct with metric name and collection count.

V

ValueMetric - Interface in org.avaje.metric

Metric that collects long values (e.g.

ValueStatistics - Interface in org.avaje.metric.statistics

Statistics collected by ValueMetric or TimedMetric.

visit(MetricStatisticsVisitor) - Method in interface org.avaje.metric.statistics.MetricStatistics

Visit the reporter for the given metric type.

visit(TimedStatistics) - Method in interface org.avaje.metric.statistics.MetricStatisticsVisitor

Visit TimedStatistics.

visit(ValueStatistics) - Method in interface org.avaje.metric.statistics.MetricStatisticsVisitor

Visit ValueStatistics.

visit(CounterStatistics) - Method in interface org.avaje.metric.statistics.MetricStatisticsVisitor

Visit CounterStatistics.

visit(GaugeDoubleStatistics) - Method in interface org.avaje.metric.statistics.MetricStatisticsVisitor

Visit GaugeDoubleStatistics

visit(GaugeLongStatistics) - Method in interface org.avaje.metric.statistics.MetricStatisticsVisitor

Visit GaugeLongStatistics.

visit(MetricStatisticsVisitor) - Method in class org.avaje.metric.statistics.TimedAdapter

W

withLogMetricName(String, String) - Method in interface org.avaje.metric.JvmMetrics

Set the names of the metrics for logging errors and warnings.

withReportAlways() - Method in interface org.avaje.metric.JvmMetrics

Set to report the metrics irrespective of whether the metric has changed.

withReportChangesOnly() - Method in interface org.avaje.metric.JvmMetrics

Set to only report when the metrics change.

A C D E G I J M N O R S T V W