org.apache.ratis.metrics

类 MetricRegistries

java.lang.Object

org.apache.ratis.metrics.MetricRegistries

public abstract class MetricRegistries
extends Object

MetricRegistries is collection of MetricRegistry's. MetricsRegistries implementations should do ref-counting of MetricRegistry's via create() and remove() methods.

构造器概要

构造器

构造器和说明
MetricRegistries()

方法概要

限定符和类型	方法和说明
abstract void	addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration, Consumer<RatisMetricRegistry> stopReporter) Add hook to register reporter for the metricRegistry.
abstract void	clear() Removes all the MetricRegisties.
abstract RatisMetricRegistry	create(MetricRegistryInfo info) Create or return MetricRegistry with the given info.
abstract void	enableConsoleReporter(TimeDuration consoleReportRate) Enable console reporter for the metricRegistry.
abstract void	enableJmxReporter() Enable jmx reporter for the metricRegistry.
abstract Optional<RatisMetricRegistry>	get(MetricRegistryInfo info) Returns the MetricRegistry if found.
abstract Collection<RatisMetricRegistry>	getMetricRegistries() Returns MetricRegistry's created.
abstract Set<MetricRegistryInfo>	getMetricRegistryInfos() Returns MetricRegistryInfo's for the MetricRegistry's created.
static MetricRegistries	global() Return the global singleton instance for the MetricRegistries.
abstract boolean	remove(MetricRegistryInfo key) Decrements the ref count of the MetricRegistry, and removes if ref count == 0.
void	removeReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration, Consumer<RatisMetricRegistry> stopReporter) Remove hook of reporter for the metricRegistry.

从类继承的方法 java.lang.Object

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

构造器详细资料

MetricRegistries

public MetricRegistries()

方法详细资料

global

public static MetricRegistries global()

Return the global singleton instance for the MetricRegistries.

返回:

MetricRegistries implementation.

clear

public abstract void clear()

Removes all the MetricRegisties.

create

public abstract RatisMetricRegistry create(MetricRegistryInfo info)

Create or return MetricRegistry with the given info. MetricRegistry will only be created if current reference count is 0. Otherwise ref counted is incremented, and an existing instance will be returned.

参数:

info - the info object for the MetricRegistrytry.

返回:

created or existing MetricRegistry.

remove

public abstract boolean remove(MetricRegistryInfo key)

Decrements the ref count of the MetricRegistry, and removes if ref count == 0.

参数:

key - the info object for the MetricRegistrytry.

返回:

true if metric registry is removed.

get

public abstract Optional<RatisMetricRegistry> get(MetricRegistryInfo info)

Returns the MetricRegistry if found.

参数:

info - the info for the registry.

返回:

a MetricRegistry optional.

getMetricRegistryInfos

public abstract Set<MetricRegistryInfo> getMetricRegistryInfos()

Returns MetricRegistryInfo's for the MetricRegistry's created.

返回:

MetricRegistryInfo's for the MetricRegistry's created.

getMetricRegistries

public abstract Collection<RatisMetricRegistry> getMetricRegistries()

Returns MetricRegistry's created.

返回:

MetricRegistry's created.

addReporterRegistration

public abstract void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
                                             Consumer<RatisMetricRegistry> stopReporter)

Add hook to register reporter for the metricRegistry.

参数:

reporterRegistration - Consumer to create the reporter for the registry.

stopReporter - Consumer to stop the reporter for the registry.

removeReporterRegistration

public void removeReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
                                       Consumer<RatisMetricRegistry> stopReporter)

Remove hook of reporter for the metricRegistry.

参数:

reporterRegistration - Consumer to create the reporter for the registry.

stopReporter - Consumer to stop the reporter for the registry.

enableJmxReporter

public abstract void enableJmxReporter()

Enable jmx reporter for the metricRegistry.

enableConsoleReporter

public abstract void enableConsoleReporter(TimeDuration consoleReportRate)

Enable console reporter for the metricRegistry.

参数:

consoleReportRate - Console report rate.