com.uber.m3.tally.m3

Class M3Reporter.Builder

java.lang.Object

com.uber.m3.tally.m3.M3Reporter.Builder

Enclosing class:

M3Reporter

public static class M3Reporter.Builder
extends java.lang.Object

Builder pattern to construct an M3Reporter.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.uber.m3.util.ImmutableMap<java.lang.String,java.lang.String>	commonTags
protected java.net.SocketAddress[]	endpointSocketAddresses
protected java.lang.String	env
protected java.util.concurrent.ExecutorService	executor
protected java.lang.String	histogramBucketIdName
protected java.lang.String	histogramBucketName
protected int	histogramBucketTagPrecision
protected boolean	includeHost
protected int	maxPacketSizeBytes
protected int	maxProcessorWaitUntilFlushMillis
protected java.lang.String	service

Constructor Summary

Constructors

Constructor and Description
Builder(java.net.SocketAddress socketAddress) Constructs a M3Reporter.Builder.
Builder(java.net.SocketAddress[] endpointSocketAddresses) Constructs a M3Reporter.Builder.

Method Summary

Modifier and Type	Method and Description
M3Reporter	build() Builds and returns an M3Reporter with the configured paramters.
M3Reporter.Builder	commonTags(com.uber.m3.util.ImmutableMap<java.lang.String,java.lang.String> commonTags) Configures the common tags of this M3Reporter.Builder.
M3Reporter.Builder	env(java.lang.String env) Configures the env of this M3Reporter.Builder.
M3Reporter.Builder	executor(java.util.concurrent.ExecutorService executor) Configures the executor of this M3Reporter.Builder.
M3Reporter.Builder	histogramBucketIdName(java.lang.String histogramBucketIdName) Configures the histogram bucket ID name of this M3Reporter.Builder.
M3Reporter.Builder	histogramBucketName(java.lang.String histogramBucketName) Configures the histogram bucket name of this M3Reporter.Builder.
M3Reporter.Builder	histogramBucketTagPrecision(int histogramBucketTagPrecision) Configures the histogram bucket tag precision of this M3Reporter.Builder.
M3Reporter.Builder	includeHost(boolean includeHost) Configures whether to include the host tag of this M3Reporter.Builder.
M3Reporter.Builder	maxPacketSizeBytes(int maxPacketSizeBytes) Configures the maximum packet size in bytes of this M3Reporter.Builder.
M3Reporter.Builder	maxProcessorWaitUntilFlushMillis(int maxProcessorWaitUntilFlushMillis) Configures the maximum wait time in milliseconds size in bytes of this M3Reporter.Builder.
M3Reporter.Builder	maxQueueSize(int maxQueueSize) Deprecated. this method has no impact anymore and will be deleted in the next release
M3Reporter.Builder	service(java.lang.String service) Configures the service of this M3Reporter.Builder.

Methods inherited from class java.lang.Object

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

Field Detail

endpointSocketAddresses

protected java.net.SocketAddress[] endpointSocketAddresses

service

protected java.lang.String service

env

protected java.lang.String env

executor

protected java.util.concurrent.ExecutorService executor

commonTags

protected com.uber.m3.util.ImmutableMap<java.lang.String,java.lang.String> commonTags

includeHost

protected boolean includeHost

maxPacketSizeBytes

protected int maxPacketSizeBytes

maxProcessorWaitUntilFlushMillis

protected int maxProcessorWaitUntilFlushMillis

histogramBucketIdName

protected java.lang.String histogramBucketIdName

histogramBucketName

protected java.lang.String histogramBucketName

histogramBucketTagPrecision

protected int histogramBucketTagPrecision

Constructor Detail

Builder

public Builder(java.net.SocketAddress[] endpointSocketAddresses)

Constructs a M3Reporter.Builder. Having at least one SocketAddress is required.

Parameters:

endpointSocketAddresses - the array of SocketAddresses for this M3Reporter

Builder

public Builder(java.net.SocketAddress socketAddress)

Constructs a M3Reporter.Builder. Having at least one SocketAddress is required.

Parameters:

socketAddress - the SocketAddress for this M3Reporter

Method Detail

service

public M3Reporter.Builder service(java.lang.String service)

Configures the service of this M3Reporter.Builder.

Parameters:

service - the value to set

Returns:

this M3Reporter.Builder with the new value set

env

public M3Reporter.Builder env(java.lang.String env)

Configures the env of this M3Reporter.Builder.

Parameters:

env - the value to set

Returns:

this M3Reporter.Builder with the new value set

executor

public M3Reporter.Builder executor(java.util.concurrent.ExecutorService executor)

Configures the executor of this M3Reporter.Builder.

Parameters:

executor - the value to set

Returns:

this M3Reporter.Builder with the new value set

commonTags

public M3Reporter.Builder commonTags(com.uber.m3.util.ImmutableMap<java.lang.String,java.lang.String> commonTags)

Configures the common tags of this M3Reporter.Builder.

Parameters:

commonTags - the value to set

Returns:

this M3Reporter.Builder with the new value set

includeHost

public M3Reporter.Builder includeHost(boolean includeHost)

Configures whether to include the host tag of this M3Reporter.Builder.

Parameters:

includeHost - the value to set

Returns:

this M3Reporter.Builder with the new value set

maxQueueSize

@Deprecated
public M3Reporter.Builder maxQueueSize(int maxQueueSize)

Deprecated. this method has no impact anymore and will be deleted in the next release

Configures the maximum queue size of this M3Reporter.Builder.

Parameters:

maxQueueSize - the value to set

Returns:

this M3Reporter.Builder with the new value set

maxPacketSizeBytes

public M3Reporter.Builder maxPacketSizeBytes(int maxPacketSizeBytes)

Configures the maximum packet size in bytes of this M3Reporter.Builder.

Parameters:

maxPacketSizeBytes - the value to set

Returns:

this M3Reporter.Builder with the new value set

maxProcessorWaitUntilFlushMillis

public M3Reporter.Builder maxProcessorWaitUntilFlushMillis(int maxProcessorWaitUntilFlushMillis)

Configures the maximum wait time in milliseconds size in bytes of this M3Reporter.Builder.

Parameters:

maxProcessorWaitUntilFlushMillis - the value to set

Returns:

this M3Reporter.Builder with the new value set

histogramBucketIdName

public M3Reporter.Builder histogramBucketIdName(java.lang.String histogramBucketIdName)

Configures the histogram bucket ID name of this M3Reporter.Builder.

Parameters:

histogramBucketIdName - the value to set

Returns:

this M3Reporter.Builder with the new value set

histogramBucketName

public M3Reporter.Builder histogramBucketName(java.lang.String histogramBucketName)

Configures the histogram bucket name of this M3Reporter.Builder.

Parameters:

histogramBucketName - the value to set

Returns:

this M3Reporter.Builder with the new value set

histogramBucketTagPrecision

public M3Reporter.Builder histogramBucketTagPrecision(int histogramBucketTagPrecision)

Configures the histogram bucket tag precision of this M3Reporter.Builder.

Parameters:

histogramBucketTagPrecision - the value to set

Returns:

this M3Reporter.Builder with the new value set

build

public M3Reporter build()

Builds and returns an M3Reporter with the configured paramters.

Returns:

a new M3Reporter instance with the configured paramters