com.alibaba.csp.sentinel.node

Interface Node

All Superinterfaces:

DebugSupport, OccupySupport

All Known Implementing Classes:

ClusterNode, DefaultNode, EntranceNode, StatisticNode

public interface Node
extends OccupySupport, DebugSupport

Holds real-time statistics for resources.

Author:

qinan.qn, leyou, Eric Zhao

Method Summary

Modifier and Type	Method and Description
void	addPassRequest(int count) Add pass count.
void	addRtAndSuccess(long rt, int success) Add rt and success count.
double	avgRt() Get average rt per second.
double	blockQps() Get block request per second.
long	blockRequest() Get blocked request count per minute (totalBlockRequest).
int	curThreadNum() Get current active thread count.
void	decreaseThreadNum() Decrease current thread count.
double	exceptionQps() Get exception count per second.
void	increaseBlockQps(int count) Increase the block count.
void	increaseExceptionQps(int count) Add the biz exception count.
void	increaseThreadNum() Increase current thread count.
double	maxSuccessQps() Get estimated max success QPS till now.
Map<Long,MetricNode>	metrics() Fetch all valid metric nodes of resources.
double	minRt() Get minimal response time.
double	passQps() Get pass request per second.
double	previousBlockQps() Get last second block QPS.
double	previousPassQps() Last window QPS.
List<MetricNode>	rawMetricsInMin(Predicate<Long> timePredicate) Fetch all raw metric items that satisfies the time predicate.
void	reset() Reset the internal counter.
double	successQps() Get Entry.exit() request per second.
long	totalException() Get exception count per minute.
long	totalPass() Get pass count per minute.
double	totalQps() Get passQps() + blockQps() request per second.
long	totalRequest() Get incoming request per minute (pass + block).
long	totalSuccess() Get Entry.exit() count per minute.

Methods inherited from interface com.alibaba.csp.sentinel.node.OccupySupport

addOccupiedPass, addWaitingRequest, occupiedPassQps, tryOccupyNext, waiting

Methods inherited from interface com.alibaba.csp.sentinel.slots.statistic.metric.DebugSupport

debug

Method Detail

totalRequest

long totalRequest()

Get incoming request per minute (pass + block).

Returns:

total request count per minute

totalPass

long totalPass()

Get pass count per minute.

Returns:

total passed request count per minute

Since:

1.5.0

totalSuccess

long totalSuccess()

Get Entry.exit() count per minute.

Returns:

total completed request count per minute

blockRequest

long blockRequest()

Get blocked request count per minute (totalBlockRequest).

Returns:

total blocked request count per minute

totalException

long totalException()

Get exception count per minute.

Returns:

total business exception count per minute

passQps

double passQps()

Get pass request per second.

Returns:

QPS of passed requests

blockQps

double blockQps()

Get block request per second.

Returns:

QPS of blocked requests

totalQps

double totalQps()

Get passQps() + blockQps() request per second.

Returns:

QPS of passed and blocked requests

successQps

double successQps()

Get Entry.exit() request per second.

Returns:

QPS of completed requests

maxSuccessQps

double maxSuccessQps()

Get estimated max success QPS till now.

Returns:

max completed QPS

exceptionQps

double exceptionQps()

Get exception count per second.

Returns:

QPS of exception occurs

avgRt

double avgRt()

Get average rt per second.

Returns:

average response time per second

minRt

double minRt()

Get minimal response time.

Returns:

recorded minimal response time

curThreadNum

int curThreadNum()

Get current active thread count.

Returns:

current active thread count

previousBlockQps

double previousBlockQps()

Get last second block QPS.

previousPassQps

double previousPassQps()

Last window QPS.

metrics

Map<Long,MetricNode> metrics()

Fetch all valid metric nodes of resources.

Returns:

valid metric nodes of resources

rawMetricsInMin

List<MetricNode> rawMetricsInMin(Predicate<Long> timePredicate)

Fetch all raw metric items that satisfies the time predicate.

Parameters:

timePredicate - time predicate

Returns:

raw metric items that satisfies the time predicate

Since:

1.7.0

addPassRequest

void addPassRequest(int count)

Add pass count.

Parameters:

count - count to add pass

addRtAndSuccess

void addRtAndSuccess(long rt,
                     int success)

Add rt and success count.

Parameters:

rt - response time

success - success count to add

increaseBlockQps

void increaseBlockQps(int count)

Increase the block count.

Parameters:

count - count to add

increaseExceptionQps

void increaseExceptionQps(int count)

Add the biz exception count.

Parameters:

count - count to add

increaseThreadNum

void increaseThreadNum()

Increase current thread count.

decreaseThreadNum

void decreaseThreadNum()

Decrease current thread count.

reset

void reset()

Reset the internal counter. Reset is needed when IntervalProperty.INTERVAL or SampleCountProperty.SAMPLE_COUNT is changed.