NonBlockingStatsDClientBuilder (java-dogstatsd-client 4.4.5 API)

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

All Implemented Interfaces:

Cloneable
```
public class NonBlockingStatsDClientBuilder
extends Object
implements Cloneable
```
Create a new StatsD client communicating with a StatsD instance on the specified host and port. All messages send via this client will have their keys prefixed with the specified string. The new client will attempt to open a connection to the StatsD server immediately upon instantiation, and may throw an exception if that a connection cannot be established. Once a client has been instantiated in this way, all exceptions thrown during subsequent usage are passed to the specified handler and then consumed, guaranteeing that failures in metrics will not affect normal code execution.

Field Summary

Fields
Modifier and Type	Field and Description
`Callable<SocketAddress>`	`addressLookup` Yields the IP address and socket of the StatsD server.
`int`	`aggregationFlushInterval` Aggregation flush interval, in milliseconds.
`int`	`aggregationShards`
`boolean`	`blocking` Blocking or non-blocking implementation for statsd message queue.
`int`	`bufferPoolSize` The size for the network buffer pool.
`int`	`connectionTimeout` The timeout in milliseconds for connecting to the StatsD server.
`String[]`	`constantTags` Tags to be added to all content sent.
`String`	`containerID` Allows passing the container ID, this will be used by the Agent to enrich metrics with container tags.
`boolean`	`enableAggregation`
`boolean`	`enableTelemetry` Enable sending client telemetry.
`String`	`entityID` The entity id value used with an internal tag for tracking client entity.
`StatsDClientErrorHandler`	`errorHandler` Handler to use when an exception occurs during usage, may be null to indicate noop.
`String`	`hostname`
`int`	`maxPacketSizeBytes` The maximum number of bytes for a message that can be sent.
`String`	`namedPipe`
`boolean`	`originDetectionEnabled` Enable/disable the client origin detection.
`int`	`port`
`String`	`prefix` The prefix to apply to keys sent via this client.
`int`	`processorWorkers` The number of processor worker threads assembling buffers for submission.
`int`	`queueSize` The maximum amount of unprocessed messages in the queue.
`int`	`senderWorkers` The number of sender worker threads submitting buffers to the socket.
`int`	`socketBufferSize` The socket buffer size in bytes.
`TagsCardinality`	`tagsCardinality`
`Callable<SocketAddress>`	`telemetryAddressLookup` Yields the IP address and socket of the StatsD telemetry server destination.
`int`	`telemetryFlushInterval` Telemetry flush interval, in milliseconds.
`String`	`telemetryHostname`
`int`	`telemetryPort`
`ThreadFactory`	`threadFactory`
`int`	`timeout` The timeout in milliseconds for blocking operations.

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`	`address(String address)`
`NonBlockingStatsDClientBuilder`	`addressLookup(Callable<SocketAddress> val)` Yields the IP address and socket of the StatsD server.
`NonBlockingStatsDClientBuilder`	`aggregationFlushInterval(int val)` Aggregation flush interval, in milliseconds.
`NonBlockingStatsDClientBuilder`	`aggregationShards(int val)`
`NonBlockingStatsDClientBuilder`	`blocking(boolean val)` Blocking or non-blocking implementation for statsd message queue.
`NonBlockingStatsDClientBuilder`	`bufferPoolSize(int val)` The size for the network buffer pool.
`NonBlockingStatsDClient`	`build()` NonBlockingStatsDClient factory method.
`DirectStatsDClient`	`buildDirectStatsDClient()` `DirectStatsDClient` factory method.
`NonBlockingStatsDClientBuilder`	`connectionTimeout(int val)` The timeout in milliseconds for connecting to the StatsD server.
`NonBlockingStatsDClientBuilder`	`constantTags(String... val)` Tags to be added to all content sent.
`NonBlockingStatsDClientBuilder`	`containerID(String val)` Allows passing the container ID, this will be used by the Agent to enrich metrics with container tags.
`NonBlockingStatsDClientBuilder`	`enableAggregation(boolean val)`
`NonBlockingStatsDClientBuilder`	`enableTelemetry(boolean val)` Enable sending client telemetry.
`NonBlockingStatsDClientBuilder`	`entityID(String val)` The entity id value used with an internal tag for tracking client entity.
`NonBlockingStatsDClientBuilder`	`errorHandler(StatsDClientErrorHandler val)` Handler to use when an exception occurs during usage, may be null to indicate noop.
`NonBlockingStatsDClientBuilder`	`hostname(String val)`
`NonBlockingStatsDClientBuilder`	`maxPacketSizeBytes(int val)`
`NonBlockingStatsDClientBuilder`	`namedPipe(String val)`
`NonBlockingStatsDClientBuilder`	`originDetectionEnabled(boolean val)` Enable/disable the client origin detection.
`NonBlockingStatsDClientBuilder`	`port(int val)`
`NonBlockingStatsDClientBuilder`	`prefix(String val)` The prefix to apply to keys sent via this client.
`NonBlockingStatsDClientBuilder`	`processorWorkers(int val)` The number of processor worker threads assembling buffers for submission.
`NonBlockingStatsDClientBuilder`	`queueSize(int val)` The maximum amount of unprocessed messages in the queue.
`protected NonBlockingStatsDClientBuilder`	`resolve()` Creates a copy of this builder with any implicit elements resolved.
`NonBlockingStatsDClientBuilder`	`senderWorkers(int val)` The number of sender worker threads submitting buffers to the socket.
`NonBlockingStatsDClientBuilder`	`socketBufferSize(int val)` The socket buffer size in bytes.
`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>`	`staticUnixResolution(String path, UnixSocketAddressWithTransport.TransportType transportType)`
`NonBlockingStatsDClientBuilder`	`tagsCardinality(TagsCardinality cardinality)` Request that all metrics from this client to be enriched to specified tag cardinality.
`NonBlockingStatsDClientBuilder`	`telemetryAddress(String address)`
`NonBlockingStatsDClientBuilder`	`telemetryAddressLookup(Callable<SocketAddress> val)` Yields the IP address and socket of the StatsD telemetry server destination.
`NonBlockingStatsDClientBuilder`	`telemetryFlushInterval(int val)` Telemetry flush interval, in milliseconds.
`NonBlockingStatsDClientBuilder`	`telemetryHostname(String val)`
`NonBlockingStatsDClientBuilder`	`telemetryPort(int val)`
`NonBlockingStatsDClientBuilder`	`threadFactory(ThreadFactory val)`
`NonBlockingStatsDClientBuilder`	`timeout(int val)` The timeout in milliseconds for blocking operations.
`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
```
    The maximum number of bytes for a message that can be sent.
  - port
```
public int port
```
  - telemetryPort
```
public int telemetryPort
```
  - queueSize
```
public int queueSize
```
    The maximum amount of unprocessed messages in the queue.
  - timeout
```
public int timeout
```
    The timeout in milliseconds for blocking operations. Applies to unix sockets only.
  - bufferPoolSize
```
public int bufferPoolSize
```
    The size for the network buffer pool.
  - socketBufferSize
```
public int socketBufferSize
```
    The socket buffer size in bytes. Applies to unix sockets only.
  - processorWorkers
```
public int processorWorkers
```
    The number of processor worker threads assembling buffers for submission.
  - senderWorkers
```
public int senderWorkers
```
    The number of sender worker threads submitting buffers to the socket.
  - blocking
```
public boolean blocking
```
    Blocking or non-blocking implementation for statsd message queue.
  - enableTelemetry
```
public boolean enableTelemetry
```
    Enable sending client telemetry.
  - enableAggregation
```
public boolean enableAggregation
```
  - telemetryFlushInterval
```
public int telemetryFlushInterval
```
    Telemetry flush interval, in milliseconds.
  - aggregationFlushInterval
```
public int aggregationFlushInterval
```
    Aggregation flush interval, in milliseconds. 0 disables aggregation.
  - aggregationShards
```
public int aggregationShards
```
  - originDetectionEnabled
```
public boolean originDetectionEnabled
```
    Enable/disable the client origin detection.
    This feature requires Datadog Agent version >=6.35.0 && <7.0.0 or Agent versions >=7.35.0. When enabled, the client tries to discover its container ID and sends it to the Agent to enrich the metrics with container tags. Origin detection can be disabled by configuring the environment variabe DD_ORIGIN_DETECTION_ENABLED=false The client tries to read the container ID by parsing the file /proc/self/cgroup. This is not supported on Windows.
  - connectionTimeout
```
public int connectionTimeout
```
    The timeout in milliseconds for connecting to the StatsD server. Applies to unix sockets only.
    It is also used to detect if a connection is still alive and re-establish a new one if needed.
  - addressLookup
```
public Callable<SocketAddress> addressLookup
```
    Yields the IP address and socket of the StatsD server.
  - telemetryAddressLookup
```
public Callable<SocketAddress> telemetryAddressLookup
```
    Yields the IP address and socket of the StatsD telemetry server destination.
  - hostname
```
public String hostname
```
  - telemetryHostname
```
public String telemetryHostname
```
  - namedPipe
```
public String namedPipe
```
  - prefix
```
public String prefix
```
    The prefix to apply to keys sent via this client.
  - entityID
```
public String entityID
```
    The entity id value used with an internal tag for tracking client entity.
    If null the client default the value with the environment variable "DD_ENTITY_ID". If the environment variable is not defined, the internal tag is not added.
  - constantTags
```
public String[] constantTags
```
    Tags to be added to all content sent.
  - containerID
```
public String containerID
```
    Allows passing the container ID, this will be used by the Agent to enrich metrics with container tags.
    This feature requires Datadog Agent version >=6.35.0 && <7.0.0 or Agent versions >=7.35.0. When configured, the provided container ID is prioritized over the container ID discovered via Origin Detection. When entityID or DD_ENTITY_ID are set, this value is ignored.
  - errorHandler
```
public StatsDClientErrorHandler errorHandler
```
    Handler to use when an exception occurs during usage, may be null to indicate noop.
  - threadFactory
```
public ThreadFactory threadFactory
```
  - tagsCardinality
```
public TagsCardinality tagsCardinality
```
- 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)
```
    The maximum amount of unprocessed messages in the queue.
  - timeout
