Class GlobalMetricsConfiguration

java.lang.Object

org.infinispan.commons.configuration.attributes.ConfigurationElement<GlobalMetricsConfiguration>

org.infinispan.configuration.global.GlobalMetricsConfiguration

All Implemented Interfaces:

Matchable<GlobalMetricsConfiguration>, Updatable<GlobalMetricsConfiguration>

public class GlobalMetricsConfiguration
extends ConfigurationElement<GlobalMetricsConfiguration>

Configuration for metrics. See GlobalMetricsConfigurationBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeDefinition<Boolean>	ACCURATE_SIZE
static final AttributeDefinition<Boolean>	GAUGES
static final AttributeDefinition<Boolean>	HISTOGRAMS
static final AttributeDefinition<Boolean>	JVM	Deprecated, for removal: This API element is subject to removal in a future version.
static final AttributeDefinition<Boolean>	LEGACY	Deprecated, for removal: This API element is subject to removal in a future version.
static final AttributeDefinition<Boolean>	NAMES_AS_TAGS	Deprecated, for removal: This API element is subject to removal in a future version.
static final AttributeDefinition<String>	PREFIX	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from class ConfigurationElement

attributes, CHILDLESS, children, element, repeated

Method Summary

Modifier and Type	Method	Description
boolean	accurateSize()	Whether cache sizes should be computed
boolean	enabled()	Metrics are enabled if at least one of the metric types is enabled.
boolean	gauges()	Are gauges enabled?
boolean	histograms()	Are histograms enabled?
boolean	jvm()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	legacy()	Whether legacy metrics should be reported.
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.

Methods inherited from class ConfigurationElement

attributes, child, children, children, collectMutableAttributes, elementName, equals, extractAttributes, findAttribute, hashCode, isModified, list, matches, matches, matches, toString, update, update, update, validateUpdate, validateUpdate, validateUpdate, write

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

GAUGES

public static final AttributeDefinition<Boolean> GAUGES

HISTOGRAMS

public static final AttributeDefinition<Boolean> HISTOGRAMS

PREFIX

@Deprecated(forRemoval=true,
            since="16.0")
public static final AttributeDefinition<String> PREFIX

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

NAMES_AS_TAGS

@Deprecated(forRemoval=true,
            since="16.0")
public static final AttributeDefinition<Boolean> NAMES_AS_TAGS

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

ACCURATE_SIZE

public static final AttributeDefinition<Boolean> ACCURATE_SIZE

JVM

@Deprecated(forRemoval=true,
            since="16.0")
public static final AttributeDefinition<Boolean> JVM

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

LEGACY

@Deprecated(forRemoval=true,
            since="16.0")
public static final AttributeDefinition<Boolean> LEGACY

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

Method Details

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?

histograms

public boolean histograms()

Are histograms enabled?

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.

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 then include them in the metric name.

accurateSize

public boolean accurateSize()

Whether cache sizes should be computed

Returns:

true if accurate cache sizes should be computed, false otherwise

jvm

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

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

Whether JVM metrics should be reported.

legacy

public boolean legacy()

Whether legacy metrics should be reported.

Returns:

true if legacy metrics should be reported, false otherwise