org.apache.flink.runtime.rest.handler.job.metrics

类 AbstractAggregatingMetricsHandler<P extends AbstractAggregatedMetricsParameters<?>>

java.lang.Object

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler<RoutedRequest>

org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler<T>

org.apache.flink.runtime.rest.handler.AbstractHandler<T,R,M>

org.apache.flink.runtime.rest.handler.AbstractRestHandler<RestfulGateway,EmptyRequestBody,AggregatedMetricsResponseBody,P>

org.apache.flink.runtime.rest.handler.job.metrics.AbstractAggregatingMetricsHandler<P>

所有已实现的接口:

AutoCloseable, org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler, org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler, org.apache.flink.util.AutoCloseableAsync

直接已知子类:

AggregatingJobsMetricsHandler, AggregatingSubtasksMetricsHandler, AggregatingTaskManagersMetricsHandler

public abstract class AbstractAggregatingMetricsHandler<P extends AbstractAggregatedMetricsParameters<?>>
extends AbstractRestHandler<RestfulGateway,EmptyRequestBody,AggregatedMetricsResponseBody,P>

Abstract request handler for querying aggregated metrics. Subclasses return either a list of all available metrics or the aggregated values of them across all/selected entities.

If the query parameters do not contain a "get" parameter the list of all metrics is returned. [ { "id" : "X" } ]

If the query parameters do contain a "get" parameter, a comma-separated list of metric names is expected as a value. /metrics?get=X,Y The handler will then return a list containing the values of the requested metrics. [ { "id" : "X", "value" : "S" }, { "id" : "Y", "value" : "T" } ]

The "agg" query parameter is used to define which aggregates should be calculated. Available aggregations are "sum", "max", "min" and "avg". If the parameter is not specified, all aggregations will be returned. /metrics?get=X,Y&agg=min,max The handler will then return a list of objects containing the aggregations for the requested metrics. [ { "id" : "X", "min", "1", "max", "2" }, { "id" : "Y", "min", "4", "max", "10"}]

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler.Sharable

字段概要

从类继承的字段 org.apache.flink.runtime.rest.handler.AbstractHandler

log, MAPPER

从类继承的字段 org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

构造器概要

构造器

限定符	构造器和说明
protected	AbstractAggregatingMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, AbstractAggregatedMetricsHeaders<P> messageHeaders, Executor executor, MetricFetcher fetcher)

方法概要

限定符和类型	方法和说明
protected CompletableFuture<AggregatedMetricsResponseBody>	handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway) This method is called for every incoming request and returns a CompletableFuture containing a the response.

从类继承的方法 org.apache.flink.runtime.rest.handler.AbstractRestHandler

getMessageHeaders, respondToRequest

从类继承的方法 org.apache.flink.runtime.rest.handler.AbstractHandler

closeAsync, closeHandlerAsync, respondAsLeader

从类继承的方法 org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

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

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

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

close

从接口继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

构造器详细资料

AbstractAggregatingMetricsHandler

protected AbstractAggregatingMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                            org.apache.flink.api.common.time.Time timeout,
                                            Map<String,String> responseHeaders,
                                            AbstractAggregatedMetricsHeaders<P> messageHeaders,
                                            Executor executor,
                                            MetricFetcher fetcher)

方法详细资料

handleRequest

protected CompletableFuture<AggregatedMetricsResponseBody> handleRequest(@Nonnull
                                                                         HandlerRequest<EmptyRequestBody> request,
                                                                         @Nonnull
                                                                         RestfulGateway gateway)
                                                                  throws RestHandlerException

从类复制的说明: AbstractRestHandler

This method is called for every incoming request and returns a CompletableFuture containing a the response.

Implementations may decide whether to throw RestHandlerExceptions or fail the returned CompletableFuture with a RestHandlerException.

Failing the future with another exception type or throwing unchecked exceptions is regarded as an implementation error as it does not allow us to provide a meaningful HTTP status code. In this case a HttpResponseStatus.INTERNAL_SERVER_ERROR will be returned.

指定者:

handleRequest 在类中 AbstractRestHandler<RestfulGateway,EmptyRequestBody,AggregatedMetricsResponseBody,P extends AbstractAggregatedMetricsParameters<?>>

参数:

request - request that should be handled

gateway - leader gateway

返回:

future containing a handler response

抛出:

RestHandlerException - if the handling failed