```
public NonBlockingStatsDClientBuilder timeout(int val)
```
    The timeout in milliseconds for blocking operations. Applies to unix sockets only.
  - connectionTimeout
```
public NonBlockingStatsDClientBuilder connectionTimeout(int val)
```
    The timeout in milliseconds for connecting to the StatsD server. Applies to unix sockets only.
    It is also used to detect if a connection is still alive and re-establish a new one if needed.
  - bufferPoolSize
```
public NonBlockingStatsDClientBuilder bufferPoolSize(int val)
```
    The size for the network buffer pool.
  - socketBufferSize
```
public NonBlockingStatsDClientBuilder socketBufferSize(int val)
```
    The socket buffer size in bytes. Applies to unix sockets only.
  - maxPacketSizeBytes
```
public NonBlockingStatsDClientBuilder maxPacketSizeBytes(int val)
```
  - processorWorkers
```
public NonBlockingStatsDClientBuilder processorWorkers(int val)
```
    The number of processor worker threads assembling buffers for submission.
  - senderWorkers
```
public NonBlockingStatsDClientBuilder senderWorkers(int val)
```
    The number of sender worker threads submitting buffers to the socket.
  - blocking
```
public NonBlockingStatsDClientBuilder blocking(boolean val)
```
    Blocking or non-blocking implementation for statsd message queue.
  - addressLookup
