com.alibaba.csp.sentinel

Class Tracer

java.lang.Object

com.alibaba.csp.sentinel.Tracer

public class Tracer
extends Object

This class is used to record other exceptions except block exception.

Author:

jialiang.linjl, Eric Zhao

Field Summary

Fields

Modifier and Type	Field and Description
protected static Predicate<Throwable>	exceptionPredicate
protected static Class<? extends Throwable>[]	ignoreClasses
protected static Class<? extends Throwable>[]	traceClasses

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Tracer()

Method Summary

Modifier and Type	Method and Description
static Predicate<? extends Throwable>	getExceptionPredicate() Get exception predicate
static Class<? extends Throwable>[]	getExceptionsToIgnore() Get exception classes to ignore.
static Class<? extends Throwable>[]	getExceptionsToTrace() Get exception classes to trace.
static void	setExceptionPredicate(Predicate<Throwable> exceptionPredicate) set an exception predicate which indicates the exception should be traced(return true) or ignored(return false) except for BlockException
static void	setExceptionsToIgnore(Class<? extends Throwable>... ignoreClasses) Set exceptions to ignore.
static void	setExceptionsToTrace(Class<? extends Throwable>... traceClasses) Set exception to trace.
protected static boolean	shouldTrace(Throwable t) Check whether the throwable should be traced.
static void	trace(Throwable e) Trace provided Throwable to the resource entry in current context.
static void	trace(Throwable e, int count) Deprecated.
static void	traceContext(Throwable e, Context context) Trace provided Throwable to current entry of given entrance context.
static void	traceContext(Throwable e, int count, Context context) Deprecated.
static void	traceEntry(Throwable e, Entry entry) Trace provided Throwable to the given resource entry.

Methods inherited from class java.lang.Object

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

Field Detail

traceClasses

protected static Class<? extends Throwable>[] traceClasses

ignoreClasses

protected static Class<? extends Throwable>[] ignoreClasses

exceptionPredicate

protected static Predicate<Throwable> exceptionPredicate

Constructor Detail

Tracer

protected Tracer()

Method Detail

trace

public static void trace(Throwable e)

Trace provided Throwable to the resource entry in current context.

Parameters:

e - exception to record

trace

@Deprecated
public static void trace(Throwable e,
                                     int count)

Deprecated.

Trace provided Throwable to current entry in current context.

Parameters:

e - exception to record

count - exception count to add

traceContext

public static void traceContext(Throwable e,
                                Context context)

Trace provided Throwable to current entry of given entrance context.

Parameters:

e - exception to record

context - target entrance context

Since:

1.8.0

traceContext

@Deprecated
public static void traceContext(Throwable e,
                                            int count,
                                            Context context)

Deprecated.

Trace provided Throwable and add exception count to current entry in provided context.

Parameters:

e - exception to record

count - exception count to add

Since:

1.4.2

traceEntry

public static void traceEntry(Throwable e,
                              Entry entry)

Trace provided Throwable to the given resource entry.

Parameters:

e - exception to record

Since:

1.4.2

setExceptionsToTrace

@SafeVarargs
public static void setExceptionsToTrace(Class<? extends Throwable>... traceClasses)

Set exception to trace. If not set, all Exception except for BlockException will be traced.

Note that if both setExceptionsToIgnore(Class[]) and this method is set, the ExceptionsToIgnore will be of higher precedence.

Parameters:

traceClasses - the list of exception classes to trace.

Since:

1.6.1

getExceptionsToTrace

public static Class<? extends Throwable>[] getExceptionsToTrace()

Get exception classes to trace.

Returns:

an array of exception classes to trace.

Since:

1.6.1

setExceptionsToIgnore

@SafeVarargs
public static void setExceptionsToIgnore(Class<? extends Throwable>... ignoreClasses)

Set exceptions to ignore. if not set, all Exception except for BlockException will be traced.

Note that if both setExceptionsToTrace(Class[]) and this method is set, the ExceptionsToIgnore will be of higher precedence.

Parameters:

ignoreClasses - the list of exception classes to ignore.

Since:

1.6.1

getExceptionsToIgnore

public static Class<? extends Throwable>[] getExceptionsToIgnore()

Get exception classes to ignore.

Returns:

an array of exception classes to ignore.

Since:

1.6.1

getExceptionPredicate

public static Predicate<? extends Throwable> getExceptionPredicate()

Get exception predicate

Returns:

the exception predicate.

setExceptionPredicate

public static void setExceptionPredicate(Predicate<Throwable> exceptionPredicate)

set an exception predicate which indicates the exception should be traced(return true) or ignored(return false) except for BlockException

Parameters:

exceptionPredicate - the exception predicate

shouldTrace

protected static boolean shouldTrace(Throwable t)

Check whether the throwable should be traced.

Parameters:

t - the throwable to check.

Returns:

true if the throwable should be traced, else return false.