com.baidu.hugegraph.stats

类 MetricsManager

java.lang.Object

com.baidu.hugegraph.stats.MetricsManager

public class MetricsManager
extends Object

Singleton that contains and configures HugeGraph's MetricRegistry.

方法概要

限定符和类型	方法和说明
void	addConsoleReporter(java.time.Duration reportInterval) Create a ConsoleReporter attached to the HugeGraph Metrics registry.
void	addCsvReporter(java.time.Duration reportInterval, String output) Create a CsvReporter attached to the HugeGraph Metrics registry.
void	addGangliaReporter(String groupOrHost, int port, info.ganglia.gmetric4j.gmetric.GMetric.UDPAddressingMode addressingMode, int ttl, Boolean protocol31, UUID hostUUID, String spoof, java.time.Duration reportInterval) Create a GangliaReporter attached to the HugeGraph Metrics registry.
void	addGraphiteReporter(String host, int port, String prefix, java.time.Duration reportInterval) Create a GraphiteReporter attached to the HugeGraph Metrics registry.
void	addJmxReporter(String domain, String agentId) Create a JmxReporter attached to the HugeGraph Metrics registry.
void	addSlf4jReporter(java.time.Duration reportInterval, String loggerName) Create a Slf4jReporter attached to the HugeGraph Metrics registry If loggerName is null, or if it is non-null but LoggerFactory.getLogger(String) returns null, then Metrics's default Slf4j logger name is used instead.
com.codahale.metrics.Counter	getCounter(String name)
com.codahale.metrics.Counter	getCounter(String prefix, String... names)
com.codahale.metrics.Histogram	getHistogram(String name)
com.codahale.metrics.Histogram	getHistogram(String prefix, String... names)
com.codahale.metrics.MetricRegistry	getRegistry() Return the HugeGraph Metrics registry.
com.codahale.metrics.Timer	getTimer(String name)
com.codahale.metrics.Timer	getTimer(String prefix, String... names)
static MetricsManager	instance() Return the Singleton Metrics Manager.
boolean	remove(String name)
void	removeAllReporters() Remove all HugeGraph Metrics reporters previously configured through the add* methods on this class.
void	removeConsoleReporter() Stop a ConsoleReporter previously created by a call to addConsoleReporter(Duration) and release it for GC.
void	removeCsvReporter() Stop a CsvReporter previously created by a call to addCsvReporter(Duration, String) and release it for GC.
void	removeGangliaReporter() Stop a GangliaReporter previously created by a call to addGangliaReporter(java.lang.String, int, info.ganglia.gmetric4j.gmetric.GMetric.UDPAddressingMode, int, java.lang.Boolean, java.util.UUID, java.lang.String, java.time.Duration) and release it for GC.
void	removeGraphiteReporter() Stop a GraphiteReporter previously created by a call to addGraphiteReporter(String, int, String, Duration) and release it for GC.
void	removeJmxReporter() Stop a JmxReporter previously created by a call to addJmxReporter(String, String) and release it for GC.
void	removeSlf4jReporter() Stop a Slf4jReporter previously created by a call to addSlf4jReporter(Duration, String) and release it for GC.

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

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

方法详细资料

instance

public static MetricsManager instance()

Return the Singleton Metrics Manager.

返回:

the single MetricManager

getRegistry

public com.codahale.metrics.MetricRegistry getRegistry()

Return the HugeGraph Metrics registry.

返回:

the single MetricRegistry used for all of HugeGraph's Metrics monitoring

addConsoleReporter

public void addConsoleReporter(java.time.Duration reportInterval)

Create a ConsoleReporter attached to the HugeGraph Metrics registry.

参数:

reportInterval - time to wait between dumping metrics to the console

removeConsoleReporter

public void removeConsoleReporter()

Stop a ConsoleReporter previously created by a call to addConsoleReporter(Duration) and release it for GC. Idempotent between calls to the associated add method. Does nothing before the first call to the associated add method.

addCsvReporter

public void addCsvReporter(java.time.Duration reportInterval,
                           String output)

Create a CsvReporter attached to the HugeGraph Metrics registry.

The output argument must be non-null but need not exist. If it doesn't already exist, this method attempts to create it by calling File.mkdirs().

参数:

reportInterval - time to wait between dumping metrics to CSV files in the configured directory

output - the path to a directory into which Metrics will periodically write CSV data

removeCsvReporter

public void removeCsvReporter()

Stop a CsvReporter previously created by a call to addCsvReporter(Duration, String) and release it for GC. Idempotent between calls to the associated add method. Does nothing before the first call to the associated add method.

addJmxReporter

