AbstractMetricGroup (Flink : Runtime 1.16.0 API)

java.lang.Object
- org.apache.flink.runtime.metrics.groups.AbstractMetricGroup<A>

类型参数:

A - The type of the parent MetricGroup

所有已实现的接口:

org.apache.flink.metrics.MetricGroup

直接已知子类:

ComponentMetricGroup, GenericMetricGroup, ProcessMetricGroup, ResourceManagerMetricGroup, SlotManagerMetricGroup
```
@Internal
public abstract class AbstractMetricGroup<A extends AbstractMetricGroup<?>>
extends Object
implements org.apache.flink.metrics.MetricGroup
```
Abstract MetricGroup that contains key functionality for adding metrics and groups.
IMPORTANT IMPLEMENTATION NOTE
This class uses locks for adding and removing metrics objects. This is done to prevent resource leaks in the presence of concurrently closing a group and adding metrics and subgroups. Since closing groups recursively closes the subgroups, the lock acquisition order must be strictly from parent group to subgroup. If at any point, a subgroup holds its group lock and calls a parent method that also acquires the lock, it will create a deadlock condition.
An AbstractMetricGroup can be closed. Upon closing, the group de-register all metrics from any metrics reporter and any internal maps. Note that even closed metrics groups return Counters, Gauges, etc to the code, to prevent exceptions in the monitored code. These metrics simply do not get reported any more, when created on a closed group.

嵌套类概要

嵌套类
限定符和类型类和说明

protected static class AbstractMetricGroup.ChildType
Enum for indicating which child group should be created.

嵌套类
限定符和类型	类和说明
`protected static class`	`AbstractMetricGroup.ChildType` Enum for indicating which child group should be created.

字段概要

字段
限定符和类型	字段和说明
`protected static org.slf4j.Logger`	`LOG`
`protected A`	`parent` The parent group containing this group.
`protected QueryScopeInfo`	`queryServiceScopeInfo` The metrics query service scope represented by this group, lazily computed.
`protected MetricRegistry`	`registry` The registry that this metrics group belongs to.
`protected Map<String,String>[]`	`variables` The map containing all variables and their associated values, lazily computed.

构造器概要

构造器
构造器和说明

AbstractMetricGroup(MetricRegistry registry, String[] scope, A parent)

构造器
构造器和说明
`AbstractMetricGroup(MetricRegistry registry, String[] scope, A parent)`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`org.apache.flink.metrics.MetricGroup`	`addGroup(String name)`
`org.apache.flink.metrics.MetricGroup`	`addGroup(String key, String value)`
`protected void`	`addMetric(String name, org.apache.flink.metrics.Metric metric)` Adds the given metric to the group and registers it at the registry, if the group is not yet closed, and if no metric with the same name has been registered before.
`void`	`close()`
`org.apache.flink.metrics.Counter`	`counter(String name)`
`<C extends org.apache.flink.metrics.Counter> C`	`counter(String name, C counter)`
`protected GenericMetricGroup`	`createChildGroup(String name, AbstractMetricGroup.ChildType childType)`
`protected String`	`createLogicalScope(org.apache.flink.metrics.CharacterFilter filter, char delimiter)`
`protected abstract QueryScopeInfo`	`createQueryServiceMetricInfo(org.apache.flink.metrics.CharacterFilter filter)` Creates the metric query service scope for this group.
`<T,G extends org.apache.flink.metrics.Gauge<T>> G`	`gauge(String name, G gauge)`
`Map<String,String>`	`getAllVariables()`
`Map<String,String>`	`getAllVariables(int reporterIndex, Set<String> excludedVariables)`
`protected abstract String`	`getGroupName(org.apache.flink.metrics.CharacterFilter filter)` Returns the name for this group, meaning what kind of entity it represents, for example "taskmanager".
`String`	`getLogicalScope(org.apache.flink.metrics.CharacterFilter filter)` Returns the logical scope of this group, for example `"taskmanager.job.task"`.
`String`	`getLogicalScope(org.apache.flink.metrics.CharacterFilter filter, char delimiter)` Returns the logical scope of this group, for example `"taskmanager.job.task"`.
`String`	`getMetricIdentifier(String metricName)` Returns the fully qualified metric name, for example `"host-7.taskmanager-2.window_word_count.my-mapper.metricName"`.
`String`	`getMetricIdentifier(String metricName, org.apache.flink.metrics.CharacterFilter filter)` Returns the fully qualified metric name, for example `"host-7.taskmanager-2.window_word_count.my-mapper.metricName"`.
`String`	`getMetricIdentifier(String metricName, org.apache.flink.metrics.CharacterFilter filter, int reporterIndex, char delimiter)` Returns the fully qualified metric name using the configured delimiter for the reporter with the given index, for example `"host-7.taskmanager-2.window_word_count.my-mapper.metricName"`.
`QueryScopeInfo`	`getQueryServiceMetricInfo(org.apache.flink.metrics.CharacterFilter filter)` Returns the metric query service scope for this group.
`String[]`	`getScopeComponents()` Gets the scope as an array of the scope components, for example `["host-7", "taskmanager-2", "window_word_count", "my-mapper"]`.
`<H extends org.apache.flink.metrics.Histogram> H`	`histogram(String name, H histogram)`
`boolean`	`isClosed()`
`<M extends org.apache.flink.metrics.Meter> M`	`meter(String name, M meter)`
`protected void`	`putVariables(Map<String,String> variables)` Enters all variables specific to this `AbstractMetricGroup` and their associated values into the map.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.apache.flink.metrics.MetricGroup
addGroup, counter, counter, gauge, histogram, meter

