Package com.hazelcast.jet.core.metrics

Class JobMetrics

java.lang.Object

com.hazelcast.jet.core.metrics.JobMetrics

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, Iterable<Map.Entry<String,List<Measurement>>>

public final class JobMetrics
extends Object
implements Iterable<Map.Entry<String,List<Measurement>>>, IdentifiedDataSerializable

An immutable collection of job-specific metrics, pairs of metric names and sets of associated Measurements.

Since:

Jet 3.2

Method Summary

Modifier and Type	Method	Description
boolean	containsTag(String tagName)	Returns true if there is any Measurement that has the specified tag.
static JobMetrics	empty()	Returns an empty JobMetrics object.
boolean	equals(Object obj)
JobMetrics	filter(String tagName, String tagValue)	Convenience method for filter(Predicate), returns a new JobMetrics instance containing only those Measurements which have the specified tag set to the specified value.
JobMetrics	filter(Predicate<Measurement> predicate)	Returns a new JobMetrics instance containing a subset of the Measurements found in the current one.
List<Measurement>	get(String metricName)	Returns all Measurements associated with a given metric name.
int	getClassId()	Returns type identifier for this class.
int	getFactoryId()	Returns DataSerializableFactory factory ID for this class.
int	hashCode()
Iterator<Map.Entry<String,List<Measurement>>>	iterator()	Returns an iterator over the metrics.
Set<String>	metrics()	Returns all metrics present.
static JobMetrics	of(Map<String,List<Measurement>> metrics)	Builds a JobMetrics object based on a map of Measurements.
void	readData(ObjectDataInput in)	Reads fields from the input stream
String	toString()
void	writeData(ObjectDataOutput out)	Writes object fields to output stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

empty

@Nonnull
@PrivateApi
public static JobMetrics empty()

Returns an empty JobMetrics object.

of

@Nonnull
@PrivateApi
public static JobMetrics of(@Nonnull
 Map<String,List<Measurement>> metrics)

Builds a JobMetrics object based on a map of Measurements.

metrics

@Nonnull
public Set<String> metrics()

Returns all metrics present.

get

@Nonnull
public List<Measurement> get(@Nonnull
 String metricName)

Returns all Measurements associated with a given metric name.

For a list of job-specific metric names please see MetricNames.

iterator

@Nonnull
public Iterator<Map.Entry<String,List<Measurement>>> iterator()

Returns an iterator over the metrics.

The returned iterator does not support remove() operation.

Specified by:

iterator in interface Iterable<Map.Entry<String,List<Measurement>>>

Since:

5.5

filter

@Nonnull
public JobMetrics filter(@Nonnull
 String tagName,
 @Nonnull
 String tagValue)

Convenience method for filter(Predicate), returns a new JobMetrics instance containing only those Measurements which have the specified tag set to the specified value.

For a list of available tag names, see MetricTags.

containsTag

public boolean containsTag(@Nonnull
 String tagName)

Returns true if there is any Measurement that has the specified tag.

Since:

5.4

filter

@Nonnull
public JobMetrics filter(@Nonnull
 Predicate<Measurement> predicate)

Returns a new JobMetrics instance containing a subset of the Measurements found in the current one. The subset is formed by those Measurements which match the provided Predicate.

The metric names which have all their Measurements filtered out won't be present in the new JobMetrics instance.

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getClassId in interface IdentifiedDataSerializable

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object