org.onosproject.rest.resources

Class MetricsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.MetricsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="metrics")
public class MetricsWebResource
extends org.onosproject.rest.AbstractWebResource

Query metrics.

Constructor Summary

Constructors

Constructor and Description
MetricsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllMetrics() Gets stats information of all metrics.
javax.ws.rs.core.Response	getMetricByName(String metricName) Gets stats information of a metric.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Constructor Detail

MetricsWebResource

public MetricsWebResource()

Method Detail

getAllMetrics

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAllMetrics()

Gets stats information of all metrics. Returns array of all information for all metrics.

Returns:

200 OK with metric information as array

onos model

Metrics

getMetricByName

@GET
 @Produces(value="application/json")
 @Path(value="{metricName}")
public javax.ws.rs.core.Response getMetricByName(@PathParam(value="metricName")
                                                                                                                        String metricName)

Gets stats information of a metric. Returns array of all information for the specified metric.

Parameters:

metricName - metric name

Returns:

200 OK with metric information as array

onos model

Metric