org.apache.flink.runtime.metrics.groups

Class TaskManagerMetricGroup

java.lang.Object

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

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

org.apache.flink.runtime.metrics.groups.TaskManagerMetricGroup

All Implemented Interfaces:

MetricGroup

Direct Known Subclasses:

UnregisteredMetricGroups.UnregisteredTaskManagerMetricGroup

@Internal
public class TaskManagerMetricGroup
extends ComponentMetricGroup<TaskManagerMetricGroup>

Special MetricGroup representing a TaskManager.

Contains extra logic for adding jobs with tasks, and removing jobs when they do not contain tasks any more

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 and Description
TaskManagerJobMetricGroup	addJob(JobID jobId, String jobName)
protected QueryScopeInfo.TaskManagerQueryScopeInfo	createQueryServiceMetricInfo(CharacterFilter filter) Creates the metric query service scope for this group.
static TaskManagerMetricGroup	createTaskManagerMetricGroup(MetricRegistry metricRegistry, String hostName, ResourceID resourceID)
protected String	getGroupName(CharacterFilter filter) Returns the name for this group, meaning what kind of entity it represents, for example "taskmanager".
TaskManagerJobMetricGroup	getJobMetricsGroup(JobID jobId)
String	hostname()
int	numRegisteredJobMetricGroups()
protected void	putVariables(Map<String,String> variables) Enters all variables specific to this AbstractMetricGroup and their associated values into the map.
void	removeJobMetricsGroup(JobID jobId)
protected Iterable<? extends ComponentMetricGroup>	subComponents() Gets all component metric groups that are contained in this component metric group.
String	taskManagerId()

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

close

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

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

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

createTaskManagerMetricGroup

public static TaskManagerMetricGroup createTaskManagerMetricGroup(MetricRegistry metricRegistry,
                                                                  String hostName,
                                                                  ResourceID resourceID)

hostname

public String hostname()

taskManagerId

public String taskManagerId()

createQueryServiceMetricInfo

protected QueryScopeInfo.TaskManagerQueryScopeInfo createQueryServiceMetricInfo(CharacterFilter filter)

Description copied from class: AbstractMetricGroup

Creates the metric query service scope for this group.

Specified by:

createQueryServiceMetricInfo in class AbstractMetricGroup<TaskManagerMetricGroup>

Parameters:

filter - character filter

Returns:

query service scope

addJob

public TaskManagerJobMetricGroup addJob(JobID jobId,
                                        String jobName)

getJobMetricsGroup

@VisibleForTesting
public TaskManagerJobMetricGroup getJobMetricsGroup(JobID jobId)

removeJobMetricsGroup

public void removeJobMetricsGroup(JobID jobId)

numRegisteredJobMetricGroups

public int numRegisteredJobMetricGroups()

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<TaskManagerMetricGroup>

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<TaskManagerMetricGroup>

Returns:

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

getGroupName

protected String getGroupName(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<TaskManagerMetricGroup>

Parameters:

filter - character filter which is applied to the name

Returns:

logical name for this group