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

Class JobMetricsHandler

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,MetricCollectionResponseBody,M>

org.apache.flink.runtime.rest.handler.job.metrics.AbstractMetricsHandler<JobMetricsMessageParameters>

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

All Implemented Interfaces:

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

public class JobMetricsHandler
extends AbstractMetricsHandler<JobMetricsMessageParameters>

Request handler that returns for a given job a list of all available metrics or the values for a set of metrics.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

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

Field Summary

Fields inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

log, MAPPER

Fields inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

Constructor Summary

Constructors

Constructor	Description
JobMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MetricFetcher metricFetcher)

Method Summary

Modifier and Type	Method	Description
protected MetricStore.ComponentMetricStore	getComponentMetricStore(HandlerRequest<EmptyRequestBody> request, MetricStore metricStore)	Returns the MetricStore.ComponentMetricStore that should be queried for metrics.

Methods inherited from class org.apache.flink.runtime.rest.handler.job.metrics.AbstractMetricsHandler

handleRequest

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractRestHandler

getMessageHeaders, respondToRequest

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

closeAsync, closeHandlerAsync, respondAsLeader

Methods inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0, getTimeout

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

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

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

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.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Details

JobMetricsHandler

public JobMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
 Duration timeout,
 Map<String,String> headers,
 MetricFetcher metricFetcher)

Method Details

getComponentMetricStore

@Nullable
protected MetricStore.ComponentMetricStore getComponentMetricStore(HandlerRequest<EmptyRequestBody> request,
 MetricStore metricStore)

Description copied from class: AbstractMetricsHandler

Returns the MetricStore.ComponentMetricStore that should be queried for metrics.

Specified by:

getComponentMetricStore in class AbstractMetricsHandler<JobMetricsMessageParameters>