NonBlockingStatsDClientBuilder (java-dogstatsd-client 4.2.0 API)

java.lang.Object
- com.timgroup.statsd.NonBlockingStatsDClientBuilder

All Implemented Interfaces:: Cloneable

public class NonBlockingStatsDClientBuilder
extends Object
implements Cloneable

Field Summary

Fields
Modifier and Type	Field and Description
`Callable<SocketAddress>`	`addressLookup`
`int`	`aggregationFlushInterval`
`int`	`aggregationShards`
`boolean`	`blocking`
`int`	`bufferPoolSize`
`String[]`	`constantTags`
`String`	`containerID`
`boolean`	`enableAggregation`
`boolean`	`enableTelemetry`
`String`	`entityID`
`StatsDClientErrorHandler`	`errorHandler`
`String`	`hostname`
`int`	`maxPacketSizeBytes` 1400 chosen as default here so that the number of bytes in a message plus the number of bytes required for additional udp headers should be under the 1500 Maximum Transmission Unit for ethernet.
`String`	`namedPipe`
`boolean`	`originDetectionEnabled`
`int`	`port`
`String`	`prefix`
`int`	`processorWorkers`
`int`	`queueSize`
`int`	`senderWorkers`
`int`	`socketBufferSize`
`Callable<SocketAddress>`	`telemetryAddressLookup`
`int`	`telemetryFlushInterval`
`String`	`telemetryHostname`
`int`	`telemetryPort`
`ThreadFactory`	`threadFactory`
`int`	`timeout`

Constructor Summary

Constructors
Constructor and Description

NonBlockingStatsDClientBuilder()

Constructors
Constructor and Description
`NonBlockingStatsDClientBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NonBlockingStatsDClientBuilder`	`addressLookup(Callable<SocketAddress> val)`
`NonBlockingStatsDClientBuilder`	`aggregationFlushInterval(int val)`
`NonBlockingStatsDClientBuilder`	`aggregationShards(int val)`
`NonBlockingStatsDClientBuilder`	`blocking(boolean val)`
`NonBlockingStatsDClientBuilder`	`bufferPoolSize(int val)`
`NonBlockingStatsDClient`	`build()` NonBlockingStatsDClient factory method.
`NonBlockingStatsDClientBuilder`	`constantTags(String... val)`
`NonBlockingStatsDClientBuilder`	`containerID(String val)`
`NonBlockingStatsDClientBuilder`	`enableAggregation(boolean val)`
`NonBlockingStatsDClientBuilder`	`enableTelemetry(boolean val)`
`NonBlockingStatsDClientBuilder`	`entityID(String val)`
`NonBlockingStatsDClientBuilder`	`errorHandler(StatsDClientErrorHandler val)`
`NonBlockingStatsDClientBuilder`	`hostname(String val)`
`NonBlockingStatsDClientBuilder`	`maxPacketSizeBytes(int val)`
`NonBlockingStatsDClientBuilder`	`namedPipe(String val)`
`NonBlockingStatsDClientBuilder`	`originDetectionEnabled(boolean val)`
`NonBlockingStatsDClientBuilder`	`port(int val)`
`NonBlockingStatsDClientBuilder`	`prefix(String val)`
`NonBlockingStatsDClientBuilder`	`processorWorkers(int val)`
`NonBlockingStatsDClientBuilder`	`queueSize(int val)`
`protected NonBlockingStatsDClientBuilder`	`resolve()` Creates a copy of this builder with any implicit elements resolved.
`NonBlockingStatsDClientBuilder`	`senderWorkers(int val)`
`NonBlockingStatsDClientBuilder`	`socketBufferSize(int val)`
`static Callable<SocketAddress>`	`staticAddressResolution(String hostname, int port)` Lookup the address for the given host name and cache the result.
`protected static Callable<SocketAddress>`	`staticNamedPipeResolution(String namedPipe)`
`protected static Callable<SocketAddress>`	`staticStatsDAddressResolution(String hostname, int port)`
`NonBlockingStatsDClientBuilder`	`telemetryAddressLookup(Callable<SocketAddress> val)`
`NonBlockingStatsDClientBuilder`	`telemetryFlushInterval(int val)`
`NonBlockingStatsDClientBuilder`	`telemetryHostname(String val)`
`NonBlockingStatsDClientBuilder`	`telemetryPort(int val)`
`NonBlockingStatsDClientBuilder`	`threadFactory(ThreadFactory val)`
`NonBlockingStatsDClientBuilder`	`timeout(int val)`
`static Callable<SocketAddress>`	`volatileAddressResolution(String hostname, int port)` Create dynamic lookup for the given host name and port.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

