io.sentry.buffer

Class DiskBuffer

java.lang.Object

io.sentry.buffer.DiskBuffer

All Implemented Interfaces:

Buffer

public class DiskBuffer
extends Object
implements Buffer

Stores Event objects to a directory on the filesystem and allows them to be flushed to Sentry (and deleted) at a later time.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_SUFFIX File suffix added to all serialized event files.

Constructor Summary

Constructors

Constructor and Description
DiskBuffer(File bufferDir, int maxEvents) Construct an DiskBuffer which stores errors in the specified directory on disk.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Event event) Store a single event to the add directory.
void	discard(Event event) Deletes a buffered Event from disk.
Iterator<Event>	getEvents() Returns an Iterator of Events that are stored on disk at the point in time this method is called.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_SUFFIX

public static final String FILE_SUFFIX

File suffix added to all serialized event files.

See Also:

Constant Field Values

Constructor Detail

DiskBuffer

public DiskBuffer(File bufferDir,
          int maxEvents)

Construct an DiskBuffer which stores errors in the specified directory on disk.

Parameters:

bufferDir - File representing directory to store buffered Events in

maxEvents - The maximum number of events to store offline

Method Detail

add

public void add(Event event)

Store a single event to the add directory. Java serialization is used and each event is stored in a file named by its UUID.

Specified by:

add in interface Buffer

Parameters:

event - Event to store in add directory

discard

public void discard(Event event)

Deletes a buffered Event from disk.

Specified by:

discard in interface Buffer

Parameters:

event - Event to delete from the disk.

getEvents

public Iterator<Event> getEvents()

Returns an Iterator of Events that are stored on disk at the point in time this method is called. Note that files may not deserialize correctly, may be corrupted, or may be missing on disk by the time we attempt to open them - so some care is taken to only return valid Events. If Events are written to disk after this Iterator is created they will not be returned by this Iterator.

Specified by:

getEvents in interface Buffer

Returns:

Iterator of Events on disk