org.apache.flink.runtime.metrics.dump

Class MetricDumpSerialization.MetricDumpSerializer

java.lang.Object

org.apache.flink.runtime.metrics.dump.MetricDumpSerialization.MetricDumpSerializer

Enclosing class:

MetricDumpSerialization

public static class MetricDumpSerialization.MetricDumpSerializer
extends Object

Serializes a set of metrics into a MetricDumpSerialization.MetricSerializationResult.

Constructor Summary

Constructors

Constructor and Description
MetricDumpSerializer()

Method Summary

Modifier and Type	Method and Description
void	close()
MetricDumpSerialization.MetricSerializationResult	serialize(Map<org.apache.flink.metrics.Counter,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> counters, Map<org.apache.flink.metrics.Gauge<?>,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> gauges, Map<org.apache.flink.metrics.Histogram,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> histograms, Map<org.apache.flink.metrics.Meter,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> meters) Serializes the given metrics and returns the resulting byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricDumpSerializer

public MetricDumpSerializer()

Method Detail

serialize

public MetricDumpSerialization.MetricSerializationResult serialize(Map<org.apache.flink.metrics.Counter,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> counters,
                                                                   Map<org.apache.flink.metrics.Gauge<?>,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> gauges,
                                                                   Map<org.apache.flink.metrics.Histogram,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> histograms,
                                                                   Map<org.apache.flink.metrics.Meter,org.apache.flink.api.java.tuple.Tuple2<QueryScopeInfo,String>> meters)

Serializes the given metrics and returns the resulting byte array.

Should a Metric accessed in this method throw an exception it will be omitted from the returned MetricDumpSerialization.MetricSerializationResult.

If the serialization of any primitive or String fails then the returned MetricDumpSerialization.MetricSerializationResult is partially corrupted. Such a result can be deserialized safely by MetricDumpDeserializer#deserialize(MetricSerializationResult); however only metrics that were fully serialized before the failure will be returned.

Parameters:

counters - counters to serialize

gauges - gauges to serialize

histograms - histograms to serialize

Returns:

MetricSerializationResult containing the serialized metrics and the count of each metric type

close

public void close()