com.swrve.ratelimitedlogger

Class RateLimitedLogBuilder

java.lang.Object

com.swrve.ratelimitedlogger.RateLimitedLogBuilder

@NotThreadSafe
public class RateLimitedLogBuilder
extends java.lang.Object

Factory to create new RateLimitedLog instances in a fluent Builder style. Start with RateLimitedLog.withRateLimit(logger).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimitedLogBuilder.MissingPeriod
static class	RateLimitedLogBuilder.MissingRateAndPeriod

Method Summary

Methods

Modifier and Type	Method and Description
RateLimitedLog	build()
RateLimitedLogBuilder	recordMetrics(CounterMetric stats) Optional: should we record metrics about the call rate using @param stats.
RateLimitedLogBuilder	withStopwatch(com.google.common.base.Stopwatch stopwatch) Specify that the rate-limited logger should compute time using @param stopwatch.

Methods inherited from class java.lang.Object

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

Method Detail

withStopwatch

public RateLimitedLogBuilder withStopwatch(com.google.common.base.Stopwatch stopwatch)

Specify that the rate-limited logger should compute time using @param stopwatch.

recordMetrics

public RateLimitedLogBuilder recordMetrics(CounterMetric stats)

Optional: should we record metrics about the call rate using @param stats. Default is not to record metrics

build

public RateLimitedLog build()

Returns:

a fully-built RateLimitedLog matching the requested configuration.