com.alibaba.csp.sentinel.context

Class Context

java.lang.Object

com.alibaba.csp.sentinel.context.Context

Direct Known Subclasses:

NullContext

public class Context
extends Object

This class holds metadata of current invocation:

• the EntranceNode: the root of the current invocation tree.
• the current Entry: the current invocation point.
• the current Node: the statistics related to the Entry.
• the origin: The origin is useful when we want to control different invoker/consumer separately. Usually the origin could be the Service Consumer's app name or origin IP.

Each SphU#entry() or SphO#entry() should be in a Context, if we don't invoke ContextUtil#enter() explicitly, DEFAULT context will be used.

A invocation tree will be created if we invoke SphU#entry() multi times in the same context.

Same resource in different context will count separately, see NodeSelectorSlot.

Author:

jialiang.linjl, leyou(lihao), Eric Zhao

See Also:

ContextUtil, NodeSelectorSlot

Constructor Summary

Constructors

Constructor and Description
Context(DefaultNode entranceNode, String name)
Context(String name, DefaultNode entranceNode, boolean async)

Method Summary

Modifier and Type	Method and Description
Entry	getCurEntry()
Node	getCurNode()
DefaultNode	getEntranceNode()
Node	getLastNode() Get the parent Node of the current.
String	getName()
String	getOrigin()
double	getOriginAvgRt()
double	getOriginBlockQps()
long	getOriginBlockRequest()
int	getOriginCurThreadNum()
Node	getOriginNode()
double	getOriginPassQps()
double	getOriginPassReqQps()
double	getOriginTotalQps()
long	getOriginTotalRequest()
boolean	isAsync()
static Context	newAsyncContext(DefaultNode entranceNode, String name) Create a new async context.
Context	setCurEntry(Entry curEntry)
Context	setCurNode(Node node)
Context	setOrigin(String origin)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(DefaultNode entranceNode,
               String name)

Context

public Context(String name,
               DefaultNode entranceNode,
               boolean async)

Method Detail

newAsyncContext

public static Context newAsyncContext(DefaultNode entranceNode,
                                      String name)

Create a new async context.

Parameters:

entranceNode - entrance node of the context

name - context name

Returns:

the new created context

Since:

0.2.0

isAsync

public boolean isAsync()

getName

public String getName()

getCurNode

public Node getCurNode()

setCurNode

public Context setCurNode(Node node)

getCurEntry

public Entry getCurEntry()

setCurEntry

public Context setCurEntry(Entry curEntry)

getOrigin

public String getOrigin()

setOrigin

public Context setOrigin(String origin)

getOriginTotalQps

public double getOriginTotalQps()

getOriginBlockQps

public double getOriginBlockQps()

getOriginPassReqQps

public double getOriginPassReqQps()

getOriginPassQps

public double getOriginPassQps()

getOriginTotalRequest

public long getOriginTotalRequest()

getOriginBlockRequest

public long getOriginBlockRequest()

getOriginAvgRt

public double getOriginAvgRt()

getOriginCurThreadNum

public int getOriginCurThreadNum()

getEntranceNode

public DefaultNode getEntranceNode()

getLastNode

public Node getLastNode()

Get the parent Node of the current.

Returns:

the parent node of the current.

getOriginNode

public Node getOriginNode()

toString

public String toString()

Overrides:

toString in class Object