org.apache.flink.runtime.metrics.groups

Class TaskMetricGroup

java.lang.Object

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

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

org.apache.flink.runtime.metrics.groups.TaskMetricGroup

All Implemented Interfaces:

org.apache.flink.metrics.MetricGroup

Direct Known Subclasses:

UnregisteredMetricGroups.UnregisteredTaskMetricGroup

@Internal
public class TaskMetricGroup
extends ComponentMetricGroup<TaskManagerJobMetricGroup>

Special MetricGroup representing a Flink runtime Task.

Contains extra logic for adding operators.

Nested Class Summary

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

AbstractMetricGroup.ChildType

Field Summary

Fields

Modifier and Type	Field and Description
protected int	subtaskIndex
protected JobVertexID	vertexId

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

LOG, parent, queryServiceScopeInfo, registry, variables

Constructor Summary

Constructors

Constructor and Description
TaskMetricGroup(MetricRegistry registry, TaskManagerJobMetricGroup parent, JobVertexID vertexId, org.apache.flink.util.AbstractID executionId, String taskName, int subtaskIndex, int attemptNumber)

Method Summary

Modifier and Type	Method and Description
int	attemptNumber()
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.
protected QueryScopeInfo.TaskQueryScopeInfo	createQueryServiceMetricInfo(org.apache.flink.metrics.CharacterFilter filter) Creates the metric query service scope for this group.
org.apache.flink.util.AbstractID	executionId()
protected String	getGroupName(org.apache.flink.metrics.CharacterFilter filter) Returns the name for this group, meaning what kind of entity it represents, for example "taskmanager".
TaskIOMetricGroup	getIOMetricGroup() Returns the TaskIOMetricGroup for this task.
OperatorMetricGroup	getOrAddOperator(OperatorID operatorID, String name)
OperatorMetricGroup	getOrAddOperator(String name)
TaskManagerJobMetricGroup	parent()
protected void	putVariables(Map<String,String> variables) Enters all variables specific to this AbstractMetricGroup and their associated values into the map.
protected Iterable<? extends ComponentMetricGroup>	subComponents() Gets all component metric groups that are contained in this component metric group.
int	subtaskIndex()
String	taskName()
org.apache.flink.util.AbstractID	vertexId()

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

addGroup, addGroup, addGroup, addMetric, counter, counter, counter, counter, createChildGroup, createLogicalScope, gauge, gauge, getAllVariables, getAllVariables, 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

Field Detail

vertexId

@Nullable
protected final JobVertexID vertexId

subtaskIndex

protected final int subtaskIndex

Constructor Detail

TaskMetricGroup

public TaskMetricGroup(MetricRegistry registry,
                       TaskManagerJobMetricGroup parent,
                       @Nullable
                       JobVertexID vertexId,
                       org.apache.flink.util.AbstractID executionId,
                       @Nullable
                       String taskName,
                       int subtaskIndex,
                       int attemptNumber)

Method Detail

parent

public final TaskManagerJobMetricGroup parent()

executionId

public org.apache.flink.util.AbstractID executionId()

vertexId

@Nullable
public org.apache.flink.util.AbstractID vertexId()

taskName

@Nullable
public String taskName()

subtaskIndex

public int subtaskIndex()

attemptNumber

public int attemptNumber()

getIOMetricGroup

public TaskIOMetricGroup getIOMetricGroup()

Returns the TaskIOMetricGroup for this task.

Returns:

TaskIOMetricGroup for this task.

createQueryServiceMetricInfo

protected QueryScopeInfo.TaskQueryScopeInfo createQueryServiceMetricInfo(org.apache.flink.metrics.CharacterFilter filter)

Description copied from class: AbstractMetricGroup

Creates the metric query service scope for this group.

Specified by:

createQueryServiceMetricInfo in class AbstractMetricGroup<TaskManagerJobMetricGroup>

Parameters:

filter - character filter

Returns:

query service scope

getOrAddOperator

public OperatorMetricGroup getOrAddOperator(String name)

getOrAddOperator

public OperatorMetricGroup getOrAddOperator(OperatorID operatorID,
                                            String name)

close

public void close()

Description copied from class: ComponentMetricGroup

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 ComponentMetricGroup<TaskManagerJobMetricGroup>

putVariables

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

Description copied from class: AbstractMetricGroup

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

Overrides:

putVariables in class AbstractMetricGroup<TaskManagerJobMetricGroup>

Parameters:

variables - map to enter variables and their values into

subComponents

protected Iterable<? extends ComponentMetricGroup> subComponents()

Description copied from class: ComponentMetricGroup

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

Specified by:

subComponents in class ComponentMetricGroup<TaskManagerJobMetricGroup>

Returns:

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

getGroupName

protected String getGroupName(org.apache.flink.metrics.CharacterFilter filter)

Description copied from class: AbstractMetricGroup

Returns the name for this group, meaning what kind of entity it represents, for example "taskmanager".

Specified by:

getGroupName in class AbstractMetricGroup<TaskManagerJobMetricGroup>

Parameters:

filter - character filter which is applied to the name

Returns:

logical name for this group