io.micrometer.core.instrument.search

Class RequiredSearch

java.lang.Object

io.micrometer.core.instrument.search.RequiredSearch

public final class RequiredSearch
extends java.lang.Object

Search that requires the search terms are satisfiable, or an MeterNotFoundException is thrown.

Method Summary

Modifier and Type	Method and Description
Counter	counter()
FunctionCounter	functionCounter()
FunctionTimer	functionTimer()
Gauge	gauge()
static RequiredSearch	in(MeterRegistry registry) Initiate a new search for meters inside a registry.
LongTaskTimer	longTaskTimer()
Meter	meter()
java.util.Collection<Meter>	meters()
RequiredSearch	name(java.util.function.Predicate<java.lang.String> nameMatches) Meter contains a tag matching the name predicate.
RequiredSearch	name(java.lang.String exactName) Meter contains a tag with the exact name.
DistributionSummary	summary()
RequiredSearch	tag(java.lang.String tagKey, java.lang.String tagValue) Meter contains a tag with the matching key and value.
RequiredSearch	tagKeys(java.lang.String... tagKeys) Meter contains a tag with the matching keys.
RequiredSearch	tags(java.lang.Iterable<Tag> tags) Meter contains a tag with the matching tag keys and values.
RequiredSearch	tags(java.lang.String... tags) Meter contains a tag with the matching tag keys and values.
TimeGauge	timeGauge()
Timer	timer()

Methods inherited from class java.lang.Object

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

Method Detail

name

public RequiredSearch name(java.lang.String exactName)

Meter contains a tag with the exact name.

Parameters:

exactName - Name to match against.

Returns:

This search.

name

public RequiredSearch name(java.util.function.Predicate<java.lang.String> nameMatches)

Meter contains a tag matching the name predicate.

Parameters:

nameMatches - Name matching predicate.

Returns:

This search.

tags

public RequiredSearch tags(java.lang.Iterable<Tag> tags)

Meter contains a tag with the matching tag keys and values.

Parameters:

tags - The tags to match.

Returns:

This search.

tags

public RequiredSearch tags(java.lang.String... tags)

Meter contains a tag with the matching tag keys and values.

Parameters:

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

Returns:

This search.

tag

public RequiredSearch tag(java.lang.String tagKey,
                          java.lang.String tagValue)

Meter contains a tag with the matching key and value.

Parameters:

tagKey - The tag key to match.

tagValue - The tag value to match.

Returns:

This search.

tagKeys

public RequiredSearch tagKeys(java.lang.String... tagKeys)

Meter contains a tag with the matching keys.

Parameters:

tagKeys - The tag keys to match.

Returns:

This search.

timer

public Timer timer()

Returns:

The first matching Timer

Throws:

MeterNotFoundException - if there is no match.

counter

public Counter counter()

Returns:

The first matching Counter.

Throws:

MeterNotFoundException - if there is no match.

gauge

public Gauge gauge()

Returns:

The first matching Gauge.

Throws:

MeterNotFoundException - if there is no match.

functionCounter

public FunctionCounter functionCounter()

Returns:

The first matching FunctionCounter.

Throws:

MeterNotFoundException - if there is no match.

timeGauge

public TimeGauge timeGauge()

Returns:

The first matching TimeGauge.

Throws:

MeterNotFoundException - if there is no match.

functionTimer

public FunctionTimer functionTimer()

Returns:

The first matching FunctionTimer.

Throws:

MeterNotFoundException - if there is no match.

summary

public DistributionSummary summary()

Returns:

The first matching DistributionSummary.

Throws:

MeterNotFoundException - if there is no match.

longTaskTimer

public LongTaskTimer longTaskTimer()

Returns:

The first matching LongTaskTimer.

Throws:

MeterNotFoundException - if there is no match.

meter

public Meter meter()

Returns:

The first matching Meter.

Throws:

MeterNotFoundException - if there is no match.

meters

public java.util.Collection<Meter> meters()

Returns:

All matching meters.

Throws:

MeterNotFoundException - if there is no match.

in

public static RequiredSearch in(MeterRegistry registry)

Initiate a new search for meters inside a registry.

Parameters:

registry - The registry to locate meters in.

Returns:

A new search.