Package org.infinispan.configuration.global

Class GlobalMetricsConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.GlobalMetricsConfigurationBuilder

All Implemented Interfaces:

Builder<GlobalMetricsConfiguration>, GlobalConfigurationChildBuilder

public class GlobalMetricsConfigurationBuilder
extends Object
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.
ThreadPoolConfigurationBuilder	asyncThreadPool()	Configuration for the asynchronous operations thread pool
AttributeSet	attributes()
ThreadPoolConfigurationBuilder	blockingThreadPool()	Configuration for the blocking thread pool
GlobalConfiguration	build()	Builds a GlobalConfiguration object using the settings applied to this builder
GlobalMetricsConfiguration	create()	Create the configuration bean
GlobalConfigurationBuilder	defaultCacheName(String defaultCacheName)	Sets the name of the cache that acts as the default cache and is returned by EmbeddedCacheManager.getCache().
boolean	enabled()	Metrics are enabled if at least one of the metric types is enabled.
ThreadPoolConfigurationBuilder	expirationThreadPool()	Configuration for the expiration thread pool
boolean	gauges()	Are gauges enabled?
GlobalMetricsConfigurationBuilder	gauges(boolean gauges)	Enables or disables gauges.
protected GlobalConfigurationBuilder	getGlobalConfig()
GlobalStateConfigurationBuilder	globalState()	Global state configuration
boolean	histograms()	Are histograms enabled?
GlobalMetricsConfigurationBuilder	histograms(boolean histograms)	Enables or disables histograms.
GlobalJmxConfigurationBuilder	jmx()	Global JMX configuration.
ThreadPoolConfigurationBuilder	listenerThreadPool()	Configuration for the listener thread pool
GlobalMetricsConfigurationBuilder	metrics()	Global metrics configuration.
List<Builder<?>>	modules()	Global modules configuration
boolean	namesAsTags()	Put the cache manager and cache name in tags rather then include them in the metric name.
GlobalMetricsConfigurationBuilder	namesAsTags(boolean namesAsTags)	Put the cache manager and cache name in tags rather then include them in the metric name.
ThreadPoolConfigurationBuilder	nonBlockingThreadPool()	Configuration for the non blocking thread pool
ThreadPoolConfigurationBuilder	persistenceThreadPool()	Configuration for the persistence thread pool
String	prefix()	The global prefix to add to all metric names.
GlobalMetricsConfigurationBuilder	prefix(String prefix)	The global prefix to add to all metric names.
GlobalMetricsConfigurationBuilder	read(GlobalMetricsConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
GlobalSecurityConfigurationBuilder	security()	Security-related configuration
SerializationConfigurationBuilder	serialization()	Global serialization (i.e.
ShutdownConfigurationBuilder	shutdown()	Shutdown configuration
SiteConfigurationBuilder	site()	Cross-site replication configuration
ThreadPoolConfigurationBuilder	stateTransferThreadPool()	Configuration for the state-transfer thread pool
String	toString()
TransportConfigurationBuilder	transport()	Transport-related (i.e.

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

Methods inherited from interface org.infinispan.configuration.global.GlobalConfigurationChildBuilder

globalJmxStatistics

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

public String prefix()

The global prefix to add to all metric names.

prefix

public GlobalMetricsConfigurationBuilder prefix(String prefix)

The global prefix to add to all metric names.

namesAsTags

public boolean namesAsTags()

Put the cache manager and cache name in tags rather then include them in the metric name.

namesAsTags

public GlobalMetricsConfigurationBuilder namesAsTags(boolean namesAsTags)

Put the cache manager and cache name in tags rather then include 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.

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

getGlobalConfig

protected GlobalConfigurationBuilder getGlobalConfig()

transport

public TransportConfigurationBuilder transport()

Description copied from interface: GlobalConfigurationChildBuilder

Transport-related (i.e. clustering) configuration

Specified by:

transport in interface GlobalConfigurationChildBuilder

metrics

public GlobalMetricsConfigurationBuilder metrics()

Description copied from interface: GlobalConfigurationChildBuilder

Global metrics configuration.

Specified by:

metrics in interface GlobalConfigurationChildBuilder

jmx

public GlobalJmxConfigurationBuilder jmx()

Description copied from interface: GlobalConfigurationChildBuilder

Global JMX configuration.

Specified by:

jmx in interface GlobalConfigurationChildBuilder

globalState

public GlobalStateConfigurationBuilder globalState()

Description copied from interface: GlobalConfigurationChildBuilder

Global state configuration

Specified by:

globalState in interface GlobalConfigurationChildBuilder

serialization

public SerializationConfigurationBuilder serialization()

Description copied from interface: GlobalConfigurationChildBuilder

Global serialization (i.e. marshalling) configuration

Specified by:

serialization in interface GlobalConfigurationChildBuilder

listenerThreadPool

public ThreadPoolConfigurationBuilder listenerThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the listener thread pool

Specified by:

listenerThreadPool in interface GlobalConfigurationChildBuilder

asyncThreadPool

public ThreadPoolConfigurationBuilder asyncThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the asynchronous operations thread pool

Specified by:

asyncThreadPool in interface GlobalConfigurationChildBuilder

expirationThreadPool

public ThreadPoolConfigurationBuilder expirationThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the expiration thread pool

Specified by:

expirationThreadPool in interface GlobalConfigurationChildBuilder

persistenceThreadPool

public ThreadPoolConfigurationBuilder persistenceThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the persistence thread pool

Specified by:

persistenceThreadPool in interface GlobalConfigurationChildBuilder

stateTransferThreadPool

public ThreadPoolConfigurationBuilder stateTransferThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the state-transfer thread pool

Specified by:

stateTransferThreadPool in interface GlobalConfigurationChildBuilder

blockingThreadPool

public ThreadPoolConfigurationBuilder blockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the blocking thread pool

Specified by:

blockingThreadPool in interface GlobalConfigurationChildBuilder

nonBlockingThreadPool

public ThreadPoolConfigurationBuilder nonBlockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the non blocking thread pool

Specified by:

nonBlockingThreadPool in interface GlobalConfigurationChildBuilder

security

public GlobalSecurityConfigurationBuilder security()

Description copied from interface: GlobalConfigurationChildBuilder

Security-related configuration

Specified by:

security in interface GlobalConfigurationChildBuilder

shutdown

public ShutdownConfigurationBuilder shutdown()

Description copied from interface: GlobalConfigurationChildBuilder

Shutdown configuration

Specified by:

shutdown in interface GlobalConfigurationChildBuilder

site

public SiteConfigurationBuilder site()

Description copied from interface: GlobalConfigurationChildBuilder

Cross-site replication configuration

Specified by:

site in interface GlobalConfigurationChildBuilder

modules

public List<Builder<?>> modules()

Description copied from interface: GlobalConfigurationChildBuilder

Global modules configuration

Specified by:

modules in interface GlobalConfigurationChildBuilder

defaultCacheName

public GlobalConfigurationBuilder defaultCacheName(String defaultCacheName)

Description copied from interface: GlobalConfigurationChildBuilder

Sets the name of the cache that acts as the default cache and is returned by EmbeddedCacheManager.getCache(). Not

Specified by:

defaultCacheName in interface GlobalConfigurationChildBuilder

build

public GlobalConfiguration build()

Description copied from interface: GlobalConfigurationChildBuilder

Builds a GlobalConfiguration object using the settings applied to this builder

Specified by:

build in interface GlobalConfigurationChildBuilder