Class ThrottleFilterBuilder

java.lang.Object

io.jstach.rainbowgum.filter.ThrottleFilterBuilder

All Implemented Interfaces:

LogBuilder<ThrottleFilterBuilder, LogRouter.Router.Filter>

public final class ThrottleFilterBuilder
extends Object
implements LogBuilder<ThrottleFilterBuilder, LogRouter.Router.Filter>

Builder to create LogRouter.Router.Filter. Limits how many events a route keeps per second, like a token bucket. A burst of up to maxBurst events is kept, after which events are kept at rate per second until the burst is earned back. Events more severe than level are always kept. Time is measured with event timestamps.

Properties retrieved from LogProperties

Property Pattern	Type	Required	Default	Description
logging.route.{name}.filter.{filter}.rate	Integer	true	10	Events kept per second once a burst is used up.
logging.route.{name}.filter.{filter}.maxBurst	Integer	true	100	Events kept at once before the rate applies.
logging.route.{name}.filter.{filter}.level	String (converted)	true	warning, so errors are always kept	The most severe level that is throttled.

Constructor Summary

Constructors

Constructor	Description
ThrottleFilterBuilder(String name, String filter)	Create a builder for io.jstach.rainbowgum.LogRouter.Router.Filter .

Method Summary

Modifier and Type	Method	Description
LogRouter.Router.Filter	build()	Creates io.jstach.rainbowgum.LogRouter.Router.Filter from this builder.
ThrottleFilterBuilder	fromProperties(LogProperties properties)	Will try to convert string key values to parameters needed by the builder.
ThrottleFilterBuilder	level(System.Logger.Level level)	Sets required level.
ThrottleFilterBuilder	maxBurst(Integer maxBurst)	Sets required maxBurst.
ThrottleFilterBuilder	metrics(@Nullable LogMetrics metrics)	Sets metrics.
String	propertyPrefix()	The interpolated property prefix: "logging.route.{name}.filter.{filter}.".
ThrottleFilterBuilder	rate(Integer rate)	Sets required rate.

Methods inherited from class Object

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

Methods inherited from interface LogBuilder

fromProperties

Modifier and Type	Method	Description
default ThrottleFilterBuilder	fromProperties(LogProperties properties, LogProviderRef ref)	Will try to convert string key values to parameters needed by the builder.

Constructor Details

ThrottleFilterBuilder

public ThrottleFilterBuilder(String name,
 String filter)

Create a builder for io.jstach.rainbowgum.LogRouter.Router.Filter .

Parameters:

name - will fill {name} in logging.route.{name}.filter.{filter}.. Route name.

filter - will fill {filter} in logging.route.{name}.filter.{filter}.. Name the filter is selected with.

Method Details

metrics

public ThrottleFilterBuilder metrics(@Nullable LogMetrics metrics)

Sets metrics. Where to count dropped events as LogMetrics.EVENTS_THROTTLED_METRIC. Default is null.

Parameters:

metrics - not configurable through properties Where to count dropped events as LogMetrics.EVENTS_THROTTLED_METRIC.

Returns:

this builder.

rate

public ThrottleFilterBuilder rate(Integer rate)

Sets required rate. Events kept per second once a burst is used up. Default is 10.

Parameters:

rate - "logging.route.{name}.filter.{filter}.rate" = java.lang.Integer Events kept per second once a burst is used up.

Returns:

this builder.

maxBurst

public ThrottleFilterBuilder maxBurst(Integer maxBurst)

Sets required maxBurst. Events kept at once before the rate applies. Default is 100.

Parameters:

maxBurst - "logging.route.{name}.filter.{filter}.maxBurst" = java.lang.Integer Events kept at once before the rate applies.

Returns:

this builder.

level

public ThrottleFilterBuilder level(System.Logger.Level level)

Sets required level. The most severe level that is throttled. Default is warning, so errors are always kept.

Parameters:

level - "logging.route.{name}.filter.{filter}.level" = java.lang.System.Logger.Level The most severe level that is throttled.

Returns:

this builder.

build

public LogRouter.Router.Filter build()

Creates io.jstach.rainbowgum.LogRouter.Router.Filter from this builder.

Returns:

io.jstach.rainbowgum.LogRouter.Router.Filter .

fromProperties

public ThrottleFilterBuilder fromProperties(LogProperties properties)

Description copied from interface: LogBuilder

Will try to convert string key values to parameters needed by the builder.

Specified by:

fromProperties in interface LogBuilder<ThrottleFilterBuilder, LogRouter.Router.Filter>

Parameters:

properties - log properties

Returns:

this.

propertyPrefix

public String propertyPrefix()

The interpolated property prefix: "logging.route.{name}.filter.{filter}.".

Specified by:

propertyPrefix in interface LogBuilder<ThrottleFilterBuilder, LogRouter.Router.Filter>

Returns:

resolved prefix which should end with a ".".

See Also:

• LogConfigurable.prefix()