Package com.arpnetworking.metrics.mad.configuration

Class AggregatorConfiguration.Builder

java.lang.Object

com.arpnetworking.commons.builder.OvalBuilder<AggregatorConfiguration>

com.arpnetworking.metrics.mad.configuration.AggregatorConfiguration.Builder

All Implemented Interfaces:

com.arpnetworking.commons.builder.Builder<AggregatorConfiguration>

Enclosing class:

AggregatorConfiguration

public static class AggregatorConfiguration.Builder
extends com.arpnetworking.commons.builder.OvalBuilder<AggregatorConfiguration>

Builder implementation for AggregatorConfiguration.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot io)

Constructor Summary

Constructors

Constructor	Description
Builder()	Public constructor.

Method Summary

Modifier and Type	Method	Description
AggregatorConfiguration.Builder	setAkkaConfiguration(Map<String,?> value)	Akka configuration.
AggregatorConfiguration.Builder	setEnableHttps(Boolean value)	Whether to start the https server.
AggregatorConfiguration.Builder	setHttpHealthCheckPath(String value)	The http health check path.
AggregatorConfiguration.Builder	setHttpHost(String value)	The http host address to bind to.
AggregatorConfiguration.Builder	setHttpPort(Integer value)	The http port to listen on.
AggregatorConfiguration.Builder	setHttpsCertificatePath(String value)	The location of the https certificate file.
AggregatorConfiguration.Builder	setHttpsHost(String value)	The https host address to bind to.
AggregatorConfiguration.Builder	setHttpsKeyPath(String value)	The location of the https key file.
AggregatorConfiguration.Builder	setHttpsPort(Integer value)	The https port to listen on.
AggregatorConfiguration.Builder	setHttpStatusPath(String value)	The http status path.
AggregatorConfiguration.Builder	setJvmMetricsCollectionInterval(Duration value)	Period for collecting JVM metrics.
AggregatorConfiguration.Builder	setLogDeadLetters(Boolean value)	Whether to install the DeadLetterLogger to log all dead letter senders, recipients and messages.
AggregatorConfiguration.Builder	setLogDirectory(File value)	The log directory.
AggregatorConfiguration.Builder	setMetricsClientHost(String value)	Deprecated. Use setMonitoringSinks(ImmutableList)
AggregatorConfiguration.Builder	setMetricsClientPort(Integer value)	Deprecated. Use setMonitoringSinks(ImmutableList)
AggregatorConfiguration.Builder	setMonitoringCluster(String value)	The monitoring cluster.
AggregatorConfiguration.Builder	setMonitoringHost(String value)	The host to use as value for the host tag.
AggregatorConfiguration.Builder	setMonitoringService(String value)	The monitoring service.
AggregatorConfiguration.Builder	setMonitoringSinks(com.google.common.collect.ImmutableList<com.fasterxml.jackson.databind.JsonNode> value)	The monitoring sinks.
AggregatorConfiguration.Builder	setPipelinesDirectory(File value)	The pipelines directory.
AggregatorConfiguration.Builder	setSupplementalHttpRoutesClass(Class<? extends SupplementalRoutes> value)	The supplemental routes class.

Methods inherited from class com.arpnetworking.commons.builder.OvalBuilder

build, clone, clone, construct, isSelfValidating, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Public constructor.

Method Details

setMonitoringCluster

public AggregatorConfiguration.Builder setMonitoringCluster(String value)

The monitoring cluster. Cannot be null or empty.

Parameters:

value - The monitoring cluster.

Returns:

This instance of AggregatorConfiguration.Builder.

setMonitoringService

public AggregatorConfiguration.Builder setMonitoringService(String value)

The monitoring service. Optional. Cannot be null or empty. The default value is mad.

Parameters:

value - The monitoring service.

Returns:

This instance of AggregatorConfiguration.Builder.

setMonitoringSinks

public AggregatorConfiguration.Builder setMonitoringSinks(com.google.common.collect.ImmutableList<com.fasterxml.jackson.databind.JsonNode> value)

The monitoring sinks. Optional. Cannot be null. The default value is the default instance of ApacheHttpSink.

Parameters:

value - The monitoring sinks.

Returns:

This instance of AggregatorConfiguration.Builder.

setMetricsClientHost

@Deprecated
public AggregatorConfiguration.Builder setMetricsClientHost(@Nullable
 String value)

Deprecated.

Use setMonitoringSinks(ImmutableList)

The metrics client http host address to send to. Optional. Cannot be empty. Defaults to unspecified.

Parameters:

value - The metrics client host address to send to.

Returns:

This instance of AggregatorConfiguration.Builder.

setMetricsClientPort

