org.apache.tez.common.counters

Interface TezCounter

All Superinterfaces:

org.apache.hadoop.io.Writable

All Known Implementing Classes:

AbstractCounter, FileSystemCounterGroup.FSCounter, FrameworkCounterGroup.FrameworkCounter, GenericCounter

@InterfaceAudience.Public
@InterfaceStability.Unstable
public interface TezCounter
extends org.apache.hadoop.io.Writable

A named counter that tracks the progress of a job.

Counters represent global counters, defined either by the framework or applications. Each Counter is named by an Enum and has a long for the value.

Counters are bunched into Groups, each comprising of counters from a particular Enum class.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() Get the display name of the counter.
String	getName()
TezCounter	getUnderlyingCounter() Return the underlying object if this is a facade.
long	getValue() What is the current value of this counter?
void	increment(long incr) Increment this counter by the given value
void	setDisplayName(String displayName) Deprecated. (and no-op by default)
void	setValue(long value) Set this counter by the given value

Methods inherited from interface org.apache.hadoop.io.Writable

readFields, write

Method Detail

setDisplayName

@Deprecated
void setDisplayName(String displayName)

Deprecated. (and no-op by default)

Set the display name of the counter

Parameters:

displayName - of the counter

getName

String getName()

Returns:

the name of the counter

getDisplayName

String getDisplayName()

Get the display name of the counter.

Returns:

the user facing name of the counter

getValue

long getValue()

What is the current value of this counter?

Returns:

the current value

setValue

void setValue(long value)

Set this counter by the given value

Parameters:

value - the value to set

increment

void increment(long incr)

Increment this counter by the given value

Parameters:

incr - the value to increase this counter by

getUnderlyingCounter

@InterfaceAudience.Private
TezCounter getUnderlyingCounter()

Return the underlying object if this is a facade.

Returns:

the undelying object.