com.netflix.hystrix

Class HystrixCollapserMetrics

java.lang.Object

com.netflix.hystrix.HystrixMetrics

com.netflix.hystrix.HystrixCollapserMetrics

public class HystrixCollapserMetrics
extends HystrixMetrics

Used by HystrixCollapser to record metrics. HystrixEventNotifier not hooked up yet. It may be in the future.

Field Summary

Fields inherited from class com.netflix.hystrix.HystrixMetrics

counter

Method Summary

Methods

Modifier and Type	Method and Description
int	getBatchSizeMean()
int	getBatchSizePercentile(double percentile) Retrieve the batch size for the HystrixCollapser being invoked at a given percentile.
HystrixCollapserKey	getCollapserKey() HystrixCollapserKey these metrics represent.
static HystrixCollapserMetrics	getInstance(HystrixCollapserKey key, HystrixCollapserProperties properties) Get or create the HystrixCollapserMetrics instance for a given HystrixCollapserKey.
static java.util.Collection<HystrixCollapserMetrics>	getInstances() All registered instances of HystrixCollapserMetrics
HystrixCollapserProperties	getProperties()
int	getShardSizeMean()
int	getShardSizePercentile(double percentile) Retrieve the shard size for the HystrixCollapser being invoked at a given percentile.
void	markBatch(int batchSize)
void	markRequestBatched()
void	markResponseFromCache()
void	markShards(int numShards)

Methods inherited from class com.netflix.hystrix.HystrixMetrics

getCumulativeCount, getRollingCount

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static HystrixCollapserMetrics getInstance(HystrixCollapserKey key,
                                  HystrixCollapserProperties properties)

Get or create the HystrixCollapserMetrics instance for a given HystrixCollapserKey.

This is thread-safe and ensures only 1 HystrixCollapserMetrics per HystrixCollapserKey.

Parameters:

key - HystrixCollapserKey of HystrixCollapser instance requesting the HystrixCollapserMetrics

Returns:

HystrixCollapserMetrics

getInstances

public static java.util.Collection<HystrixCollapserMetrics> getInstances()

All registered instances of HystrixCollapserMetrics

Returns:

Collection<HystrixCollapserMetrics>

getCollapserKey

public HystrixCollapserKey getCollapserKey()

HystrixCollapserKey these metrics represent.

Returns:

HystrixCollapserKey

getProperties

public HystrixCollapserProperties getProperties()

getBatchSizePercentile

public int getBatchSizePercentile(double percentile)

Retrieve the batch size for the HystrixCollapser being invoked at a given percentile.

Percentile capture and calculation is configured via HystrixCollapserProperties.metricsRollingStatisticalWindowInMilliseconds() and other related properties.

Parameters:

percentile - Percentile such as 50, 99, or 99.5.

Returns:

batch size

getBatchSizeMean

public int getBatchSizeMean()

getShardSizePercentile

public int getShardSizePercentile(double percentile)

Retrieve the shard size for the HystrixCollapser being invoked at a given percentile.

Percentile capture and calculation is configured via HystrixCollapserProperties.metricsRollingStatisticalWindowInMilliseconds() and other related properties.

Parameters:

percentile - Percentile such as 50, 99, or 99.5.

Returns:

batch size

getShardSizeMean

public int getShardSizeMean()

markRequestBatched

public void markRequestBatched()

markResponseFromCache

public void markResponseFromCache()

markBatch

public void markBatch(int batchSize)

markShards

public void markShards(int numShards)