Package org.forgerock.monitoring.dropwizard

Class AbstractMeterRegistry.ConfigImpl

java.lang.Object

org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl

All Implemented Interfaces:

MeterRegistry.Config

Enclosing class:

AbstractMeterRegistry

public class AbstractMeterRegistry.ConfigImpl
extends Object
implements MeterRegistry.Config

Access to configuration options for this registry. ForgeRock changes: - Removed @Incubating annotations

Constructor Summary

Constructors

Constructor	Description
ConfigImpl()

Method Summary

Modifier and Type	Method	Description
Clock	clock()	Returns the Clock used to measure durations of Timers.
MeterRegistry.Config	commonTags(Iterable<Tag> tags)	Append a list of common tags to apply to all metrics reported to the monitoring system.
MeterRegistry.Config	commonTags(String... tags)	Append a list of common tags to apply to all metrics reported to the monitoring system.
MeterRegistry.Config	meterFilter(MeterFilter filter)	Add a meter filter to the registry.
NamingConvention	namingConvention()	Returns the associated Naming Convention.
MeterRegistry.Config	namingConvention(NamingConvention convention)	Use the provided naming convention, overriding the default for your monitoring system.
MeterRegistry.Config	onMeterAdded(Consumer<Meter> meter)	Register an event listener for each meter added to the registry.
PauseDetector	pauseDetector()	Returns the associated Pause Detector.
MeterRegistry.Config	pauseDetector(PauseDetector detector)	Sets the default pause detector to use for all timers in this registry.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigImpl

public ConfigImpl()

Method Details

commonTags

public MeterRegistry.Config commonTags(Iterable<Tag> tags)

Description copied from interface: MeterRegistry.Config

Append a list of common tags to apply to all metrics reported to the monitoring system.

Specified by:

commonTags in interface MeterRegistry.Config

Parameters:

tags - Tags to add to every metric.

Returns:

This configuration instance.

commonTags

public MeterRegistry.Config commonTags(String... tags)

Description copied from interface: MeterRegistry.Config

Append a list of common tags to apply to all metrics reported to the monitoring system. Must be an even number of arguments representing key/value pairs of tags.

Specified by:

commonTags in interface MeterRegistry.Config

Parameters:

tags - MUST be an even number of arguments representing key/value pairs of tags.

Returns:

This configuration instance.

meterFilter

public MeterRegistry.Config meterFilter(MeterFilter filter)

Description copied from interface: MeterRegistry.Config

Add a meter filter to the registry. Filters are applied in the order in which they are added.

Specified by:

meterFilter in interface MeterRegistry.Config

Parameters:

filter - The filter to add to the registry.

Returns:

This configuration instance.

onMeterAdded

public MeterRegistry.Config onMeterAdded(Consumer<Meter> meter)

Description copied from interface: MeterRegistry.Config

Register an event listener for each meter added to the registry.

Specified by:

onMeterAdded in interface MeterRegistry.Config

Parameters:

meter - The meter that has just been added

Returns:

This configuration instance.

namingConvention

public MeterRegistry.Config namingConvention(NamingConvention convention)

Description copied from interface: MeterRegistry.Config

Use the provided naming convention, overriding the default for your monitoring system.

Specified by:

namingConvention in interface MeterRegistry.Config

Parameters:

convention - The naming convention to use.

Returns:

This configuration instance.

namingConvention

public NamingConvention namingConvention()

Description copied from interface: MeterRegistry.Config

Returns the associated Naming Convention.

Specified by:

namingConvention in interface MeterRegistry.Config

Returns:

The naming convention currently in use on this registry.

clock

public Clock clock()

Description copied from interface: MeterRegistry.Config

Returns the Clock used to measure durations of Timers.

Specified by:

clock in interface MeterRegistry.Config

Returns:

The clock used to measure durations of timers and long task timers (and sometimes influences publishing behavior).

pauseDetector

public MeterRegistry.Config pauseDetector(PauseDetector detector)

Description copied from interface: MeterRegistry.Config

Sets the default pause detector to use for all timers in this registry.

Specified by:

pauseDetector in interface MeterRegistry.Config

Parameters:

detector - The pause detector to use.

Returns:

This configuration instance.

See Also:

• "io.micrometer.core.instrument.histogram.pause.NoPauseDetector"
• "io.micrometer.core.instrument.histogram.pause.ClockDriftPauseDetector"

pauseDetector

public PauseDetector pauseDetector()

Description copied from interface: MeterRegistry.Config

Returns the associated Pause Detector.

Specified by:

pauseDetector in interface MeterRegistry.Config

Returns:

The pause detector that is currently in effect.