com.sonicsw.esb.service.common.metrics
Class MetricsBuilder

java.lang.Object
  com.sonicsw.esb.service.common.metrics.MetricsBuilder

public class MetricsBuilder
extends java.lang.Object

Builds various kinds of metrics.

Constructor Summary

MetricsBuilder()

Method Summary

MetricDescriptor	buildAverageMetric(java.lang.String name) Builds a simple metric which computes the average value since the last metric reset.
MetricDescriptor	buildMaxValueMetric(java.lang.String name) Builds a simple metric which keeps track of the highest value since the last metric reset.
MetricDescriptor	buildMetric(java.lang.String name) Builds a simple value metric.
MetricDescriptor	buildMinValueMetric(java.lang.String name) Builds a simple metric which keeps track of the lowest value since the last metric reset.
MetricDescriptor	buildPerMinuteRateMetric(java.lang.String name) Builds an historical metric to measure a per-minute rate.
MetricDescriptor	buildPerSecondRateMetric(java.lang.String name) Builds an historical metric to measure a per-second rate.
MetricDescriptor	buildRollingAverageMetric(java.lang.String name) Builds an historical metric which computes the average increment over a collection interval.
MetricDescriptor	buildRollingMaxValueMetric(java.lang.String name) Builds an historical metric which keeps track of the highest value over a collection interval.
MetricDescriptor	buildRollingMinValueMetric(java.lang.String name) Builds an historical metric which keeps track of the lowest value over a collection interval.
MetricDescriptor	buildTotalValueMetric(java.lang.String name) Builds a simple metric which keeps a running total of all values.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsBuilder

public MetricsBuilder()

Method Detail

buildMetric

public MetricDescriptor buildMetric(java.lang.String name)

Builds a simple value metric. Updating this metric sets the current value.

buildTotalValueMetric

public MetricDescriptor buildTotalValueMetric(java.lang.String name)

Builds a simple metric which keeps a running total of all values. Updating this metric adds to the current total.

buildMaxValueMetric

public MetricDescriptor buildMaxValueMetric(java.lang.String name)

Builds a simple metric which keeps track of the highest value since the last metric reset. Updating this metric compares the new value with the current value and keeps whichever is higher.

buildMinValueMetric

public MetricDescriptor buildMinValueMetric(java.lang.String name)

Builds a simple metric which keeps track of the lowest value since the last metric reset. Updating this metric compares the new value with the current value and keeps whichever is lower.

buildAverageMetric

public MetricDescriptor buildAverageMetric(java.lang.String name)

Builds a simple metric which computes the average value since the last metric reset. Updating this metric adds to the current total and increments the update count so that the average can be computed. Note that calling getCurrentMetricValue will return the current total rather than the computed average.

buildRollingMaxValueMetric

public MetricDescriptor buildRollingMaxValueMetric(java.lang.String name)

Builds an historical metric which keeps track of the highest value over a collection interval. Updating this metric sets the current value.

buildRollingMinValueMetric

public MetricDescriptor buildRollingMinValueMetric(java.lang.String name)

Builds an historical metric which keeps track of the lowest value over a collection interval. Updating this metric sets the current value.

buildRollingAverageMetric

public MetricDescriptor buildRollingAverageMetric(java.lang.String name)

Builds an historical metric which computes the average increment over a collection interval. Updating this metric adds to the current total.

buildPerSecondRateMetric

public MetricDescriptor buildPerSecondRateMetric(java.lang.String name)

Builds an historical metric to measure a per-second rate. This metric tracks the change in total value over each refresh interval and computes the rate of change per second. Updating this metric adds to the current total.

buildPerMinuteRateMetric

public MetricDescriptor buildPerMinuteRateMetric(java.lang.String name)

Builds an historical metric to measure a per-minute rate. This metric tracks the change in total value over each refresh interval and computes the rate of change per minute. Updating this metric adds to the current total.