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

Class AbstractMetricsHandler

java.lang.Object

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

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

All Implemented Interfaces:

RequestHandler

Direct Known Subclasses:

JobManagerMetricsHandler, JobMetricsHandler, JobVertexMetricsHandler, SubtaskMetricsHandler, TaskManagerMetricsHandler

public abstract class AbstractMetricsHandler
extends AbstractJsonRequestHandler

Abstract request handler that returns a list of all available metrics or the values for a set of metrics.

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" } ]

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_METRICS

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

executor

Constructor Summary

Constructors

Constructor and Description
AbstractMetricsHandler(Executor executor, MetricFetcher fetcher)

Method Summary

Modifier and Type	Method and Description
protected abstract Map<String,String>	getMapFor(Map<String,String> pathParams, MetricStore metrics) Returns a Map containing the metrics belonging to the entity pointed to by the path parameters.
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

Methods inherited from interface org.apache.flink.runtime.rest.handler.legacy.RequestHandler

getPaths

Field Detail

PARAMETER_METRICS

public static final String PARAMETER_METRICS

See Also:

Constant Field Values

Constructor Detail

AbstractMetricsHandler

public AbstractMetricsHandler(Executor executor,
                              MetricFetcher fetcher)

Method Detail

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.

getMapFor

protected abstract Map<String,String> getMapFor(Map<String,String> pathParams,
                                                MetricStore metrics)

Returns a Map containing the metrics belonging to the entity pointed to by the path parameters.

Parameters:

pathParams - REST path parameters

metrics - MetricStore containing all metrics

Returns:

Map containing metrics, or null if no metric exists