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

Class JobMetricsHandler

java.lang.Object

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

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

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

All Implemented Interfaces:

RequestHandler

public class JobMetricsHandler
extends AbstractMetricsHandler

Request handler that returns for a given job 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. {"available": [ { "name" : "X", "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_JOB_ID

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

PARAMETER_METRICS

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

executor

Constructor Summary

Constructors

Constructor and Description
JobMetricsHandler(Executor executor, MetricFetcher fetcher)

Method Summary

Modifier and Type	Method and Description
protected 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.
String[]	getPaths() Returns an array of REST URL's under which this handler can be registered.

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

handleJsonRequest

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

PARAMETER_JOB_ID

public static final String PARAMETER_JOB_ID

See Also:

Constant Field Values

Constructor Detail

JobMetricsHandler

public JobMetricsHandler(Executor executor,
                         MetricFetcher fetcher)

Method Detail

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.

getMapFor

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

Description copied from class: AbstractMetricsHandler

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

Specified by:

getMapFor in class AbstractMetricsHandler

Parameters:

pathParams - REST path parameters

metrics - MetricStore containing all metrics

Returns:

Map containing metrics, or null if no metric exists