maxPacketSizeBytes
```
public int maxPacketSizeBytes
```
1400 chosen as default here so that the number of bytes in a message plus the number of bytes required for additional udp headers should be under the 1500 Maximum Transmission Unit for ethernet. See https://github.com/DataDog/java-dogstatsd-client/pull/17 for discussion.

port
```
public int port
```

telemetryPort
```
public int telemetryPort
```

queueSize
```
public int queueSize
```

timeout
```
public int timeout
```

bufferPoolSize
```
public int bufferPoolSize
```

socketBufferSize
```
public int socketBufferSize
```

processorWorkers
```
public int processorWorkers
```

senderWorkers
```
public int senderWorkers
```

blocking
```
public boolean blocking
```

enableTelemetry
```
public boolean enableTelemetry
```

enableAggregation
```
public boolean enableAggregation
```

telemetryFlushInterval
```
public int telemetryFlushInterval
```

aggregationFlushInterval
```
public int aggregationFlushInterval
```

aggregationShards
```
public int aggregationShards
```

originDetectionEnabled
```
public boolean originDetectionEnabled
```

addressLookup

public Callable<SocketAddress> addressLookup

telemetryAddressLookup

public Callable<SocketAddress> telemetryAddressLookup

hostname
```
public String hostname
```

telemetryHostname
```
public String telemetryHostname
```

namedPipe
```
public String namedPipe
```

prefix
```
public String prefix
```

entityID
```
public String entityID
```

constantTags
```
public String[] constantTags
```

containerID
```
public String containerID
```

errorHandler

public StatsDClientErrorHandler errorHandler

threadFactory
```
public ThreadFactory threadFactory
```

Constructor Detail
- NonBlockingStatsDClientBuilder
```
public NonBlockingStatsDClientBuilder()
```

Method Detail

port

public NonBlockingStatsDClientBuilder port(int val)

telemetryPort

public NonBlockingStatsDClientBuilder telemetryPort(int val)

queueSize

public NonBlockingStatsDClientBuilder queueSize(int val)

timeout

public NonBlockingStatsDClientBuilder timeout(int val)

bufferPoolSize

public NonBlockingStatsDClientBuilder bufferPoolSize(int val)

socketBufferSize

public NonBlockingStatsDClientBuilder socketBufferSize(int val)

maxPacketSizeBytes

public NonBlockingStatsDClientBuilder maxPacketSizeBytes(int val)

processorWorkers

public NonBlockingStatsDClientBuilder processorWorkers(int val)

senderWorkers

public NonBlockingStatsDClientBuilder senderWorkers(int val)

blocking

public NonBlockingStatsDClientBuilder blocking(boolean val)

addressLookup

public NonBlockingStatsDClientBuilder addressLookup(Callable<SocketAddress> val)

telemetryAddressLookup

public NonBlockingStatsDClientBuilder telemetryAddressLookup(Callable<SocketAddress> val)

hostname

public NonBlockingStatsDClientBuilder hostname(String val)

telemetryHostname

public NonBlockingStatsDClientBuilder telemetryHostname(String val)

namedPipe

public NonBlockingStatsDClientBuilder namedPipe(String val)

prefix

