com.wavefront.sdk.common.clients

Class WavefrontClient.Builder

java.lang.Object

com.wavefront.sdk.common.clients.WavefrontClient.Builder

Enclosing class:

WavefrontClient

public static class WavefrontClient.Builder
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(String server, String token) Create a new WavefrontClient.Builder

Method Summary

Modifier and Type	Method and Description
WavefrontClient.Builder	batchSize(int batchSize) Set batch size to be reported during every flush.
WavefrontClient	build() Creates a new client that flushes directly to a Proxy or Wavefront service.
WavefrontClient.Builder	flushIntervalSeconds(int flushIntervalSeconds) Set interval at which you want to flush points to Wavefront cluster.
WavefrontClient.Builder	maxQueueSize(int maxQueueSize) Set max queue size of in-memory buffer.
WavefrontClient.Builder	messageSizeBytes(int bytes) Set max message size, such that each batch is reported as one or more messages where no message exceeds the specified size in bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(String server,
                  @Nullable
                  String token)

Create a new WavefrontClient.Builder

Parameters:

server - A server URL of the form "https://clusterName.wavefront.com" or "http://internal.proxy.com:port"

token - A valid API token with direct ingestion permissions

Method Detail

maxQueueSize

public WavefrontClient.Builder maxQueueSize(int maxQueueSize)

Set max queue size of in-memory buffer. Needs to be flushed if full.

Parameters:

maxQueueSize - Max queue size of in-memory buffer

Returns:

this

batchSize

public WavefrontClient.Builder batchSize(int batchSize)

Set batch size to be reported during every flush.

Parameters:

batchSize - Batch size to be reported during every flush.

Returns:

this

flushIntervalSeconds

public WavefrontClient.Builder flushIntervalSeconds(int flushIntervalSeconds)

Set interval at which you want to flush points to Wavefront cluster.

Parameters:

flushIntervalSeconds - Interval at which you want to flush points to Wavefront cluster

Returns:

this

messageSizeBytes

public WavefrontClient.Builder messageSizeBytes(int bytes)

Set max message size, such that each batch is reported as one or more messages where no message exceeds the specified size in bytes. The default message size is Integer.MAX_VALUE.

Parameters:

bytes - Maximum number of bytes of data that each reported message contains.

Returns:

this

build

public WavefrontClient build()

Creates a new client that flushes directly to a Proxy or Wavefront service. return WavefrontClient