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

Class JobManagerMetricsHandler

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.JobManagerMetricsHandler

All Implemented Interfaces:

RequestHandler

public class JobManagerMetricsHandler
extends AbstractMetricsHandler

Request handler that returns for the job manager 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 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
JobManagerMetricsHandler(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

Constructor Detail

JobManagerMetricsHandler

public JobManagerMetricsHandler(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