|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.mapred.Counters
@InterfaceAudience.Public @InterfaceStability.Stable public class Counters
A set of named counters.
Counters
represent global counters, defined either by the
Map-Reduce framework or applications. Each Counter
can be of
any Enum
type.
Counters
are bunched into Counters.Group
s, each comprising of
counters from a particular Enum
class.
Nested Class Summary | |
---|---|
static class |
Counters.Counter
A counter record, comprising its name and value. |
static class |
Counters.Group
Group of counters, comprising of counters from a particular
counter Enum class. |
Constructor Summary | |
---|---|
Counters()
|
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Counters.Counter |
findCounter(Enum key)
Find the counter for the given enum. |
Counters.Counter |
findCounter(String group,
int id,
String name)
Deprecated. |
Counters.Counter |
findCounter(String group,
String name)
Find a counter given the group and the name. |
static Counters |
fromEscapedCompactString(String compactString)
Convert a stringified counter representation into a counter object. |
long |
getCounter(Enum key)
Returns current value of the specified counter, or 0 if the counter does not exist. |
Counters.Group |
getGroup(String groupName)
Returns the named counter group, or an empty group if there is none with the specified name. |
Collection<String> |
getGroupNames()
Returns the names of all counter classes. |
int |
hashCode()
|
void |
incrAllCounters(Counters other)
Increments multiple counters by their amounts in another Counters instance. |
void |
incrCounter(Enum key,
long amount)
Increments the specified counter by the specified amount, creating it if it didn't already exist. |
void |
incrCounter(String group,
String counter,
long amount)
Increments the specified counter by the specified amount, creating it if it didn't already exist. |
Iterator<Counters.Group> |
iterator()
|
void |
log(org.apache.commons.logging.Log log)
Logs the current counter values. |
String |
makeCompactString()
Convert a counters object into a single line that is easy to parse. |
String |
makeEscapedCompactString()
Represent the counter in a textual format that can be converted back to its object form |
void |
readFields(DataInput in)
Read a set of groups. |
int |
size()
Returns the total number of counters, by summing the number of counters in each group. |
static Counters |
sum(Counters a,
Counters b)
Convenience method for computing the sum of two sets of counters. |
String |
toString()
Return textual representation of the counter values. |
void |
write(DataOutput out)
Write the set of groups. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Counters()
Method Detail |
---|
public Collection<String> getGroupNames()
public Iterator<Counters.Group> iterator()
iterator
in interface Iterable<Counters.Group>
public Counters.Group getGroup(String groupName)
public Counters.Counter findCounter(Enum key)
key
- the counter key
public Counters.Counter findCounter(String group, String name)
group
- the name of the groupname
- the internal name of the counter
@Deprecated public Counters.Counter findCounter(String group, int id, String name)
group
- the name of the groupid
- the id of the counter within the group (0 to N-1)name
- the internal name of the counter
public void incrCounter(Enum key, long amount)
key
- identifies a counteramount
- amount by which counter is to be incrementedpublic void incrCounter(String group, String counter, long amount)
group
- the name of the groupcounter
- the internal name of the counteramount
- amount by which counter is to be incrementedpublic long getCounter(Enum key)
public void incrAllCounters(Counters other)
other
- the other Counters instancepublic static Counters sum(Counters a, Counters b)
public int size()
public void write(DataOutput out) throws IOException
write
in interface org.apache.hadoop.io.Writable
IOException
public void readFields(DataInput in) throws IOException
readFields
in interface org.apache.hadoop.io.Writable
IOException
public void log(org.apache.commons.logging.Log log)
log
- The log to use.public String toString()
toString
in class Object
public String makeCompactString()
public String makeEscapedCompactString()
public static Counters fromEscapedCompactString(String compactString) throws ParseException
makeEscapedCompactString()
.
ParseException
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |