com.alibaba.csp.sentinel.node

Class ClusterNode

java.lang.Object

com.alibaba.csp.sentinel.node.StatisticNode

com.alibaba.csp.sentinel.node.ClusterNode

All Implemented Interfaces:

Node, OccupySupport, DebugSupport

public class ClusterNode
extends StatisticNode

This class stores summary runtime statistics of the resource, including rt, thread count, qps and so on. Same resource shares the same ClusterNode globally, no matter in which Context.

To distinguish invocation from different origin (declared in ContextUtil.enter(String name, String origin)), one ClusterNode holds an originCountMap, this map holds StatisticNode of different origin. Use getOrCreateOriginNode(String) to get Node of the specific origin.
Note that 'origin' usually is Service Consumer's app name.

Author:

qinan.qn, jialiang.linjl

Constructor Summary

Constructors

Constructor and Description
ClusterNode(String name)
ClusterNode(String name, int resourceType)

Method Summary

Modifier and Type	Method and Description
String	getName() Get resource name of the resource node.
Node	getOrCreateOriginNode(String origin) Get Node of the specific origin.
Map<String,StatisticNode>	getOriginCountMap()
int	getResourceType() Get classification (type) of the resource.
void	trace(Throwable throwable, int count) Add exception count only when given throwable is not a BlockException.

Methods inherited from class com.alibaba.csp.sentinel.node.StatisticNode

addOccupiedPass, addPassRequest, addRtAndSuccess, addWaitingRequest, avgRt, blockQps, blockRequest, curThreadNum, debug, decreaseThreadNum, exceptionQps, increaseBlockQps, increaseExceptionQps, increaseThreadNum, maxSuccessQps, metrics, minRt, occupiedPassQps, passQps, previousBlockQps, previousPassQps, rawMetricsInMin, reset, successQps, totalException, totalPass, totalQps, totalRequest, totalSuccess, tryOccupyNext, waiting

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterNode

public ClusterNode(String name)

ClusterNode

public ClusterNode(String name,
                   int resourceType)

Method Detail

getName

public String getName()

Get resource name of the resource node.

Returns:

resource name

Since:

1.7.0

getResourceType

public int getResourceType()

Get classification (type) of the resource.

Returns:

resource type

Since:

1.7.0

getOrCreateOriginNode

public Node getOrCreateOriginNode(String origin)

Get Node of the specific origin. Usually the origin is the Service Consumer's app name.

If the origin node for given origin is absent, then a new StatisticNode for the origin will be created and returned.

Parameters:

origin - The caller's name, which is designated in the parameter parameter ContextUtil.enter(String name, String origin).

Returns:

the Node of the specific origin

getOriginCountMap

public Map<String,StatisticNode> getOriginCountMap()

trace

public void trace(Throwable throwable,
                  int count)

Add exception count only when given throwable is not a BlockException.

Parameters:

throwable - target exception

count - count to add