org.apache.flink.runtime.metrics.groups

Class JobMetricGroup<C extends ComponentMetricGroup<C>>

java.lang.Object

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

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

org.apache.flink.runtime.metrics.groups.JobMetricGroup<C>

Type Parameters:

C - The type of the parent ComponentMetricGroup.

All Implemented Interfaces:

org.apache.flink.metrics.MetricGroup

Direct Known Subclasses:

JobManagerJobMetricGroup, TaskManagerJobMetricGroup

@Internal
public abstract class JobMetricGroup<C extends ComponentMetricGroup<C>>
extends ComponentMetricGroup<C>

Special abstract MetricGroup representing everything belonging to a specific job.

Field Summary

Fields

Modifier and Type	Field and Description
protected JobID	jobId The ID of the job represented by this metrics group
protected String	jobName The name of the job represented by this metrics group

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

parent, queryServiceScopeInfo, registry, variables

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JobMetricGroup(MetricRegistry registry, C parent, JobID jobId, String jobName, String[] scope)

Method Summary

Methods

Modifier and Type	Method and Description
protected QueryScopeInfo.JobQueryScopeInfo	createQueryServiceMetricInfo(org.apache.flink.metrics.CharacterFilter filter) Creates the metric query service scope for this group.
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".
JobID	jobId()
String	jobName()
protected void	putVariables(Map<String,String> variables) Enters all variables specific to this ComponentMetricGroup and their associated values into the map.

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

close, getAllVariables, subComponents

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

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

jobId

protected final JobID jobId

The ID of the job represented by this metrics group

jobName

@Nullable
protected final String jobName

The name of the job represented by this metrics group

Constructor Detail

JobMetricGroup

protected JobMetricGroup(MetricRegistry registry,
              C parent,
              JobID jobId,
              @Nullable
              String jobName,
              String[] scope)

Method Detail

jobId

public JobID jobId()

jobName

@Nullable
public String jobName()

createQueryServiceMetricInfo

protected QueryScopeInfo.JobQueryScopeInfo 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<C extends ComponentMetricGroup<C>>

Parameters:

filter - character filter

Returns:

query service scope

putVariables

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

Description copied from class: ComponentMetricGroup

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

Specified by:

putVariables in class ComponentMetricGroup<C extends ComponentMetricGroup<C>>

Parameters:

variables - map to enter variables and their values into

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<C extends ComponentMetricGroup<C>>

Parameters:

filter - character filter which is applied to the name

Returns:

logical name for this group