```
public NonBlockingStatsDClientBuilder addressLookup(Callable<SocketAddress> val)
```
    Yields the IP address and socket of the StatsD server.
  - telemetryAddressLookup
```
public NonBlockingStatsDClientBuilder telemetryAddressLookup(Callable<SocketAddress> val)
```
    Yields the IP address and socket of the StatsD telemetry server destination.
  - hostname
```
public NonBlockingStatsDClientBuilder hostname(String val)
```
  - telemetryHostname
```
public NonBlockingStatsDClientBuilder telemetryHostname(String val)
```
  - namedPipe
```
public NonBlockingStatsDClientBuilder namedPipe(String val)
```
  - address
```
public NonBlockingStatsDClientBuilder address(String address)
```
  - telemetryAddress
```
public NonBlockingStatsDClientBuilder telemetryAddress(String address)
```
  - prefix
```
public NonBlockingStatsDClientBuilder prefix(String val)
```
    The prefix to apply to keys sent via this client.
  - entityID
```
public NonBlockingStatsDClientBuilder entityID(String val)
```
    The entity id value used with an internal tag for tracking client entity.
    If null the client default the value with the environment variable "DD_ENTITY_ID". If the environment variable is not defined, the internal tag is not added.
  - constantTags
```
public NonBlockingStatsDClientBuilder constantTags(String... val)
```
    Tags to be added to all content sent.
  - errorHandler
