io.sentry.jvmti

Class FrameCache

java.lang.Object

io.sentry.jvmti.FrameCache

public final class FrameCache
extends Object

Utility class used by the Sentry Java Agent to store per-frame local variable information for the last thrown exception.

Method Summary

Methods

Modifier and Type	Method and Description
static void	add(Throwable throwable, Frame[] frames) Store the per-frame local variable information for the last exception thrown on this thread.
static void	addAppPackage(String newAppPackage) Add an "in app" package prefix to the set of packages for which exception local variables will be cached.
static Frame[]	get(Throwable throwable) Retrieve the per-frame local variable information for the last exception thrown on this thread.
static boolean	shouldCacheThrowable(Throwable throwable, int numFrames) Check whether the provided Throwable should be cached or not.

Methods inherited from class java.lang.Object

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

Method Detail

add

public static void add(Throwable throwable,
       Frame[] frames)

Store the per-frame local variable information for the last exception thrown on this thread.

Parameters:

throwable - Throwable that the provided Frames represent.

frames - Array of Frames to store

get

public static Frame[] get(Throwable throwable)

Retrieve the per-frame local variable information for the last exception thrown on this thread.

Parameters:

throwable - Throwable to look up cached Frames for.

Returns:

Array of Frames

shouldCacheThrowable

public static boolean shouldCacheThrowable(Throwable throwable,
                           int numFrames)

Check whether the provided Throwable should be cached or not. Called by the native agent code so that the Java side (this code) can check the existing cache and user configuration, such as which packages are "in app".

Parameters:

throwable - Throwable to be checked

numFrames - Number of frames in the Throwable's stacktrace

Returns:

true if the Throwable should be processed and cached

addAppPackage

public static void addAppPackage(String newAppPackage)

Add an "in app" package prefix to the set of packages for which exception local variables will be cached. When an exception is thrown it must contain at least one frame that originates from a package in this set, otherwise local variable information will not be cached. See shouldCacheThrowable(Throwable, int).

Parameters:

newAppPackage - package prefix to add to the set