com.netflix.spectator.api.histogram

Class BucketCounter

java.lang.Object

com.netflix.spectator.api.histogram.BucketCounter

All Implemented Interfaces:

DistributionSummary, Meter

public final class BucketCounter
extends Object
implements DistributionSummary

Counters that get incremented based on the bucket for recorded values.

Method Summary

Modifier and Type	Method and Description
long	count() Not supported, will always return 0.
static BucketCounter	get(Registry registry, Id id, LongFunction<String> f) Creates a distribution summary object that manages a set of counters based on the bucket function supplied.
boolean	hasExpired() Indicates whether the meter is expired.
Id	id() Identifier used to lookup this meter in the registry.
Iterable<Measurement>	measure() Get the set of measurements for this meter.
void	record(long amount) Updates the statistics kept by the summary with the specified amount.
long	totalAmount() Not supported, will always return 0.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static BucketCounter get(Registry registry,
                                Id id,
                                LongFunction<String> f)

Creates a distribution summary object that manages a set of counters based on the bucket function supplied. Calling record will increment the appropriate counter.

Parameters:

registry - Registry to use.

id - Identifier for the metric being registered.

f - Function to map values to buckets. See BucketFunctions for more information.

Returns:

Distribution summary that manages sub-counters based on the bucket function.

id

public Id id()

Description copied from interface: Meter

Identifier used to lookup this meter in the registry.

Specified by:

id in interface Meter

measure

public Iterable<Measurement> measure()

Description copied from interface: Meter

Get the set of measurements for this meter.

Specified by:

measure in interface Meter

hasExpired

public boolean hasExpired()

Description copied from interface: Meter

Indicates whether the meter is expired. For example, a counter might expire if there is no activity within a given time frame.

Specified by:

hasExpired in interface Meter

record

public void record(long 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()

Not supported, will always return 0.

Specified by:

count in interface DistributionSummary

totalAmount

public long totalAmount()

Not supported, will always return 0.

Specified by:

totalAmount in interface DistributionSummary