Package com.wavefront.agent.queueing

Class SynchronizedTaskQueueWithMetrics<T extends DataSubmissionTask<T>>

java.lang.Object

com.wavefront.agent.queueing.SynchronizedTaskQueueWithMetrics<T>

Type Parameters:

T - type of objects stored.

All Implemented Interfaces:

TaskQueue<T>, Iterable<T>

public class SynchronizedTaskQueueWithMetrics<T extends DataSubmissionTask<T>>
extends Object
implements TaskQueue<T>

A thread-safe wrapper for TaskQueue that reports queue metrics.

Author:

[email protected]

Constructor Summary

Constructors

Constructor	Description
SynchronizedTaskQueueWithMetrics(TaskQueue<T> delegate, String metricPrefix, Map<String,String> metricTags, com.wavefront.data.ReportableEntityType entityType)

Method Summary

Modifier and Type	Method	Description
void	add(T t)	Add a task to the end of the queue
void	clear()	Empty and re-initialize the queue.
void	close()	Close the queue.
Long	getAvailableBytes()	Returns the total number of pre-allocated but unused bytes in the backing file.
String	getName()	Returns the unique queue name/identifier, can be anything, like file path name for file-based queues.
Iterator<T>	iterator()
T	peek()	Retrieve a task that is currently at the head of the queue.
void	remove()	Remove a task from the head of the queue.
int	size()	Returns a number of tasks currently in the queue.
Long	weight()	Returns the total weight of the queue (sum of weights of all tasks).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SynchronizedTaskQueueWithMetrics

public SynchronizedTaskQueueWithMetrics(TaskQueue<T> delegate,
                                        @Nullable
                                        String metricPrefix,
                                        @Nullable
                                        Map<String,String> metricTags,
                                        @Nullable
                                        com.wavefront.data.ReportableEntityType entityType)

Parameters:

delegate - delegate TaskQueue.

metricPrefix - prefix for metric names (default: "buffer")

metricTags - point tags for metrics (default: none)

entityType - entity type (default: points)

Method Detail

peek

public T peek()

Description copied from interface: TaskQueue

Retrieve a task that is currently at the head of the queue.

Specified by:

peek in interface TaskQueue<T extends DataSubmissionTask<T>>

Returns:

task object

add

public void add(@Nonnull
                T t)
         throws IOException

Description copied from interface: TaskQueue

Add a task to the end of the queue

Specified by:

add in interface TaskQueue<T extends DataSubmissionTask<T>>

Parameters:

t - task

Throws:

IOException - IO exceptions caught by the storage engine

clear

public void clear()

Description copied from interface: TaskQueue

Empty and re-initialize the queue.

Specified by:

clear in interface TaskQueue<T extends DataSubmissionTask<T>>

remove

public void remove()

Description copied from interface: TaskQueue

Remove a task from the head of the queue. Requires peek() to be called first, otherwise an IllegalStateException is thrown.

Specified by:

remove in interface TaskQueue<T extends DataSubmissionTask<T>>

size

public int size()

Description copied from interface: TaskQueue

Returns a number of tasks currently in the queue.

Specified by:

size in interface TaskQueue<T extends DataSubmissionTask<T>>

Returns:

number of tasks

close

public void close()
           throws IOException

Description copied from interface: TaskQueue

Close the queue. Should be invoked before a graceful shutdown.

Specified by:

close in interface TaskQueue<T extends DataSubmissionTask<T>>

Throws:

IOException

weight

@Nullable
public Long weight()

Description copied from interface: TaskQueue

Returns the total weight of the queue (sum of weights of all tasks).

Specified by:

weight in interface TaskQueue<T extends DataSubmissionTask<T>>

Returns:

weight of the queue (null if unknown)

getAvailableBytes

@Nullable
public Long getAvailableBytes()

Description copied from interface: TaskQueue

Returns the total number of pre-allocated but unused bytes in the backing file. May return null if not applicable.

Specified by:

getAvailableBytes in interface TaskQueue<T extends DataSubmissionTask<T>>

Returns:

total number of available bytes in the file or null

getName

public String getName()

Description copied from interface: TaskQueue

Returns the unique queue name/identifier, can be anything, like file path name for file-based queues.

Specified by:

getName in interface TaskQueue<T extends DataSubmissionTask<T>>

Returns:

queue name.

iterator

@Nonnull
public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends DataSubmissionTask<T>>