org.apache.giraph.metrics

Class GiraphMetrics

java.lang.Object

org.apache.giraph.metrics.GiraphMetrics

public class GiraphMetrics
extends Object

Top level metrics class for using Yammer's metrics in Giraph.

Method Summary

Modifier and Type	Method and Description
void	addSuperstepResetObserver(ResetSuperstepMetricsObserver observer) Anyone using per-superstep counters needs to re-initialize their Metrics object on each new superstep.
void	dumpToStream(PrintStream out) Dump all metrics to output stream provided.
static GiraphMetrics	get() Get singleton instance of GiraphMetrics.
GcTracker	getGcTracker() Get GC tracker
static void	init(GiraphConfiguration conf) Initialize singleton instance of GiraphMetrics.
GiraphMetricsRegistry	perJobOptional() Get per-job optional metrics.
GiraphMetricsRegistry	perJobRequired() Get per-job required metrics.
SuperstepMetricsRegistry	perSuperstep() Get per-superstep metrics.
void	resetSuperstepMetrics(long superstep) Reset the per-superstep MetricsRegistry
void	shutdown() Stop using metrics (for cleanup)

Methods inherited from class java.lang.Object

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

Method Detail

get

public static GiraphMetrics get()

Get singleton instance of GiraphMetrics.

Returns:

GiraphMetrics singleton instance

init

public static void init(GiraphConfiguration conf)

Initialize singleton instance of GiraphMetrics.

Parameters:

conf - GiraphConfiguration to use.

perJobOptional

public GiraphMetricsRegistry perJobOptional()

Get per-job optional metrics.

Returns:

per-job optional GiraphMetricsRegistry

perJobRequired

public GiraphMetricsRegistry perJobRequired()

Get per-job required metrics.

Returns:

per-job require GiraphMetricsRegistry

perSuperstep

public SuperstepMetricsRegistry perSuperstep()

Get per-superstep metrics.

Returns:

per-superstep GiraphMetricsRegistry

getGcTracker

public GcTracker getGcTracker()

Get GC tracker

Returns:

Gc tracker

addSuperstepResetObserver

public void addSuperstepResetObserver(ResetSuperstepMetricsObserver observer)

Anyone using per-superstep counters needs to re-initialize their Metrics object on each new superstep. Otherwise they will always be updating just one counter. This method allows people to easily register a callback for when they should do the re-initializing.

Parameters:

observer - SuperstepObserver to watch

resetSuperstepMetrics

public void resetSuperstepMetrics(long superstep)

Reset the per-superstep MetricsRegistry

Parameters:

superstep - long number of superstep

dumpToStream

public void dumpToStream(PrintStream out)

Dump all metrics to output stream provided.

Parameters:

out - PrintStream to dump to.

shutdown

public void shutdown()

Stop using metrics (for cleanup)