Package com.arpnetworking.metrics.common.sources

Class PrometheusHttpSource.Builder

java.lang.Object

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

com.arpnetworking.metrics.common.sources.BaseSource.Builder<B,S>

com.arpnetworking.metrics.common.sources.ActorSource.Builder<B,S>

com.arpnetworking.metrics.common.sources.HttpSource.Builder<PrometheusHttpSource.Builder,PrometheusHttpSource>

com.arpnetworking.metrics.common.sources.PrometheusHttpSource.Builder

All Implemented Interfaces:

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

Enclosing class:

PrometheusHttpSource

public static final class PrometheusHttpSource.Builder
extends HttpSource.Builder<PrometheusHttpSource.Builder,PrometheusHttpSource>

PrometheusHttpSource BaseSource.Builder implementation.

Constructor Summary

Constructors

Constructor	Description
Builder()	Public constructor.

Method Summary

Modifier and Type	Method	Description
PrometheusHttpSource	build()
protected PrometheusHttpSource.Builder	self()	Called by setters to always return appropriate subclass of BaseSource.Builder, even from setters of base class.
PrometheusHttpSource.Builder	setInterpretUnits(Boolean value)	Whether to interpret units in the metric name.
PrometheusHttpSource.Builder	setOutputDebugFiles(Boolean value)	Whether to output debug files with the raw prometheus data.
PrometheusHttpSource.Builder	setReservedNameWhitelist(HashSet<String> value)	Whitelist for reserved metrics names (names with aggregation keys).

Methods inherited from class com.arpnetworking.metrics.common.sources.HttpSource.Builder

setParser, setPeriodicMetrics

Methods inherited from class com.arpnetworking.metrics.common.sources.ActorSource.Builder

setActorName, setActorSystem, setPoolSize

Methods inherited from class com.arpnetworking.metrics.common.sources.BaseSource.Builder

setName

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

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

setInterpretUnits

public PrometheusHttpSource.Builder setInterpretUnits(Boolean value)

Whether to interpret units in the metric name. Optional. Defaults to false. Cannot be null.

Parameters:

value - the value

Returns:

this PrometheusHttpSource.Builder

setOutputDebugFiles

public PrometheusHttpSource.Builder setOutputDebugFiles(Boolean value)

Whether to output debug files with the raw prometheus data. Cannot be null.

Parameters:

value - the value

Returns:

this PrometheusHttpSource.Builder

setReservedNameWhitelist

public PrometheusHttpSource.Builder setReservedNameWhitelist(HashSet<String> value)

Whitelist for reserved metrics names (names with aggregation keys). By default, we ignore metrics with aggregation keys unless specified here. Cannot be null.

Parameters:

value - the value

Returns:

this PrometheusHttpSource.Builder

self

protected PrometheusHttpSource.Builder self()

Description copied from class: BaseSource.Builder

Called by setters to always return appropriate subclass of BaseSource.Builder, even from setters of base class.

Specified by:

self in class BaseSource.Builder<PrometheusHttpSource.Builder,PrometheusHttpSource>

Returns:

instance with correct BaseSource.Builder class type.

build

public PrometheusHttpSource build()

Specified by:

build in interface com.arpnetworking.commons.builder.Builder<PrometheusHttpSource>

Overrides:

build in class com.arpnetworking.commons.builder.OvalBuilder<PrometheusHttpSource>