org.apache.flink.runtime.metrics.groups

Class ComponentMetricGroup<P extends AbstractMetricGroup<?>>

java.lang.Object

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

org.apache.flink.runtime.metrics.groups.ComponentMetricGroup<P>

Type Parameters:

P - The type of the parent MetricGroup.

All Implemented Interfaces:

org.apache.flink.metrics.MetricGroup

Direct Known Subclasses:

JobManagerMetricGroup, JobMetricGroup, OperatorMetricGroup, TaskManagerMetricGroup, TaskMetricGroup

@Internal
public abstract class ComponentMetricGroup<P extends AbstractMetricGroup<?>>
extends AbstractMetricGroup<P>

Abstract MetricGroup for system components (e.g., TaskManager, Job, Task, Operator).

Usually, the scope of metrics is simply the hierarchy of the containing groups. For example the Metric "MyMetric" in group "B" nested in group "A" would have a fully scoped name of "A.B.MyMetric", with "A.B" being the Metric's scope.

Component groups, however, have configurable scopes. This allow users to include or exclude certain identifiers from the scope. The scope for metrics belonging to the "Task" group could for example include the task attempt number (more fine grained identification), or exclude it (for continuity of the namespace across failure and recovery).

Field Summary

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

parent, queryServiceScopeInfo, registry, variables

Constructor Summary

Constructors

Constructor and Description
ComponentMetricGroup(MetricRegistry registry, String[] scope, P parent) Creates a new ComponentMetricGroup.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the component group by removing and closing all metrics and subgroups (inherited from AbstractMetricGroup), plus closing and removing all dedicated component subgroups.
Map<String,String>	getAllVariables()
protected abstract void	putVariables(Map<String,String> variables) Enters all variables specific to this ComponentMetricGroup and their associated values into the map.
protected abstract Iterable<? extends ComponentMetricGroup>	subComponents() Gets all component metric groups that are contained in this component metric group.

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

addGroup, addGroup, addMetric, counter, counter, counter, counter, createQueryServiceMetricInfo, gauge, gauge, getGroupName, getLogicalScope, getLogicalScope, getMetricIdentifier, getMetricIdentifier, getMetricIdentifier, getQueryServiceMetricInfo, getScopeComponents, histogram, histogram, isClosed, meter, meter

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentMetricGroup

public ComponentMetricGroup(MetricRegistry registry,
                    String[] scope,
                    P parent)

Creates a new ComponentMetricGroup.

Parameters:

registry - registry to register new metrics with

scope - the scope of the group

Method Detail

getAllVariables

public Map<String,String> getAllVariables()

Specified by:

getAllVariables in interface org.apache.flink.metrics.MetricGroup

Overrides:

getAllVariables in class AbstractMetricGroup<P extends AbstractMetricGroup<?>>

putVariables

protected abstract void putVariables(Map<String,String> variables)

Enters all variables specific to this ComponentMetricGroup and their associated values into the map.

Parameters:

variables - map to enter variables and their values into

close

public void close()

Closes the component group by removing and closing all metrics and subgroups (inherited from AbstractMetricGroup), plus closing and removing all dedicated component subgroups.

Overrides:

close in class AbstractMetricGroup<P extends AbstractMetricGroup<?>>

subComponents

protected abstract Iterable<? extends ComponentMetricGroup> subComponents()

Gets all component metric groups that are contained in this component metric group.

Returns:

All component metric groups that are contained in this component metric group.