com.alibaba.csp.sentinel.slots.statistic.metric

Class ArrayMetric

java.lang.Object

com.alibaba.csp.sentinel.slots.statistic.metric.ArrayMetric

All Implemented Interfaces:

DebugSupport, Metric

public class ArrayMetric
extends Object
implements Metric

The basic metric class in Sentinel using a BucketLeapArray internal.

Author:

jialiang.linjl, Eric Zhao

Constructor Summary

Constructors

Constructor and Description
ArrayMetric(int sampleCount, int intervalInMs)
ArrayMetric(int sampleCount, int intervalInMs, boolean enableOccupy)
ArrayMetric(LeapArray<MetricBucket> array) For unit test.

Method Summary

Modifier and Type	Method and Description
void	add(MetricEvent event, long count)
void	addBlock(int count) Add current block count.
void	addException(int count) Add current exception count.
void	addOccupiedPass(int acquireCount) Add occupied pass, which represents pass requests that borrow the latter windows' token.
void	addPass(int count) Add current pass count.
void	addRT(long rt) Add given RT to current total RT.
void	addSuccess(int count) Add current completed count.
void	addWaiting(long time, int acquireCount) Add request that occupied.
long	block() Get total block count.
void	debug() For debug;
List<MetricNode>	details() Get aggregated metric nodes of all resources.
List<MetricNode>	detailsOnCondition(Predicate<Long> timePredicate) Generate aggregated metric items that satisfies the time predicate.
long	exception() Get total exception count.
double	getAvg(MetricEvent event) Get average count for provided event per second.
long	getCurrentCount(MetricEvent event)
int	getSampleCount() Get sample count of the sliding window.
long	getSum(MetricEvent event) Get total sum for provided event in intervalInSec.
double	getWindowIntervalInSec() Get the sliding window length in seconds.
long	getWindowPass(long timeMillis) Note: this operation will not perform refreshing, so will not generate new buckets.
long	maxSuccess() Get max success count.
long	minRt() Get the minimal RT.
long	occupiedPass() Get occupied pass count.
long	pass() Get total pass count.
long	previousWindowBlock()
long	previousWindowPass()
long	rt() Get total response time.
long	success() Get total success count.
long	waiting() Get waiting pass account
MetricBucket[]	windows() Get the raw window array.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayMetric

public ArrayMetric(int sampleCount,
                   int intervalInMs)

ArrayMetric

public ArrayMetric(int sampleCount,
                   int intervalInMs,
                   boolean enableOccupy)

ArrayMetric

public ArrayMetric(LeapArray<MetricBucket> array)

For unit test.

Method Detail

success

public long success()

Description copied from interface: Metric

Get total success count.

Specified by:

success in interface Metric

Returns:

success count

maxSuccess

public long maxSuccess()

Description copied from interface: Metric

Get max success count.

Specified by:

maxSuccess in interface Metric

Returns:

max success count

exception

public long exception()

Description copied from interface: Metric

Get total exception count.

Specified by:

exception in interface Metric

Returns:

exception count

block

public long block()

Description copied from interface: Metric

Get total block count.

Specified by:

block in interface Metric

Returns:

block count

pass

public long pass()

Description copied from interface: Metric

Get total pass count. not include Metric.occupiedPass()

Specified by:

pass in interface Metric

Returns:

pass count

occupiedPass

public long occupiedPass()

Description copied from interface: Metric

Get occupied pass count.

Specified by:

occupiedPass in interface Metric

Returns:

occupied pass count

rt

public long rt()

Description copied from interface: Metric

Get total response time.

Specified by:

rt in interface Metric

Returns:

total RT

minRt

public long minRt()

Description copied from interface: Metric

Get the minimal RT.

Specified by:

minRt in interface Metric

Returns:

minimal RT

details

public List<MetricNode> details()

Description copied from interface: Metric

Get aggregated metric nodes of all resources.

Specified by:

details in interface Metric

Returns:

metric node list of all resources

detailsOnCondition

public List<MetricNode> detailsOnCondition(Predicate<Long> timePredicate)

Description copied from interface: Metric

Generate aggregated metric items that satisfies the time predicate.

Specified by:

detailsOnCondition in interface Metric

Parameters:

timePredicate - time predicate

Returns:

aggregated metric items

windows

public MetricBucket[] windows()

Description copied from interface: Metric

Get the raw window array.

Specified by:

windows in interface Metric

Returns:

window metric array

addException

public void addException(int count)

Description copied from interface: Metric

Add current exception count.

Specified by:

addException in interface Metric

Parameters:

count - count to add

addBlock

public void addBlock(int count)

Description copied from interface: Metric

Add current block count.

Specified by:

addBlock in interface Metric

Parameters:

count - count to add

addWaiting

public void addWaiting(long time,
                       int acquireCount)

Description copied from interface: Metric

Add request that occupied.

Specified by:

addWaiting in interface Metric

Parameters:

time - future timestamp that the acquireCount should be added on.

acquireCount - tokens count.

addOccupiedPass

public void addOccupiedPass(int acquireCount)

Description copied from interface: Metric

Add occupied pass, which represents pass requests that borrow the latter windows' token.

Specified by:

addOccupiedPass in interface Metric

Parameters:

acquireCount - tokens count.

addSuccess

public void addSuccess(int count)

Description copied from interface: Metric

Add current completed count.

Specified by:

addSuccess in interface Metric

Parameters:

count - count to add

addPass

public void addPass(int count)

Description copied from interface: Metric

Add current pass count.

Specified by:

addPass in interface Metric

Parameters:

count - count to add

addRT

public void addRT(long rt)

Description copied from interface: Metric

Add given RT to current total RT.

Specified by:

addRT in interface Metric

Parameters:

rt - RT

debug

public void debug()

Description copied from interface: DebugSupport

For debug;

Specified by:

debug in interface DebugSupport

previousWindowBlock

public long previousWindowBlock()

Specified by:

previousWindowBlock in interface Metric

previousWindowPass

public long previousWindowPass()

Specified by:

previousWindowPass in interface Metric

add

public void add(MetricEvent event,
                long count)

getCurrentCount

public long getCurrentCount(MetricEvent event)

getSum

public long getSum(MetricEvent event)

Get total sum for provided event in intervalInSec.

Parameters:

event - event to calculate

Returns:

total sum for event

getAvg

public double getAvg(MetricEvent event)

Get average count for provided event per second.

Parameters:

event - event to calculate

Returns:

average count per second for event

getWindowPass

public long getWindowPass(long timeMillis)

Description copied from interface: Metric

Note: this operation will not perform refreshing, so will not generate new buckets.

Specified by:

getWindowPass in interface Metric

Parameters:

timeMillis - valid time in ms

Returns:

pass count of the bucket exactly associated to provided timestamp, or 0 if the timestamp is invalid

waiting

public long waiting()

Description copied from interface: Metric

Get waiting pass account

Specified by:

waiting in interface Metric

Returns:

waiting pass count

getWindowIntervalInSec

public double getWindowIntervalInSec()

Description copied from interface: Metric

Get the sliding window length in seconds.

Specified by:

getWindowIntervalInSec in interface Metric

Returns:

the sliding window length

getSampleCount

public int getSampleCount()

Description copied from interface: Metric

Get sample count of the sliding window.

Specified by:

getSampleCount in interface Metric

Returns:

sample count of the sliding window.