org.apache.giraph.metrics

Class SuperstepMetricsRegistry

java.lang.Object

org.apache.giraph.metrics.GiraphMetricsRegistry

org.apache.giraph.metrics.SuperstepMetricsRegistry

public class SuperstepMetricsRegistry
extends GiraphMetricsRegistry

Wrapper around MetricsRegistry for per-superstep metrics.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SuperstepMetricsRegistry(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 SuperstepMetricsRegistry	create(GiraphConfiguration conf, long superstep) Create with Hadoop Configuration and superstep number.
static SuperstepMetricsRegistry	createFake() Create an empty registry
long	getSuperstep() Get superstep stored here
void	printSummary(PrintStream out) Print human readable summary of superstep metrics.
void	setSuperstep(long superstep) Set superstep number used.

Methods inherited from class org.apache.giraph.metrics.GiraphMetricsRegistry

create, createWithOptional, getAll, getBiasedHistogram, getCounter, getExistingGauge, getGauge, getGroupName, getInternalRegistry, getMeter, getMeter, getTimer, getType, getUniformHistogram, makeMetricName, printToStream, setGroupName, setType, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperstepMetricsRegistry

protected SuperstepMetricsRegistry(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

create

public static SuperstepMetricsRegistry create(GiraphConfiguration conf,
                                              long superstep)

Create with Hadoop Configuration and superstep number.

Parameters:

conf - Hadoop Configuration to use.

superstep - number of superstep to use as group for metrics.

Returns:

new metrics registry

createFake

public static SuperstepMetricsRegistry createFake()

Create an empty registry

Returns:

fake metrics registry that returns no op metrics

getSuperstep

public long getSuperstep()

Get superstep stored here

Returns:

long superstep

setSuperstep

public void setSuperstep(long superstep)

Set superstep number used. Internally sets the group for metrics created.

Parameters:

superstep - long number of superstep to use.

printSummary

public void printSummary(PrintStream out)

Print human readable summary of superstep metrics.

Parameters:

out - PrintStream to write to.