- 字段详细资料
  - LOG
```
protected static final org.slf4j.Logger LOG
```
  - parent
```
protected final A extends AbstractMetricGroup<?> parent
```
    The parent group containing this group.
  - variables
```
protected volatile Map<String,String>[] variables
```
    The map containing all variables and their associated values, lazily computed.
  - registry
```
protected final MetricRegistry registry
```
    The registry that this metrics group belongs to.
  - queryServiceScopeInfo
```
protected QueryScopeInfo queryServiceScopeInfo
```
    The metrics query service scope represented by this group, lazily computed.
- 构造器详细资料
  - AbstractMetricGroup
```
public AbstractMetricGroup(MetricRegistry registry,
                           String[] scope,
                           A parent)
```
- 方法详细资料
  - getAllVariables
```
public Map<String,String> getAllVariables()
```
    指定者:
    
    getAllVariables 在接口中 org.apache.flink.metrics.MetricGroup
  - getAllVariables
```
public Map<String,String> getAllVariables(int reporterIndex,
                                          Set<String> excludedVariables)
```
  - putVariables
```
protected void putVariables(Map<String,String> variables)
```
    Enters all variables specific to this AbstractMetricGroup and their associated values into the map.
    
    参数:
    
    variables - map to enter variables and their values into
  - getLogicalScope
```
public String getLogicalScope(org.apache.flink.metrics.CharacterFilter filter)
```
    Returns the logical scope of this group, for example "taskmanager.job.task".
    
    参数:
    
    filter - character filter which is applied to the scope components
    
    返回:
    
    logical scope
  - getLogicalScope
```
public String getLogicalScope(org.apache.flink.metrics.CharacterFilter filter,
                              char delimiter)
```
    Returns the logical scope of this group, for example "taskmanager.job.task".
    
    参数:
    
    filter - character filter which is applied to the scope components
    
    返回:
    
    logical scope
  - createLogicalScope
```
protected String createLogicalScope(org.apache.flink.metrics.CharacterFilter filter,
                                    char delimiter)
```
  - getGroupName
```
protected abstract String getGroupName(org.apache.flink.metrics.CharacterFilter filter)
```
    Returns the name for this group, meaning what kind of entity it represents, for example "taskmanager".
    
    参数:
    
    filter - character filter which is applied to the name
    
    返回:
    
    logical name for this group
  - getScopeComponents
```
public String[] getScopeComponents()
```
    Gets the scope as an array of the scope components, for example ["host-7", "taskmanager-2", "window_word_count", "my-mapper"].
    
    指定者:
    
    getScopeComponents 在接口中 org.apache.flink.metrics.MetricGroup
    
    另请参阅:
    
    getMetricIdentifier(String)
  - getQueryServiceMetricInfo
```
public QueryScopeInfo getQueryServiceMetricInfo(org.apache.flink.metrics.CharacterFilter filter)
```
    Returns the metric query service scope for this group.
    
    参数:
    
    filter - character filter
    
    返回:
    
    query service scope
  - createQueryServiceMetricInfo