```
public NonBlockingStatsDClientBuilder errorHandler(StatsDClientErrorHandler val)
```
    Handler to use when an exception occurs during usage, may be null to indicate noop.
  - enableTelemetry
```
public NonBlockingStatsDClientBuilder enableTelemetry(boolean val)
```
    Enable sending client telemetry.
  - enableAggregation
```
public NonBlockingStatsDClientBuilder enableAggregation(boolean val)
```
  - telemetryFlushInterval
```
public NonBlockingStatsDClientBuilder telemetryFlushInterval(int val)
```
    Telemetry flush interval, in milliseconds.
  - aggregationFlushInterval
```
public NonBlockingStatsDClientBuilder aggregationFlushInterval(int val)
```
    Aggregation flush interval, in milliseconds. 0 disables aggregation.
  - aggregationShards
```
public NonBlockingStatsDClientBuilder aggregationShards(int val)
```
  - threadFactory
```
public NonBlockingStatsDClientBuilder threadFactory(ThreadFactory val)
```
  - containerID
```
public NonBlockingStatsDClientBuilder containerID(String val)
```
    Allows passing the container ID, this will be used by the Agent to enrich metrics with container tags.
    This feature requires Datadog Agent version >=6.35.0 && <7.0.0 or Agent versions >=7.35.0. When configured, the provided container ID is prioritized over the container ID discovered via Origin Detection. When entityID or DD_ENTITY_ID are set, this value is ignored.
  - originDetectionEnabled
```
public NonBlockingStatsDClientBuilder originDetectionEnabled(boolean val)
```
    Enable/disable the client origin detection.
    This feature requires Datadog Agent version >=6.35.0 && <7.0.0 or Agent versions >7.35.0. When enabled, the client tries to discover its container ID and sends it to the Agent to enrich the metrics with container tags. Origin detection can be disabled by configuring the environment variabe DD_ORIGIN_DETECTION_ENABLED=false The client tries to read the container ID by parsing the file /proc/self/cgroup. This is not supported on Windows. The client prioritizes the value passed via or entityID or DD_ENTITY_ID (if set) over the container ID.
  - tagsCardinality
```
public NonBlockingStatsDClientBuilder tagsCardinality(TagsCardinality cardinality)
```
    Request that all metrics from this client to be enriched to specified tag cardinality.
    See Tags cardinality documentation.
  - build
```
public NonBlockingStatsDClient build()
                              throws StatsDClientException
```
    NonBlockingStatsDClient factory method.
    
    Returns:
    
    the built NonBlockingStatsDClient.
    
    Throws:
    
    StatsDClientException
  - buildDirectStatsDClient
```
public DirectStatsDClient buildDirectStatsDClient()
                                           throws StatsDClientException
```
    DirectStatsDClient factory method.
    It is an experimental extension of StatsDClient that allows for direct access to some dogstatsd features. It is not recommended to use this client in production.
    
    Returns:
    
    the built DirectStatsDClient.
    
    Throws:
    
    StatsDClientException
    
    See Also:
    
    DirectStatsDClient
  - 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.
    
    port - the port of the targeted StatsD server.
    
    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
  - staticNamedPipeResolution
```
protected static Callable<SocketAddress> staticNamedPipeResolution(String namedPipe)
```
  - staticUnixResolution
```
protected static Callable<SocketAddress> staticUnixResolution(String path,
                                                              UnixSocketAddressWithTransport.TransportType transportType)
```

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

connectionTimeout

addressLookup

telemetryAddressLookup

hostname

telemetryHostname

namedPipe

prefix

entityID

constantTags

containerID

errorHandler

threadFactory

tagsCardinality

Constructor Detail

NonBlockingStatsDClientBuilder

Method Detail

port

telemetryPort

queueSize

timeout

connectionTimeout

bufferPoolSize

socketBufferSize

maxPacketSizeBytes

processorWorkers

senderWorkers

blocking

addressLookup

telemetryAddressLookup

hostname

telemetryHostname

namedPipe

address

telemetryAddress

prefix

entityID

constantTags

errorHandler

enableTelemetry

enableAggregation

telemetryFlushInterval

aggregationFlushInterval

aggregationShards

threadFactory

containerID

originDetectionEnabled

tagsCardinality

build

buildDirectStatsDClient

resolve

volatileAddressResolution

staticAddressResolution

staticNamedPipeResolution

staticUnixResolution