public enum MetricManager extends Enum<MetricManager>
MetricRegistry
.Enum Constant and Description |
---|
INSTANCE |
Modifier and Type | Method and Description |
---|---|
void |
addConsoleReporter(Duration reportInterval)
Create a
ConsoleReporter attached to the JanusGraph Metrics registry. |
void |
addCsvReporter(Duration reportInterval,
String output)
Create a
CsvReporter attached to the JanusGraph Metrics registry. |
void |
addGraphiteReporter(String host,
int port,
String prefix,
Duration reportInterval)
Create a
GraphiteReporter attached to the JanusGraph Metrics registry. |
void |
addJmxReporter(String domain,
String agentId)
Create a
JmxReporter attached to the JanusGraph Metrics registry. |
void |
addSlf4jReporter(Duration reportInterval,
String loggerName)
Create a
Slf4jReporter attached to the JanusGraph Metrics registry. |
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 JanusGraph Metrics registry.
|
com.codahale.metrics.Timer |
getTimer(String name) |
com.codahale.metrics.Timer |
getTimer(String prefix,
String... names) |
boolean |
remove(String name) |
void |
removeAllReporters()
Remove all JanusGraph 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 |
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. |
static MetricManager |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static MetricManager[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final MetricManager INSTANCE
public static MetricManager[] values()
for (MetricManager c : MetricManager.values()) System.out.println(c);
public static MetricManager valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic com.codahale.metrics.MetricRegistry getRegistry()
MetricRegistry
used for all of JanusGraph's Metrics
monitoringpublic void addConsoleReporter(Duration reportInterval)
ConsoleReporter
attached to the JanusGraph Metrics registry.reportInterval
- time to wait between dumping metrics to the consolepublic void removeConsoleReporter()
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.public void addCsvReporter(Duration reportInterval, String output)
CsvReporter
attached to the JanusGraph 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 directoryoutput
- the path to a directory into which Metrics will periodically
write CSV datapublic void removeCsvReporter()
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.public void addJmxReporter(String domain, String agentId)
JmxReporter
attached to the JanusGraph 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 agentId)
must return exactly
one MBeanServer
. The reporter will register with that server. If
the findMBeanServer(String 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 metricsagentId
- the JMX agent IDpublic void removeJmxReporter()
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.public void addSlf4jReporter(Duration reportInterval, String loggerName)
Slf4jReporter
attached to the JanusGraph Metrics registry.
If loggerName
is null, or if it is non-null but
LoggerFactory.getLogger(Class loggerName)
returns null, then Metrics's
default Slf4j logger name is used instead.
reportInterval
- time to wait between writing metrics to the Slf4j
loggerloggerName
- the name of the Slf4j logger that receives metricspublic void removeSlf4jReporter()
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.public void addGraphiteReporter(String host, int port, String prefix, Duration reportInterval)
GraphiteReporter
attached to the JanusGraph 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 sentport
- the port to which Graphite reports are sentprefix
- the optional metrics prefixreportInterval
- time to wait between sending metrics to the configured
Graphite host and portpublic void removeGraphiteReporter()
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.public void removeAllReporters()
add*
methods on this class.public com.codahale.metrics.Counter getCounter(String name)
public com.codahale.metrics.Timer getTimer(String name)
public com.codahale.metrics.Histogram getHistogram(String name)
public boolean remove(String name)
Copyright © 2012–2023. All rights reserved.