org.apache.flink.runtime.metrics.dump

类 MetricQueryService

java.lang.Object

org.apache.flink.runtime.rpc.RpcEndpoint

org.apache.flink.runtime.metrics.dump.MetricQueryService

所有已实现的接口:

AutoCloseable, org.apache.flink.runtime.rpc.RpcGateway, MetricQueryServiceGateway, org.apache.flink.util.AutoCloseableAsync

public class MetricQueryService
extends org.apache.flink.runtime.rpc.RpcEndpoint
implements MetricQueryServiceGateway

The MetricQueryService creates a key-value representation of all metrics currently registered with Flink when queried.

It is realized as an actor and can be notified of - an added metric by calling addMetric(String, Metric, AbstractMetricGroup) - a removed metric by calling removeMetric(Metric) - a metric dump request by calling queryMetrics(Time)

嵌套类概要

从类继承的嵌套类/接口 org.apache.flink.runtime.rpc.RpcEndpoint

org.apache.flink.runtime.rpc.RpcEndpoint.MainThreadExecutor

字段概要

字段

限定符和类型	字段和说明
static String	METRIC_QUERY_SERVICE_NAME

从类继承的字段 org.apache.flink.runtime.rpc.RpcEndpoint

log, rpcServer

构造器概要

构造器

构造器和说明
MetricQueryService(org.apache.flink.runtime.rpc.RpcService rpcService, String endpointId, long messageSizeLimit)

方法概要

限定符和类型	方法和说明
void	addMetric(String metricName, org.apache.flink.metrics.Metric metric, AbstractMetricGroup group)
static MetricQueryService	createMetricQueryService(org.apache.flink.runtime.rpc.RpcService rpcService, ResourceID resourceID, long maximumFrameSize) Starts the MetricQueryService actor in the given actor system.
CompletableFuture<Void>	onStop()
CompletableFuture<MetricDumpSerialization.MetricSerializationResult>	queryMetrics(org.apache.flink.api.common.time.Time timeout)
void	removeMetric(org.apache.flink.metrics.Metric metric)

从类继承的方法 org.apache.flink.runtime.rpc.RpcEndpoint

callAsync, closeAsync, getAddress, getEndpointId, getHostname, getMainThreadExecutor, getRpcService, getSelfGateway, getTerminationFuture, internalCallOnStart, internalCallOnStop, isRunning, onStart, registerResource, runAsync, scheduleRunAsync, scheduleRunAsync, start, stop, unregisterResource, validateRunsInMainThread

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

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

从接口继承的方法 org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

从接口继承的方法 org.apache.flink.util.AutoCloseableAsync

close

字段详细资料

METRIC_QUERY_SERVICE_NAME

public static final String METRIC_QUERY_SERVICE_NAME

另请参阅:

常量字段值

构造器详细资料

MetricQueryService

public MetricQueryService(org.apache.flink.runtime.rpc.RpcService rpcService,
                          String endpointId,
                          long messageSizeLimit)

方法详细资料

onStop

public CompletableFuture<Void> onStop()

覆盖:

onStop 在类中 org.apache.flink.runtime.rpc.RpcEndpoint

addMetric

public void addMetric(String metricName,
                      org.apache.flink.metrics.Metric metric,
                      AbstractMetricGroup group)

removeMetric

public void removeMetric(org.apache.flink.metrics.Metric metric)

queryMetrics

public CompletableFuture<MetricDumpSerialization.MetricSerializationResult> queryMetrics(org.apache.flink.api.common.time.Time timeout)

指定者:

queryMetrics 在接口中 MetricQueryServiceGateway

createMetricQueryService

public static MetricQueryService createMetricQueryService(org.apache.flink.runtime.rpc.RpcService rpcService,
                                                          ResourceID resourceID,
                                                          long maximumFrameSize)

Starts the MetricQueryService actor in the given actor system.

参数:

rpcService - The rpcService running the MetricQueryService

resourceID - resource ID to disambiguate the actor name

返回:

actor reference to the MetricQueryService