Package org.infinispan.client.hotrod.metrics.micrometer

Class MicrometerRemoteCacheManagerMetricsRegistry.Builder

java.lang.Object

org.infinispan.client.hotrod.metrics.micrometer.MicrometerRemoteCacheManagerMetricsRegistry.Builder

Enclosing class:

MicrometerRemoteCacheManagerMetricsRegistry

public static class MicrometerRemoteCacheManagerMetricsRegistry.Builder
extends Object

Creates a new MicrometerRemoteCacheManagerMetricsRegistry instance.

Constructor Summary

Constructors

Constructor	Description
Builder(io.micrometer.core.instrument.MeterRegistry registry)

Method Summary

Modifier and Type	Method	Description
MicrometerRemoteCacheManagerMetricsRegistry	build()	Create a new MicrometerRemoteCacheManagerMetricsRegistry with this configuration.
MicrometerRemoteCacheManagerMetricsRegistry.Builder	clearTags()	Removes all Micrometer tags registered by withTag(String, String)
MicrometerRemoteCacheManagerMetricsRegistry.Builder	withHistograms(boolean enabled)	Enables or disables histograms.
MicrometerRemoteCacheManagerMetricsRegistry.Builder	withPrefix(String prefix)	Prefixes all metrics name with prefix.
MicrometerRemoteCacheManagerMetricsRegistry.Builder	withTag(String tagName, String tagValue)	Adds a Micrometer Tag to all metrics.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(io.micrometer.core.instrument.MeterRegistry registry)

Method Details

withPrefix

public MicrometerRemoteCacheManagerMetricsRegistry.Builder withPrefix(String prefix)

Prefixes all metrics name with prefix.

If null, all metrics have the prefix "client.hotrod".

Parameters:

prefix - The prefix to use in all metrics name. Can be null.

Returns:

This instance.

withTag

public MicrometerRemoteCacheManagerMetricsRegistry.Builder withTag(String tagName,
 String tagValue)

Adds a Micrometer Tag to all metrics.

This method can be invoked more than once.

Use the clearTags() to remove all custom tags.

Parameters:

tagName - The tag's name.

tagValue - The tag's value.

Returns:

This instance.

clearTags

public MicrometerRemoteCacheManagerMetricsRegistry.Builder clearTags()

Removes all Micrometer tags registered by withTag(String, String)

Returns:

This instance.

withHistograms

public MicrometerRemoteCacheManagerMetricsRegistry.Builder withHistograms(boolean enabled)

Enables or disables histograms.

When enabled, Micrometer exposes the histogram percentiles.

Collecting and exposing buckets may be expensive and affect the Hot Rod client performance.

Parameters:

enabled - Set to true to enabled buckets to be exposed.

Returns:

This instance.

build

public MicrometerRemoteCacheManagerMetricsRegistry build()

Create a new MicrometerRemoteCacheManagerMetricsRegistry with this configuration.

Returns:

The new MicrometerRemoteCacheManagerMetricsRegistry instance.