Package org.nuxeo.runtime.metrics

Class MetricsConfigurationDescriptor

java.lang.Object

org.nuxeo.runtime.metrics.MetricsConfigurationDescriptor

All Implemented Interfaces:

io.dropwizard.metrics5.MetricFilter, Descriptor

public class MetricsConfigurationDescriptor
extends Object
implements Descriptor, io.dropwizard.metrics5.MetricFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricsConfigurationDescriptor.FilterDescriptor
static class	MetricsConfigurationDescriptor.InstrumentDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ALL_METRICS
protected List<MetricsConfigurationDescriptor.FilterDescriptor>	filters
protected List<MetricsConfigurationDescriptor.InstrumentDescriptor>	instruments
protected boolean	isEnabled
protected static final MetricsConfigurationDescriptor.FilterDescriptor	NO_FILTER

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Fields inherited from interface io.dropwizard.metrics5.MetricFilter

ALL

Constructor Summary

Constructors

Constructor	Description
MetricsConfigurationDescriptor()

Method Summary

Modifier and Type	Method	Description
static String	expandName(io.dropwizard.metrics5.MetricName metric)
MetricsConfigurationDescriptor.FilterDescriptor	getDefaultFilter()	Returns the legacy or default filter.
Set<io.dropwizard.metrics5.MetricAttribute>	getDeniedExpansions()	Deprecated, for removal: This API element is subject to removal in a future version.
MetricsConfigurationDescriptor.FilterDescriptor	getFilter(String name)	Returns the filter matching the name or null if not found.
String	getId()	The descriptor id, descriptors with same id are merged.
List<MetricsConfigurationDescriptor.InstrumentDescriptor>	getInstruments()
boolean	isEnabled()
boolean	matches(io.dropwizard.metrics5.MetricName name, io.dropwizard.metrics5.Metric metric)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove, merge

Field Details

ALL_METRICS

protected static final String ALL_METRICS

See Also:

• Constant Field Values

NO_FILTER

protected static final MetricsConfigurationDescriptor.FilterDescriptor NO_FILTER

isEnabled

protected boolean isEnabled

instruments

protected List<MetricsConfigurationDescriptor.InstrumentDescriptor> instruments

filters

protected List<MetricsConfigurationDescriptor.FilterDescriptor> filters

Constructor Details

MetricsConfigurationDescriptor

public MetricsConfigurationDescriptor()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

getFilter

public MetricsConfigurationDescriptor.FilterDescriptor getFilter(String name)

Returns the filter matching the name or null if not found.

Since:

2023.8

getDefaultFilter

public MetricsConfigurationDescriptor.FilterDescriptor getDefaultFilter()

Returns the legacy or default filter.

Since:

2023.8

matches

@Deprecated(since="2023.8",
            forRemoval=true)
public boolean matches(io.dropwizard.metrics5.MetricName name,
 io.dropwizard.metrics5.Metric metric)

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

Specified by:

matches in interface io.dropwizard.metrics5.MetricFilter

getDeniedExpansions

@Deprecated(since="2023.8",
            forRemoval=true)
public Set<io.dropwizard.metrics5.MetricAttribute> getDeniedExpansions()

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

expandName

public static String expandName(io.dropwizard.metrics5.MetricName metric)

isEnabled

public boolean isEnabled()

getInstruments

public List<MetricsConfigurationDescriptor.InstrumentDescriptor> getInstruments()