public void addJmxReporter(String domain,
                           String agentId)

Create a JmxReporter attached to the HugeGraph Metrics registry.

If domain or agentId is null, then Metrics's uses its own internal default value(s).

If agentId is non-null, then MBeanServerFactory.findMBeanServer(String) must return exactly one MBeanServer. The reporter will register with that server. If the findMBeanServer(agentId) call returns no or multiple servers, then this method logs an error and falls back on the Metrics default for agentId.

参数:

domain - the JMX domain in which to continuously expose metrics

agentId - the JMX agent ID

removeJmxReporter

public void removeJmxReporter()

Stop a JmxReporter previously created by a call to addJmxReporter(String, String) and release it for GC. Idempotent between calls to the associated add method. Does nothing before the first call to the associated add method.

addSlf4jReporter

public void addSlf4jReporter(java.time.Duration reportInterval,
                             String loggerName)

Create a Slf4jReporter attached to the HugeGraph Metrics registry

If loggerName is null, or if it is non-null but LoggerFactory.getLogger(String) returns null, then Metrics's default Slf4j logger name is used instead.

参数:

reportInterval - time to wait between writing metrics to the Slf4j logger

loggerName - the name of the Slf4j logger that receives metrics

removeSlf4jReporter

public void removeSlf4jReporter()

Stop a Slf4jReporter previously created by a call to addSlf4jReporter(Duration, String) and release it for GC. Idempotent between calls to the associated add method. Does nothing before the first call to the associated add method.

addGangliaReporter

public void addGangliaReporter(String groupOrHost,
                               int port,
                               info.ganglia.gmetric4j.gmetric.GMetric.UDPAddressingMode addressingMode,
                               int ttl,
                               Boolean protocol31,
                               UUID hostUUID,
                               String spoof,
                               java.time.Duration reportInterval)
                        throws IOException

Create a GangliaReporter attached to the HugeGraph Metrics registry.

groupOrHost and addressingMode must be non-null. The remaining non-primitive arguments may be null. If protocol31 is null, then true is assumed. Null values of hostUUID or spoof are passed into the GMetric constructor, which causes Ganglia to use its internal logic for generating a default UUID and default reporting hostname (respectively).

参数:

groupOrHost - the multicast group or unicast hostname to which Ganglia events are sent

port - the port to which events are sent

addressingMode - whether to send events with multicast or unicast

ttl - multicast ttl (ignored for unicast)

protocol31 - true to use Ganglia protocol version 3.1, false to use 3.0

hostUUID - uuid for the host

spoof - override this machine's IP/hostname as it appears on the Ganglia server

reportInterval - titme to wait before sending data to the ganglia unicast host or multicast group

抛出:

IOException - when a GMetric can't be instantiated using the provided arguments

removeGangliaReporter

public void removeGangliaReporter()

Stop a GangliaReporter previously created by a call to addGangliaReporter(java.lang.String, int, info.ganglia.gmetric4j.gmetric.GMetric.UDPAddressingMode, int, java.lang.Boolean, java.util.UUID, java.lang.String, java.time.Duration) and release it for GC. Idempotent between calls to the associated add method. Does nothing before the first call to the associated add method.

addGraphiteReporter

public void addGraphiteReporter(String host,
                                int port,
                                String prefix,
                                java.time.Duration reportInterval)

Create a GraphiteReporter attached to the HugeGraph Metrics registry.

If prefix is null, then Metrics's internal default prefix is used (empty string at the time this comment was written).

参数:

host - the host to which Graphite reports are sent

port - the port to which Graphite reports are sent

prefix - the optional metrics prefix

reportInterval - time to wait between sending metrics to the configured Graphite host and port

removeGraphiteReporter

public void removeGraphiteReporter()

Stop a GraphiteReporter previously created by a call to addGraphiteReporter(String, int, String, Duration) and release it for GC. Idempotent between calls to the associated add method. Does nothing before the first call to the associated add method.

removeAllReporters

public void removeAllReporters()

Remove all HugeGraph Metrics reporters previously configured through the add* methods on this class.

getCounter

public com.codahale.metrics.Counter getCounter(String name)

getCounter

public com.codahale.metrics.Counter getCounter(String prefix,
                                               String... names)

getTimer

public com.codahale.metrics.Timer getTimer(String name)

getTimer

public com.codahale.metrics.Timer getTimer(String prefix,
                                           String... names)

getHistogram

public com.codahale.metrics.Histogram getHistogram(String name)

getHistogram

public com.codahale.metrics.Histogram getHistogram(String prefix,
                                                   String... names)

remove

public boolean remove(String name)