Package org.apache.flink.runtime.metrics.dump

Class MetricDump

java.lang.Object

org.apache.flink.runtime.metrics.dump.MetricDump

Direct Known Subclasses:

MetricDump.CounterDump, MetricDump.GaugeDump, MetricDump.HistogramDump, MetricDump.MeterDump

public abstract class MetricDump
extends Object

A container for a dumped metric that contains the scope, name and value(s) of the metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricDump.CounterDump	Container for the value of a Counter.
static class	MetricDump.GaugeDump	Container for the value of a Gauge as a string.
static class	MetricDump.HistogramDump	Container for the values of a Histogram.
static class	MetricDump.MeterDump	Container for the rate of a Meter.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	METRIC_CATEGORY_COUNTER	Categories to be returned by getCategory() to avoid instanceof checks.
static final byte	METRIC_CATEGORY_GAUGE
static final byte	METRIC_CATEGORY_HISTOGRAM
static final byte	METRIC_CATEGORY_METER
final String	name	The name of the stored metric.
final QueryScopeInfo	scopeInfo	The scope information for the stored metric.

Method Summary

Modifier and Type	Method	Description
abstract byte	getCategory()	Returns the category for this MetricDump.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

METRIC_CATEGORY_COUNTER

public static final byte METRIC_CATEGORY_COUNTER

Categories to be returned by getCategory() to avoid instanceof checks.

See Also:

• Constant Field Values

METRIC_CATEGORY_GAUGE

public static final byte METRIC_CATEGORY_GAUGE

See Also:

• Constant Field Values

METRIC_CATEGORY_HISTOGRAM

public static final byte METRIC_CATEGORY_HISTOGRAM

See Also:

• Constant Field Values

METRIC_CATEGORY_METER

public static final byte METRIC_CATEGORY_METER

See Also:

• Constant Field Values

scopeInfo

public final QueryScopeInfo scopeInfo

The scope information for the stored metric.

name

public final String name

The name of the stored metric.

Method Details

getCategory

public abstract byte getCategory()

Returns the category for this MetricDump.

Returns:

category

toString

public String toString()

Overrides:

toString in class Object