fr.gouv.vitam.common.metrics

Class LogbackReporter.Builder

java.lang.Object

fr.gouv.vitam.common.metrics.LogbackReporter.Builder

Enclosing class:

LogbackReporter

public static class LogbackReporter.Builder
extends Object

A builder for ConsoleReporter instances. Defaults to using the default locale and time zone, writing to System.out, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.

Method Summary

Modifier and Type	Method and Description
LogbackReporter	build() Builds a ConsoleReporter with the given properties.
LogbackReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
LogbackReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
LogbackReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
LogbackReporter.Builder	formattedFor(Locale locale) Format numbers for the given Locale.
LogbackReporter.Builder	formattedFor(TimeZone timeZone) Use the given TimeZone for the time.
LogbackReporter.Builder	logLevel(VitamLogLevel logLevel) Set the LogBack log level
LogbackReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.

Methods inherited from class java.lang.Object

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

Method Detail

formattedFor

public LogbackReporter.Builder formattedFor(Locale locale)

Format numbers for the given Locale.

Parameters:

locale - a Locale

Returns:

this

withClock

public LogbackReporter.Builder withClock(com.codahale.metrics.Clock clock)

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

formattedFor

public LogbackReporter.Builder formattedFor(TimeZone timeZone)

Use the given TimeZone for the time.

Parameters:

timeZone - a TimeZone

Returns:

this

convertRatesTo

public LogbackReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public LogbackReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

public LogbackReporter.Builder filter(com.codahale.metrics.MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

logLevel

public LogbackReporter.Builder logLevel(VitamLogLevel logLevel)

Set the LogBack log level

Parameters:

logLevel - VitamLogLevel

Returns:

this

build

public LogbackReporter build()

Builds a ConsoleReporter with the given properties.

Returns:

a ConsoleReporter