io.micrometer.core.instrument

Interface MeterFilter

public interface MeterFilter

As requests are made of a MeterRegistry to create new metrics, allow for filtering out the metric altogether, transforming its ID (name or tags) in some way, and transforming its configuration. All new metrics should pass through each MeterFilter in the order in which they were added.

Method Summary

Modifier and Type	Method and Description
default MeterFilterReply	accept(Meter.Id id)
static MeterFilter	accept(java.util.function.Predicate<Meter.Id> iff)
static MeterFilter	commonTags(java.lang.Iterable<Tag> tags)
default HistogramConfig	configure(Meter.Id id, HistogramConfig config) This is only called when filtering new timers and distribution summaries (i.e.
static MeterFilter	deny(java.util.function.Predicate<Meter.Id> iff)
static MeterFilter	denyNameStartsWith(java.lang.String prefix)
static MeterFilter	ignoreTags(java.lang.String... tagKeys)
default Meter.Id	map(Meter.Id id)
static MeterFilter	replaceTagValues(java.lang.String tagKey, java.util.function.Function<java.lang.String,java.lang.String> replacement, java.lang.String... exceptions)

Method Detail

accept

default MeterFilterReply accept(Meter.Id id)

Parameters:

id - Id with map(io.micrometer.core.instrument.Meter.Id) transformations applied.

Returns:

After all transformations, should a real meter be registered for this id, or should it be no-op'd.

map

default Meter.Id map(Meter.Id id)

Returns:

Transformations to any part of the id.

configure

default HistogramConfig configure(Meter.Id id,
                                  HistogramConfig config)

This is only called when filtering new timers and distribution summaries (i.e. those meter types that use HistogramConfig).

Parameters:

id - Id with map(io.micrometer.core.instrument.Meter.Id) transformations applied.

config - A histogram configuration guaranteed to be non-null.

Returns:

Overrides to any part of the histogram config, when applicable.

commonTags

static MeterFilter commonTags(java.lang.Iterable<Tag> tags)

ignoreTags

static MeterFilter ignoreTags(java.lang.String... tagKeys)

replaceTagValues

static MeterFilter replaceTagValues(java.lang.String tagKey,
                                    java.util.function.Function<java.lang.String,java.lang.String> replacement,
                                    java.lang.String... exceptions)

Parameters:

tagKey - The tag key for which replacements should be made

replacement - The value to replace with

exceptions - All a matching tag with this value to retain its original value

accept

static MeterFilter accept(java.util.function.Predicate<Meter.Id> iff)

deny

static MeterFilter deny(java.util.function.Predicate<Meter.Id> iff)

denyNameStartsWith

static MeterFilter denyNameStartsWith(java.lang.String prefix)