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

Class AggregatingSubtasksMetricsHandler

java.lang.Object

org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

org.apache.flink.runtime.rest.handler.legacy.metrics.AggregatingSubtasksMetricsHandler

All Implemented Interfaces:

RequestHandler

public class AggregatingSubtasksMetricsHandler
extends AbstractJsonRequestHandler

Request handler that returns, aggregated across all subtasks, a list of all available metrics or the values for a set of metrics.

Specific subtasks can be selected for aggregation by specifying a comma-separated list of integer ranges. /metrics?get=X,Y&subtasks=0-2,4-5

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Fields inherited from class org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

executor

Constructor Summary

Constructors

Constructor and Description
AggregatingSubtasksMetricsHandler(Executor executor, MetricFetcher fetcher)

Method Summary

Modifier and Type	Method and Description
String[]	getPaths() Returns an array of REST URL's under which this handler can be registered.
protected Collection<? extends MetricStore.ComponentMetricStore>	getStores(MetricStore store, Map<String,String> pathParameters, Map<String,String> queryParameters)
CompletableFuture<String>	handleJsonRequest(Map<String,String> pathParams, Map<String,String> queryParams, JobManagerGateway jobManagerGateway) Core method that handles the request and generates the response.

Methods inherited from class org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

handleRequest

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

AggregatingSubtasksMetricsHandler

public AggregatingSubtasksMetricsHandler(Executor executor,
                                         MetricFetcher fetcher)

Method Detail

getStores

protected Collection<? extends MetricStore.ComponentMetricStore> getStores(MetricStore store,
                                                                           Map<String,String> pathParameters,
                                                                           Map<String,String> queryParameters)

getPaths

public String[] getPaths()

Description copied from interface: RequestHandler

Returns an array of REST URL's under which this handler can be registered.

Returns:

array containing REST URL's under which this handler can be registered.

handleJsonRequest

public CompletableFuture<String> handleJsonRequest(Map<String,String> pathParams,
                                                   Map<String,String> queryParams,
                                                   JobManagerGateway jobManagerGateway)

Description copied from class: AbstractJsonRequestHandler

Core method that handles the request and generates the response. The method needs to respond with a valid JSON string. Exceptions may be thrown and will be handled.

Specified by:

handleJsonRequest in class AbstractJsonRequestHandler

Parameters:

pathParams - The map of REST path parameters, decoded by the router.

queryParams - The map of query parameters.

jobManagerGateway - to communicate with the JobManager.

Returns:

The JSON string that is the HTTP response.