org.apache.giraph.metrics

Class GiraphMetricsRegistry

java.lang.Object

org.apache.giraph.metrics.GiraphMetricsRegistry

Direct Known Subclasses:

SuperstepMetricsRegistry

public class GiraphMetricsRegistry
extends Object

A holder for MetricsRegistry together with a JmxReporter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GiraphMetricsRegistry(com.yammer.metrics.core.MetricsRegistry registry, com.yammer.metrics.reporting.JmxReporter reporter, String groupName, String type) Constructor

Method Summary

Modifier and Type	Method and Description
static GiraphMetricsRegistry	create(GiraphConfiguration conf, String groupName, String type) Create registry with Hadoop Configuration and group to use for metrics.
static GiraphMetricsRegistry	createFake() Create no-op empty registry that makes no-op metrics.
static GiraphMetricsRegistry	createWithOptional(String groupName, String type) Create registry with group to use for metrics.
Map<com.yammer.metrics.core.MetricName,com.yammer.metrics.core.Metric>	getAll() Get map of all metrics.
com.yammer.metrics.core.Histogram	getBiasedHistogram(String name) Creates a new biased Histogram and registers it under the given group and name
com.yammer.metrics.core.Counter	getCounter(String name) Creates a new Counter and registers it under the given group and name.
<T> com.yammer.metrics.core.Gauge<T>	getExistingGauge(String name) Get a Gauge that is already present in the MetricsRegistry
<T> com.yammer.metrics.core.Gauge<T>	getGauge(String name, com.yammer.metrics.core.Gauge<T> metric) Given a new Gauge, registers it under the given group and name.
String	getGroupName() Get group name used for metrics.
protected com.yammer.metrics.core.MetricsRegistry	getInternalRegistry() Get internal MetricsRegistry used.
com.yammer.metrics.core.Meter	getMeter(MeterDesc meterDesc) Creates a new Meter and registers it under the given group and name.
com.yammer.metrics.core.Meter	getMeter(String name, String eventType, TimeUnit timeUnit) Creates a new Meter and registers it under the given group and name.
com.yammer.metrics.core.Timer	getTimer(String name, TimeUnit durationUnit, TimeUnit rateUnit) Creates a new Timer and registers it under the given group and name.
String	getType() Get type used for new metrics created
com.yammer.metrics.core.Histogram	getUniformHistogram(String name) Creates a new uniform Histogram and registers it under the given group and name
protected com.yammer.metrics.core.MetricName	makeMetricName(String name) Create a MetricName using the job ID, group, and name.
void	printToStream(PrintStream out) Dump all the metrics to the PrintStream provided.
protected void	setGroupName(String groupName) Set group name used by this MetricsRegistry.
void	setType(String type) Set type to use for new metrics
void	shutdown() Nothing will be captured after this is called.

Methods inherited from class java.lang.Object

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

Constructor Detail

GiraphMetricsRegistry

protected GiraphMetricsRegistry(com.yammer.metrics.core.MetricsRegistry registry,
                                com.yammer.metrics.reporting.JmxReporter reporter,
                                String groupName,
                                String type)

Constructor

Parameters:

registry - MetricsRegistry to use

reporter - JmxReporter to use

groupName - String grouping for metrics

type - String type name for metrics

Method Detail

createFake

public static GiraphMetricsRegistry createFake()

Create no-op empty registry that makes no-op metrics.

Returns:

fake registry that makes no-op metrics

createWithOptional

public static GiraphMetricsRegistry createWithOptional(String groupName,
                                                       String type)

Create registry with group to use for metrics.

Parameters:

groupName - String group to use for metrics.

type - String type to use for metrics.

Returns:

new metrics registry

create

public static GiraphMetricsRegistry create(GiraphConfiguration conf,
                                           String groupName,
                                           String type)

Create registry with Hadoop Configuration and group to use for metrics. Checks the configuration object for whether the optional metrics are enabled, and optionally creates those.

Parameters:

conf - Hadoop Configuration to use.

groupName - String group to use for metrics.

type - String type to use for metrics.

Returns:

new metrics registry

getAll

public Map<com.yammer.metrics.core.MetricName,com.yammer.metrics.core.Metric> getAll()

Get map of all metrics.

Returns:

Map of all metrics held.

getGroupName

public String getGroupName()

Get group name used for metrics.

Returns:

String group name.

setGroupName

protected void setGroupName(String groupName)

Set group name used by this MetricsRegistry. Used for incrementing superstep number to create a new hierarchy of metrics per superstep.

Parameters:

groupName - String group name to use.

getType

public String getType()

Get type used for new metrics created

Returns:

String type to use for metrics

setType

public void setType(String type)

Set type to use for new metrics

Parameters:

type - String type to use

printToStream

public void printToStream(PrintStream out)

Dump all the metrics to the PrintStream provided.

Parameters:

out - PrintStream to write metrics to.

getInternalRegistry

protected com.yammer.metrics.core.MetricsRegistry getInternalRegistry()

Get internal MetricsRegistry used.

Returns:

MetricsRegistry being used.

getCounter

public com.yammer.metrics.core.Counter getCounter(String name)

Creates a new Counter and registers it under the given group and name.

Parameters:

name - the name of the metric

Returns:

a new Counter

getGauge

public <T> com.yammer.metrics.core.Gauge<T> getGauge(String name,
                                                     com.yammer.metrics.core.Gauge<T> metric)

Given a new Gauge, registers it under the given group and name.

Type Parameters:

T - the type of the value returned by the metric

Parameters:

name - the name of the metric

metric - the metric

Returns:

metric

getBiasedHistogram

public com.yammer.metrics.core.Histogram getBiasedHistogram(String name)

Creates a new biased Histogram and registers it under the given group and name

Parameters:

name - name of metric

Returns:

new Histogram

getUniformHistogram

public com.yammer.metrics.core.Histogram getUniformHistogram(String name)

Creates a new uniform Histogram and registers it under the given group and name

Parameters:

name - name of metric

Returns:

new Histogram

getMeter

public com.yammer.metrics.core.Meter getMeter(MeterDesc meterDesc)

Creates a new Meter and registers it under the given group and name.

Parameters:

meterDesc - description of meter

Returns:

new Meter

getMeter

public com.yammer.metrics.core.Meter getMeter(String name,
                                              String eventType,
                                              TimeUnit timeUnit)

Creates a new Meter and registers it under the given group and name.

Parameters:

name - the name of the metric

eventType - the plural name of the type of events the meter is measuring (e.g., "requests")

timeUnit - the rate unit of the new meter

Returns:

a new Meter

getTimer

public com.yammer.metrics.core.Timer getTimer(String name,
                                              TimeUnit durationUnit,
                                              TimeUnit rateUnit)

Creates a new Timer and registers it under the given group and name.

Parameters:

name - the name of the metric

durationUnit - the duration scale unit of the new timer

rateUnit - the rate scale unit of the new timer

Returns:

a new Timer

getExistingGauge

public <T> com.yammer.metrics.core.Gauge<T> getExistingGauge(String name)

Get a Gauge that is already present in the MetricsRegistry

Type Parameters:

T - type of gauge

Parameters:

name - String name of Gauge

Returns:

Gauge, from MetricsRegistry

makeMetricName

protected com.yammer.metrics.core.MetricName makeMetricName(String name)

Create a MetricName using the job ID, group, and name.

Parameters:

name - String name given to metric

Returns:

MetricName for use with MetricsRegistry

shutdown

public void shutdown()

Nothing will be captured after this is called.