Package org.apache.flink.runtime.metrics.groups

Class GenericKeyMetricGroup

java.lang.Object

org.apache.flink.runtime.metrics.groups.AbstractMetricGroup<AbstractMetricGroup<?>>

org.apache.flink.runtime.metrics.groups.GenericMetricGroup

org.apache.flink.runtime.metrics.groups.GenericKeyMetricGroup

All Implemented Interfaces:

MetricGroup

@Internal
public class GenericKeyMetricGroup
extends GenericMetricGroup

A GenericMetricGroup for representing the key part of a key-value metric group pair.

See Also:

GenericValueMetricGroup, MetricGroup.addGroup(String, String)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.metrics.groups.AbstractMetricGroup

AbstractMetricGroup.ChildType

Field Summary

Fields inherited from class org.apache.flink.runtime.metrics.groups.AbstractMetricGroup

LOG, parent, queryServiceScopeInfo, registry, variables

Method Summary

Modifier and Type	Method	Description
MetricGroup	addGroup(String key, String value)	Creates a new key-value MetricGroup pair.
protected GenericMetricGroup	createChildGroup(String name, AbstractMetricGroup.ChildType childType)

Methods inherited from class org.apache.flink.runtime.metrics.groups.GenericMetricGroup

createQueryServiceMetricInfo, getGroupName

Methods inherited from class org.apache.flink.runtime.metrics.groups.AbstractMetricGroup

addGroup, addMetric, addSpan, close, counter, counter, createLogicalScope, gauge, getAllVariables, getAllVariables, getLogicalScope, getLogicalScope, getMetricIdentifier, getMetricIdentifier, getMetricIdentifier, getQueryServiceMetricInfo, getScopeComponents, histogram, isClosed, meter, putVariables

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.metrics.MetricGroup

addGroup, counter, counter, gauge, histogram, meter

Method Detail

addGroup

public MetricGroup addGroup(String key,
                            String value)

Description copied from interface: MetricGroup

Creates a new key-value MetricGroup pair. The key group is added to this groups sub-groups, while the value group is added to the key group's sub-groups. This method returns the value group.

The only difference between calling this method and group.addGroup(key).addGroup(value) is that MetricGroup.getAllVariables() of the value group return an additional "<key>"="value" pair.

Specified by:

addGroup in interface MetricGroup

Overrides:

addGroup in class AbstractMetricGroup<AbstractMetricGroup<?>>

Parameters:

key - name of the first group

value - name of the second group

Returns:

the second created group

createChildGroup

protected GenericMetricGroup createChildGroup(String name,
                                              AbstractMetricGroup.ChildType childType)

Overrides:

createChildGroup in class AbstractMetricGroup<AbstractMetricGroup<?>>