Package io.micrometer.core.instrument.search

Class RequiredSearch

java.lang.Object

io.micrometer.core.instrument.search.RequiredSearch

public final class RequiredSearch
extends Object

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

name

public RequiredSearch name(String exactName)

Meter contains a tag with the exact name.

Parameters:

exactName - Name to match against.

Returns:

This search.

name

public RequiredSearch name(Predicate<String> nameMatches)

Meter contains a tag matching the name predicate.

Parameters:

nameMatches - Name matching predicate.

Returns:

This search.

tags

public RequiredSearch tags(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(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(String tagKey,
 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(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 Collection<Meter> meters()

Returns:

All matching meters.

Throws:

MeterNotFoundException - if there is no match.

counters

public Collection<Counter> counters()

Returns:

All matching Counter meters.

gauges

public Collection<Gauge> gauges()

Returns:

All matching Gauge meters.

timers

public Collection<Timer> timers()

Returns:

All matching Timer meters.

summaries

public Collection<DistributionSummary> summaries()

Returns:

All matching DistributionSummary meters.

longTaskTimers

public Collection<LongTaskTimer> longTaskTimers()

Returns:

All matching LongTaskTimer meters.

functionCounters

public Collection<FunctionCounter> functionCounters()

Returns:

All matching FunctionCounter meters.

functionTimers

public Collection<FunctionTimer> functionTimers()

Returns:

All matching FunctionTimer meters.

timeGauges

public Collection<TimeGauge> timeGauges()

Returns:

All matching TimeGauge meters.

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.