io.micrometer.core.instrument

Class MeterRegistry.Config

java.lang.Object

io.micrometer.core.instrument.MeterRegistry.Config

Enclosing class:

MeterRegistry

public class MeterRegistry.Config
extends Object

Access to configuration options for this registry.

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
Clock	clock()
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()
MeterRegistry.Config	namingConvention(NamingConvention convention) Use the provided naming convention, overriding the default for your monitoring system.
MeterRegistry.Config	onMeterAdded(Consumer<Meter> meterAddedListener) Register an event listener for each meter added to the registry.
MeterRegistry.Config	onMeterRemoved(Consumer<Meter> meterRemovedListener) Register an event listener for each meter removed from the registry.
PauseDetector	pauseDetector()
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 Detail

Config

public Config()

Method Detail

commonTags

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

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

Parameters:

tags - Tags to add to every metric.

Returns:

This configuration instance.

commonTags

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

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.

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)

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

Parameters:

filter - The filter to add to the registry.

Returns:

This configuration instance.

onMeterAdded

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

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

Parameters:

meterAddedListener - a meter-added event listener to be added

Returns:

This configuration instance.

onMeterRemoved

@Incubating(since="1.1.0")
public MeterRegistry.Config onMeterRemoved(Consumer<Meter> meterRemovedListener)

Register an event listener for each meter removed from the registry.

Parameters:

meterRemovedListener - a meter-removed event listener to be added

Returns:

This configuration instance.

Since:

1.1.0

namingConvention

public MeterRegistry.Config namingConvention(NamingConvention convention)

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

Parameters:

convention - The naming convention to use.

Returns:

This configuration instance.

namingConvention

public NamingConvention namingConvention()

Returns:

The naming convention currently in use on this registry.

clock

public Clock clock()

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)

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

Parameters:

detector - The pause detector to use.

Returns:

This configuration instance.

See Also:

NoPauseDetector, ClockDriftPauseDetector

pauseDetector

public PauseDetector pauseDetector()

Returns:

The pause detector that is currently in effect.