Class GlobalMetricsConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

org.infinispan.configuration.global.GlobalMetricsConfigurationBuilder

All Implemented Interfaces:

Builder<GlobalMetricsConfiguration>, GlobalConfigurationChildBuilder

public class GlobalMetricsConfigurationBuilder
extends AbstractGlobalConfigurationBuilder
implements Builder<GlobalMetricsConfiguration>

Configures the types of metrics gathered and exported via Micrometer metrics for all caches owned by this Cache Manager. Gauges do not have any performance penalty so are enabled by default. Histograms are more expensive to compute so must be enabled manually. Enabling metrics in configuration has no effect unless the necessary Micrometer JAR is available on the classpath.

Method Summary

Modifier and Type	Method	Description
GlobalMetricsConfigurationBuilder	accurateSize(boolean accurateSize)	Enables accurate size computation for numberOfEntries statistics.
AttributeSet	attributes()
GlobalMetricsConfiguration	create()	Create the configuration bean
boolean	enabled()	Metrics are enabled if at least one of the metric types is enabled.
boolean	gauges()	Are gauges enabled?
GlobalMetricsConfigurationBuilder	gauges(boolean gauges)	Enables or disables gauges.
boolean	histograms()	Are histograms enabled?
GlobalMetricsConfigurationBuilder	histograms(boolean histograms)	Enables or disables histograms.
boolean	jvm()	Whether JVM metrics should be reported.
GlobalMetricsConfigurationBuilder	jvm(boolean jvm)	Whether JVM metrics should be reported.
boolean	legacy()	Whether legacy metrics should be reported.
GlobalMetricsConfigurationBuilder	legacy(boolean legacy)	Whether legacy metrics should be reported.
boolean	namesAsTags()	Deprecated, for removal: This API element is subject to removal in a future version.
GlobalMetricsConfigurationBuilder	namesAsTags(boolean namesAsTags)	Deprecated, for removal: This API element is subject to removal in a future version.
String	prefix()	Deprecated, for removal: This API element is subject to removal in a future version.
GlobalMetricsConfigurationBuilder	prefix(String prefix)	Deprecated, for removal: This API element is subject to removal in a future version.
GlobalMetricsConfigurationBuilder	read(GlobalMetricsConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
String	toString()

Methods inherited from class org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

addModule, asyncThreadPool, blockingThreadPool, build, clearModules, defaultCacheName, expirationThreadPool, getGlobalConfig, globalState, jmx, listenerThreadPool, metrics, module, modules, nonBlockingThreadPool, persistenceThreadPool, security, serialization, shutdown, tracing, transport

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset, validate

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<GlobalMetricsConfiguration>

enabled

public boolean enabled()

Metrics are enabled if at least one of the metric types is enabled. See gauges(), histograms().

gauges

public boolean gauges()

Are gauges enabled?

gauges

public GlobalMetricsConfigurationBuilder gauges(boolean gauges)

Enables or disables gauges.

histograms

public boolean histograms()

Are histograms enabled?

histograms

public GlobalMetricsConfigurationBuilder histograms(boolean histograms)

Enables or disables histograms.

prefix

@Deprecated(forRemoval=true,
            since="16.0")
public String prefix()

Deprecated, for removal: This API element is subject to removal in a future version.

The global prefix to add to all metric names.

prefix

@Deprecated(forRemoval=true,
            since="16.0")
public GlobalMetricsConfigurationBuilder prefix(String prefix)

Deprecated, for removal: This API element is subject to removal in a future version.

The global prefix to add to all metric names.

namesAsTags

@Deprecated(forRemoval=true,
            since="16.0")
public boolean namesAsTags()

Deprecated, for removal: This API element is subject to removal in a future version.

Put the cache manager and cache name in tags rather than including them in the metric name.

namesAsTags

@Deprecated(forRemoval=true,
            since="16.0")
public GlobalMetricsConfigurationBuilder namesAsTags(boolean namesAsTags)

Deprecated, for removal: This API element is subject to removal in a future version.

Put the cache manager and cache name in tags rather than including them in the metric name.

accurateSize

public GlobalMetricsConfigurationBuilder accurateSize(boolean accurateSize)

Enables accurate size computation for numberOfEntries statistics. Note that this doesn't affect invocations of the Cache.size() method.

jvm

public boolean jvm()

Whether JVM metrics should be reported.

jvm

public GlobalMetricsConfigurationBuilder jvm(boolean jvm)

Whether JVM metrics should be reported.

legacy

public boolean legacy()

Whether legacy metrics should be reported.

legacy

public GlobalMetricsConfigurationBuilder legacy(boolean legacy)

Whether legacy metrics should be reported.

create

public GlobalMetricsConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<GlobalMetricsConfiguration>

Returns:

read

public GlobalMetricsConfigurationBuilder read(GlobalMetricsConfiguration template,
 Combine combine)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<GlobalMetricsConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

combine - the way attributes and children of this instance and the template should be combined.

toString

public String toString()

Overrides:

toString in class Object