@Deprecated
public AggregatorConfiguration.Builder setMetricsClientPort(@Nullable
 Integer value)

Deprecated.

Use setMonitoringSinks(ImmutableList)

The metrics client http port to send to. Optional. Must be between 1 and 65535 (inclusive). Defaults to unspecified.

Parameters:

value - The metrics client port to listen send to.

Returns:

This instance of AggregatorConfiguration.Builder.

setJvmMetricsCollectionInterval

public AggregatorConfiguration.Builder setJvmMetricsCollectionInterval(Duration value)

Period for collecting JVM metrics. Optional. Default is 500 milliseconds.

Parameters:

value - A Duration value.

Returns:

This instance of AggregatorConfiguration.Builder.

setLogDirectory

public AggregatorConfiguration.Builder setLogDirectory(File value)

The log directory. Cannot be null.

Parameters:

value - The log directory.

Returns:

This instance of AggregatorConfiguration.Builder.

setPipelinesDirectory

public AggregatorConfiguration.Builder setPipelinesDirectory(File value)

The pipelines directory. Cannot be null.

Parameters:

value - The pipelines directory.

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpHost

public AggregatorConfiguration.Builder setHttpHost(String value)

The http host address to bind to. Cannot be null or empty.

Parameters:

value - The host address to bind to.

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpsHost

public AggregatorConfiguration.Builder setHttpsHost(String value)

The https host address to bind to. Cannot be null or empty.

Parameters:

value - The host address to bind to.

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpHealthCheckPath

public AggregatorConfiguration.Builder setHttpHealthCheckPath(String value)

The http health check path. Cannot be null or empty. Optional. Default is "/ping".

Parameters:

value - The health check path.

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpStatusPath

public AggregatorConfiguration.Builder setHttpStatusPath(String value)

The http status path. Cannot be null or empty. Optional. Default is "/status".

Parameters:

value - The status path.

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpsKeyPath

public AggregatorConfiguration.Builder setHttpsKeyPath(String value)

The location of the https key file. Cannot be null or empty. Optional. Default is "/opt/mad/tls/key.pem".

Parameters:

value - The path to the https key file

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpsCertificatePath

public AggregatorConfiguration.Builder setHttpsCertificatePath(String value)

The location of the https certificate file. Cannot be null or empty. Optional. Default is "/opt/mad/tls/cert.pem".

Parameters:

value - The path to the https cert file

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpPort

public AggregatorConfiguration.Builder setHttpPort(Integer value)

The http port to listen on. Cannot be null, must be between 1 and 65535 (inclusive).

Parameters:

value - The port to listen on.

Returns:

This instance of AggregatorConfiguration.Builder.

setHttpsPort

public AggregatorConfiguration.Builder setHttpsPort(Integer value)

The https port to listen on. Cannot be null, must be between 1 and 65535 (inclusive).

Parameters:

value - The port to listen on.

Returns:

This instance of AggregatorConfiguration.Builder.

setEnableHttps

public AggregatorConfiguration.Builder setEnableHttps(Boolean value)

Whether to start the https server. Value cannot be null. Defaults to false

Parameters:

value - True if the https server should be enabled

Returns:

This instance of AggregatorConfiguration.Builder.

setSupplementalHttpRoutesClass

public AggregatorConfiguration.Builder setSupplementalHttpRoutesClass(Class<? extends SupplementalRoutes> value)

The supplemental routes class. Optional.

Parameters:

value - The class of the supplement routes.

Returns:

This instance of AggregatorConfiguration.Builder.

setMonitoringHost

public AggregatorConfiguration.Builder setMonitoringHost(String value)

The host to use as value for the host tag. Optional. Defaults to looking up the hostname.

Parameters:

value - The host to use as value for the host tag.

Returns:

This instance of AggregatorConfiguration.Builder.

setLogDeadLetters

public AggregatorConfiguration.Builder setLogDeadLetters(Boolean value)

Whether to install the DeadLetterLogger to log all dead letter senders, recipients and messages. It differs from the built-in Akka logging in that it actually logs the message (as provided by toString()) instead of just the message type.

Parameters:

value - True if dead letter logging should be enabled

Returns:

This instance of AggregatorConfiguration.Builder.

setAkkaConfiguration

public AggregatorConfiguration.Builder setAkkaConfiguration(Map<String,?> value)

Akka configuration. Cannot be null. By convention Akka configuration begins with a map containing a single key "akka" and a value of a nested map. For more information please see: http://doc.akka.io/docs/akka/snapshot/general/configuration.html NOTE: No validation is performed on the Akka configuration itself.

Parameters:

value - The Akka configuration.

Returns:

This instance of AggregatorConfiguration.Builder.