```
protected abstract QueryScopeInfo createQueryServiceMetricInfo(org.apache.flink.metrics.CharacterFilter filter)
```
    Creates the metric query service scope for this group.
    
    参数:
    
    filter - character filter
    
    返回:
    
    query service scope
  - getMetricIdentifier
```
public String getMetricIdentifier(String metricName)
```
    Returns the fully qualified metric name, for example "host-7.taskmanager-2.window_word_count.my-mapper.metricName".
    
    指定者:
    
    getMetricIdentifier 在接口中 org.apache.flink.metrics.MetricGroup
    
    参数:
    
    metricName - metric name
    
    返回:
    
    fully qualified metric name
  - getMetricIdentifier
```
public String getMetricIdentifier(String metricName,
                                  org.apache.flink.metrics.CharacterFilter filter)
```
    Returns the fully qualified metric name, for example "host-7.taskmanager-2.window_word_count.my-mapper.metricName".
    
    指定者:
    
    getMetricIdentifier 在接口中 org.apache.flink.metrics.MetricGroup
    
    参数:
    
    metricName - metric name
    
    filter - character filter which is applied to the scope components if not null.
    
    返回:
    
    fully qualified metric name
  - getMetricIdentifier
```
public String getMetricIdentifier(String metricName,
                                  org.apache.flink.metrics.CharacterFilter filter,
                                  int reporterIndex,
                                  char delimiter)
```
    Returns the fully qualified metric name using the configured delimiter for the reporter with the given index, for example "host-7.taskmanager-2.window_word_count.my-mapper.metricName".
    
    参数:
    
    metricName - metric name
    
    filter - character filter which is applied to the scope components if not null.
    
    reporterIndex - index of the reporter whose delimiter should be used
    
    delimiter - delimiter to use
    
    返回:
    
    fully qualified metric name
  - close
```
public void close()
```
  - isClosed
```
public final boolean isClosed()
```
  - counter
```
public org.apache.flink.metrics.Counter counter(String name)
```
    指定者:
    
    counter 在接口中 org.apache.flink.metrics.MetricGroup
  - counter
```
public <C extends org.apache.flink.metrics.Counter> C counter(String name,
                                                              C counter)
```
    指定者:
    
    counter 在接口中 org.apache.flink.metrics.MetricGroup
  - gauge
```
public <T,G extends org.apache.flink.metrics.Gauge<T>> G gauge(String name,
                                                               G gauge)
```
    指定者:
    
    gauge 在接口中 org.apache.flink.metrics.MetricGroup
  - histogram
```
public <H extends org.apache.flink.metrics.Histogram> H histogram(String name,
                                                                  H histogram)
```
    指定者:
    
    histogram 在接口中 org.apache.flink.metrics.MetricGroup
  - meter
```
public <M extends org.apache.flink.metrics.Meter> M meter(String name,
                                                          M meter)
```
    指定者:
    
    meter 在接口中 org.apache.flink.metrics.MetricGroup
  - addMetric
```
protected void addMetric(String name,
                         org.apache.flink.metrics.Metric metric)
```
    Adds the given metric to the group and registers it at the registry, if the group is not yet closed, and if no metric with the same name has been registered before.
    
    参数:
    
    name - the name to register the metric under
    
    metric - the metric to register
  - addGroup
```
public org.apache.flink.metrics.MetricGroup addGroup(String name)
```
    指定者:
    
    addGroup 在接口中 org.apache.flink.metrics.MetricGroup
  - addGroup
```
public org.apache.flink.metrics.MetricGroup addGroup(String key,
                                                     String value)
```
    指定者:
    
    addGroup 在接口中 org.apache.flink.metrics.MetricGroup
  - createChildGroup
```
protected GenericMetricGroup createChildGroup(String name,
                                              AbstractMetricGroup.ChildType childType)
```

类 AbstractMetricGroup<A extends AbstractMetricGroup<?>>

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.flink.metrics.MetricGroup

字段详细资料

LOG

parent

variables

registry

queryServiceScopeInfo

构造器详细资料

AbstractMetricGroup

方法详细资料

getAllVariables

getAllVariables

putVariables

getLogicalScope

getLogicalScope

createLogicalScope

getGroupName

getScopeComponents

getQueryServiceMetricInfo

createQueryServiceMetricInfo

getMetricIdentifier

getMetricIdentifier

getMetricIdentifier

close

isClosed

counter

counter

gauge

histogram

meter

addMetric

addGroup

addGroup

createChildGroup