Package org.forgerock.monitoring.dropwizard

Class DropwizardTypes.DescribableHistogram

java.lang.Object

com.codahale.metrics.Histogram

org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableHistogram

All Implemented Interfaces:

com.codahale.metrics.Counting, com.codahale.metrics.Metric, com.codahale.metrics.Sampling, DistributionSummary, Meter, DropwizardTypes.DescribableMetric

Enclosing class:

DropwizardTypes

public static final class DropwizardTypes.DescribableHistogram
extends com.codahale.metrics.Histogram
implements DropwizardTypes.DescribableMetric, DistributionSummary

A describable histogram, implementing both the dropwizard's meter and the monitoring-api's relevant APIs.

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.monitoring.api.instrument.DistributionSummary

DistributionSummary.Builder

Nested classes/interfaces inherited from interface org.forgerock.monitoring.api.instrument.Meter

Meter.Id, Meter.Type

Method Summary

Modifier and Type	Method	Description
long	count()	The number of times that record has been called since this timer was created.
Meter.Id	getId()	Returns A unique combination of name and tags identifying this metric.
double	histogramCountAtValue(long value)
double	max()	The maximum time of a single event.
double	percentile(double percentile)	The value at a specific percentile.
void	record(double amount)	Updates the statistics kept by the summary with the specified amount.
HistogramSnapshot	takeSnapshot(boolean supportsAggregablePercentiles)
String	toString()
double	totalAmount()	The total amount of all recorded events since this summary was created.

Methods inherited from class com.codahale.metrics.Histogram

getCount, getSnapshot, update, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.monitoring.api.instrument.DistributionSummary

mean, measure, record

Method Detail

getId

public Meter.Id getId()

Description copied from interface: DropwizardTypes.DescribableMetric

Returns A unique combination of name and tags identifying this metric.

Specified by:

getId in interface DropwizardTypes.DescribableMetric

Specified by:

getId in interface Meter

Returns:

A unique combination of name and tags identifying this metric

record

public void record(double amount)

Description copied from interface: DistributionSummary

Updates the statistics kept by the summary with the specified amount.

Specified by:

record in interface DistributionSummary

Parameters:

amount - Amount for an event being measured. For example, if the size in bytes of responses from a server. If the amount is less than 0 the value will be dropped.

count

public long count()

Description copied from interface: DistributionSummary

The number of times that record has been called since this timer was created.

Specified by:

count in interface DistributionSummary

totalAmount

public double totalAmount()

Description copied from interface: DistributionSummary

The total amount of all recorded events since this summary was created.

Specified by:

totalAmount in interface DistributionSummary

max

public double max()

Description copied from interface: DistributionSummary

The maximum time of a single event.

Specified by:

max in interface DistributionSummary

percentile

public double percentile(double percentile)

Description copied from interface: DistributionSummary

The value at a specific percentile. This value is non-aggregable across dimensions.

Specified by:

percentile in interface DistributionSummary

histogramCountAtValue

public double histogramCountAtValue(long value)

Specified by:

histogramCountAtValue in interface DistributionSummary

takeSnapshot

public HistogramSnapshot takeSnapshot(boolean supportsAggregablePercentiles)

Specified by:

takeSnapshot in interface DistributionSummary

toString

public String toString()

Overrides:

toString in class Object