org.attribyte.essem.reporter

Class EssemReporter.Builder

java.lang.Object

org.attribyte.essem.reporter.EssemReporter.Builder

Enclosing class:

EssemReporter

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

Method Summary

Modifier and Type	Method and Description
EssemReporter	build() Builds an immutable reporter instance.
EssemReporter.Builder	convertDurationsTo(java.util.concurrent.TimeUnit durationUnit) Configures the duration conversion.
EssemReporter.Builder	convertRatesTo(java.util.concurrent.TimeUnit rateUnit) Configures the rate conversion.
EssemReporter.Builder	filter(MetricFilter filter) Applies a filter to the registry before reporting.
EssemReporter.Builder	forApplication(java.lang.String application) Sets the application name.
EssemReporter.Builder	forHost(java.lang.String host) Sets the host.
EssemReporter.Builder	forInstance(java.lang.String instance) Sets the instance name.
EssemReporter.Builder	withAuthorization(java.lang.String authValue) Sets a value to be sent as the value of the Authorization header.
EssemReporter.Builder	withBasicAuthorization(java.lang.String username, java.lang.String password) Configures HTTP Basic auth.
EssemReporter.Builder	withClock(Clock clock) Configures the clock.
EssemReporter.Builder	withDeflate(boolean deflate) Configures 'deflate' of sent reports.

Methods inherited from class java.lang.Object

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

Method Detail

withClock

public EssemReporter.Builder withClock(Clock clock)

Configures the clock.

Parameters:

clock - The clock.

Returns:

A self-reference.

forApplication

public EssemReporter.Builder forApplication(java.lang.String application)

Sets the application name.

Parameters:

application - The application name.

Returns:

A self-reference.

forHost

public EssemReporter.Builder forHost(java.lang.String host)

Sets the host.

Parameters:

host - The host.

Returns:

A self-reference.

forInstance

public EssemReporter.Builder forInstance(java.lang.String instance)

Sets the instance name.

Parameters:

instance - The instance name.

Returns:

A self-reference.

convertRatesTo

public EssemReporter.Builder convertRatesTo(java.util.concurrent.TimeUnit rateUnit)

Configures the rate conversion. Default is seconds.

Parameters:

rateUnit - The rate unit.

Returns:

A self-reference.

convertDurationsTo

public EssemReporter.Builder convertDurationsTo(java.util.concurrent.TimeUnit durationUnit)

Configures the duration conversion. Default is milliseconds.

Parameters:

durationUnit - The duration unit.

Returns:

A self-reference.

filter

public EssemReporter.Builder filter(MetricFilter filter)

Applies a filter to the registry before reporting.

Parameters:

filter - The filter.

Returns:

A self-reference.

withAuthorization

public EssemReporter.Builder withAuthorization(java.lang.String authValue)

Sets a value to be sent as the value of the Authorization header.

Parameters:

authValue - The authorization header value.

Returns:

A self-reference.

withBasicAuthorization

public EssemReporter.Builder withBasicAuthorization(java.lang.String username,
                                                    java.lang.String password)

Configures HTTP Basic auth.

Parameters:

username - The username.

password - The password.

Returns:

A self-reference.

withDeflate

public EssemReporter.Builder withDeflate(boolean deflate)

Configures 'deflate' of sent reports.

Parameters:

deflate - Should deflate be used?

Returns:

A self-reference.

build

public EssemReporter build()

Builds an immutable reporter instance.

Returns:

The immutable reporter.