Package com.wavefront.agent.data

Class LineDelimitedDataSubmissionTask

java.lang.Object

com.wavefront.agent.data.LineDelimitedDataSubmissionTask

All Implemented Interfaces:

DataSubmissionTask<LineDelimitedDataSubmissionTask>, Serializable

public class LineDelimitedDataSubmissionTask
extends Object

A DataSubmissionTask that handles plaintext payloads in the newline-delimited format.

Author:

[email protected]

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	attempts
protected TaskQueue<T>	backlog
protected long	enqueuedTimeMillis
protected com.wavefront.data.ReportableEntityType	entityType
protected String	handle
protected List<String>	payload
protected EntityProperties	properties
protected Supplier<Long>	timeProvider
protected com.yammer.metrics.core.Histogram	timeSpentInQueue

Constructor Summary

Constructors

Constructor	Description
LineDelimitedDataSubmissionTask(com.wavefront.api.ProxyV2API api, UUID proxyId, EntityProperties properties, TaskQueue<LineDelimitedDataSubmissionTask> backlog, String format, com.wavefront.data.ReportableEntityType entityType, String handle, List<String> payload, Supplier<Long> timeProvider)

Method Summary

Modifier and Type	Method	Description
void	enqueue(QueueingReason reason)	Persist task in the queue
TaskResult	execute()	Execute this task
long	getEnqueuedMillis()	Returns task enqueue time in milliseconds.
com.wavefront.data.ReportableEntityType	getEntityType()	Returns entity type handled.
void	injectMembers(com.wavefront.api.ProxyV2API api, UUID proxyId, EntityProperties properties, TaskQueue<LineDelimitedDataSubmissionTask> backlog)
List<String>	payload()
List<LineDelimitedDataSubmissionTask>	splitTask(int minSplitSize, int maxSplitSize)	Split the task into smaller tasks.
int	weight()	Returns a task weight.

Methods inherited from class java.lang.Object

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

Field Detail

payload

protected List<String> payload

enqueuedTimeMillis

protected long enqueuedTimeMillis

attempts

protected int attempts

handle

protected String handle

entityType

protected com.wavefront.data.ReportableEntityType entityType

timeSpentInQueue

protected transient com.yammer.metrics.core.Histogram timeSpentInQueue

timeProvider

protected transient Supplier<Long> timeProvider

properties

protected transient EntityProperties properties

backlog

protected transient TaskQueue<T extends DataSubmissionTask<T>> backlog

Constructor Detail

LineDelimitedDataSubmissionTask

public LineDelimitedDataSubmissionTask(com.wavefront.api.ProxyV2API api,
                                       UUID proxyId,
                                       EntityProperties properties,
                                       TaskQueue<LineDelimitedDataSubmissionTask> backlog,
                                       String format,
                                       com.wavefront.data.ReportableEntityType entityType,
                                       String handle,
                                       @Nonnull
                                       List<String> payload,
                                       @Nullable
                                       Supplier<Long> timeProvider)

Parameters:

api - API endpoint

proxyId - Proxy identifier. Used to authenticate proxy with the API.

properties - entity-specific wrapper over mutable proxy settings' container.

backlog - task queue.

format - Data format (passed as an argument to the API)

entityType - Entity type handled

handle - Handle (usually port number) of the pipeline where the data came from.

payload - Data payload

timeProvider - Time provider (in millis)

Method Detail

weight

public int weight()

Description copied from interface: DataSubmissionTask

Returns a task weight.

Returns:

task weight

splitTask

public List<LineDelimitedDataSubmissionTask> splitTask(int minSplitSize,
                                                       int maxSplitSize)

Description copied from interface: DataSubmissionTask

Split the task into smaller tasks.

Parameters:

minSplitSize - Don't split the task if its weight is smaller than this number.

maxSplitSize - Split tasks size cap.

Returns:

tasks

payload

public List<String> payload()

injectMembers

public void injectMembers(com.wavefront.api.ProxyV2API api,
                          UUID proxyId,
                          EntityProperties properties,
                          TaskQueue<LineDelimitedDataSubmissionTask> backlog)

getEnqueuedMillis

public long getEnqueuedMillis()

Description copied from interface: DataSubmissionTask

Returns task enqueue time in milliseconds.

Specified by:

getEnqueuedMillis in interface DataSubmissionTask<T extends DataSubmissionTask<T>>

Returns:

enqueue time in milliseconds

getEntityType

public com.wavefront.data.ReportableEntityType getEntityType()

Description copied from interface: DataSubmissionTask

Returns entity type handled.

Specified by:

getEntityType in interface DataSubmissionTask<T extends DataSubmissionTask<T>>

Returns:

entity type

execute

public TaskResult execute()

Description copied from interface: DataSubmissionTask

Execute this task

Specified by:

execute in interface DataSubmissionTask<T extends DataSubmissionTask<T>>

Returns:

operation result

enqueue

public void enqueue(@Nullable
                    QueueingReason reason)

Description copied from interface: DataSubmissionTask

Persist task in the queue

Specified by:

enqueue in interface DataSubmissionTask<T extends DataSubmissionTask<T>>

Parameters:

reason - reason for queueing. used to increment metrics, if specified.