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

Constructor and Description
Builder(String proxyServer) Create a new WavefrontClient.Builder
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	flushInterval(int flushInterval, TimeUnit timeUnit) Set interval at which you want to flush points to Wavefront cluster.
WavefrontClient.Builder	flushIntervalSeconds(int flushIntervalSeconds) Set interval (in seconds) at which you want to flush points to Wavefront cluster.
WavefrontClient.Builder	includeSdkMetrics(boolean includeSdkMetrics) Default is true, if false the internal metrics emitted from this sender will be disabled
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.
WavefrontClient.Builder	metricsPort(int port) The port metrics will be sent to on the server or proxy, overriding any port set in the server URL.
WavefrontClient.Builder	sdkMetricsTags(Map<String,String> tags) Set the tags to apply to the internal SDK metrics
WavefrontClient.Builder	tracesPort(int port) The port traces will be sent to on the server or proxy, overriding any port set in the server URL.
WavefrontClient.Builder	validateEndpoint() For a given server endpoint, validate according to RFC 2396 and attempt to make a connection

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public 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

Builder

public Builder(String proxyServer)

Create a new WavefrontClient.Builder

Parameters:

proxyServer - A server URL of the the form "http://internal.proxy.com:port"

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

flushInterval

public WavefrontClient.Builder flushInterval(int flushInterval,
                                             @NonNull
                                             TimeUnit timeUnit)

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

Parameters:

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

timeUnit - Time unit for the specified interval

Returns:

this

flushIntervalSeconds

public WavefrontClient.Builder flushIntervalSeconds(int flushIntervalSeconds)

Set interval (in seconds) 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

metricsPort

public WavefrontClient.Builder metricsPort(int port)

The port metrics will be sent to on the server or proxy, overriding any port set in the server URL.

Parameters:

port - Port number metrics will be sent to on the server or proxy.

Returns:

this

includeSdkMetrics

public WavefrontClient.Builder includeSdkMetrics(boolean includeSdkMetrics)

Default is true, if false the internal metrics emitted from this sender will be disabled

Parameters:

includeSdkMetrics - Whether or not to include the SDK Internal Metrics

Returns:

this

sdkMetricsTags

public WavefrontClient.Builder sdkMetricsTags(Map<String,String> tags)

Set the tags to apply to the internal SDK metrics

Parameters:

tags - a map of point tags to apply to the internal sdk metrics

Returns:

this

tracesPort

public WavefrontClient.Builder tracesPort(int port)

The port traces will be sent to on the server or proxy, overriding any port set in the server URL.

Parameters:

port - Port number traces will be sent to on the server or proxy.

Returns:

this

validateEndpoint

public WavefrontClient.Builder validateEndpoint()
                                         throws IllegalArgumentException

For a given server endpoint, validate according to RFC 2396 and attempt to make a connection

Returns:

this

Throws:

IllegalArgumentException

build

public WavefrontClient build()

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

Throws:

IllegalStateException