public NonBlockingStatsDClientBuilder prefix(String val)

entityID

public NonBlockingStatsDClientBuilder entityID(String val)

constantTags

public NonBlockingStatsDClientBuilder constantTags(String... val)

errorHandler

public NonBlockingStatsDClientBuilder errorHandler(StatsDClientErrorHandler val)

enableTelemetry

public NonBlockingStatsDClientBuilder enableTelemetry(boolean val)

enableAggregation

public NonBlockingStatsDClientBuilder enableAggregation(boolean val)

telemetryFlushInterval

public NonBlockingStatsDClientBuilder telemetryFlushInterval(int val)

aggregationFlushInterval

public NonBlockingStatsDClientBuilder aggregationFlushInterval(int val)

aggregationShards

public NonBlockingStatsDClientBuilder aggregationShards(int val)

threadFactory

public NonBlockingStatsDClientBuilder threadFactory(ThreadFactory val)

containerID

public NonBlockingStatsDClientBuilder containerID(String val)

originDetectionEnabled

public NonBlockingStatsDClientBuilder originDetectionEnabled(boolean val)

build
```
public NonBlockingStatsDClient build()
                              throws StatsDClientException
```
NonBlockingStatsDClient factory method.

Returns:

the built NonBlockingStatsDClient.

Throws:

StatsDClientException

resolve
```
protected NonBlockingStatsDClientBuilder resolve()
```
Creates a copy of this builder with any implicit elements resolved.

Returns:

the resolved copy of the builder.

volatileAddressResolution
```
public static Callable<SocketAddress> volatileAddressResolution(String hostname,
                                                                int port)
```
Create dynamic lookup for the given host name and port.

Parameters:

hostname - the host name of the targeted StatsD server. If the environment variable "DD_AGENT_HOST" is set, this parameter is overwritten by the environment variable value.

port - the port of the targeted StatsD server. If the environment variable "DD_DOGSTATSD_PORT" is set, this parameter is overwritten by the environment variable value.

Returns:

a function to perform the lookup

staticAddressResolution
```
public static Callable<SocketAddress> staticAddressResolution(String hostname,
                                                              int port)
                                                       throws Exception
```
Lookup the address for the given host name and cache the result.

Parameters:

hostname - the host name of the targeted StatsD server

port - the port of the targeted StatsD server

Returns:

a function that cached the result of the lookup

Throws:

Exception - if the lookup fails, i.e. UnknownHostException

staticStatsDAddressResolution

protected static Callable<SocketAddress> staticStatsDAddressResolution(String hostname,
                                                                       int port)
                                                                throws StatsDClientException

Throws:: StatsDClientException

staticNamedPipeResolution

protected static Callable<SocketAddress> staticNamedPipeResolution(String namedPipe)

Class NonBlockingStatsDClientBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

maxPacketSizeBytes

port

telemetryPort

queueSize

timeout

bufferPoolSize

socketBufferSize

processorWorkers

senderWorkers

blocking

enableTelemetry

enableAggregation

telemetryFlushInterval

aggregationFlushInterval

aggregationShards

originDetectionEnabled

addressLookup

telemetryAddressLookup

hostname

telemetryHostname

namedPipe

prefix

entityID

constantTags

containerID

errorHandler

threadFactory

Constructor Detail

NonBlockingStatsDClientBuilder

Method Detail

port

telemetryPort

queueSize

timeout

bufferPoolSize

socketBufferSize

maxPacketSizeBytes

processorWorkers

senderWorkers

blocking

addressLookup

telemetryAddressLookup

hostname

telemetryHostname

namedPipe

prefix

entityID

constantTags

errorHandler

enableTelemetry

enableAggregation

telemetryFlushInterval

aggregationFlushInterval

aggregationShards

threadFactory

containerID

originDetectionEnabled

build

resolve

volatileAddressResolution

staticAddressResolution

staticStatsDAddressResolution

staticNamedPipeResolution