org.apache.hadoop.chukwa.hicc.rest

Class MetricsController

java.lang.Object

org.apache.hadoop.chukwa.hicc.rest.MetricsController

public class MetricsController
extends Object

Constructor Summary

Constructors

Constructor and Description
MetricsController()

Method Summary

Modifier and Type	Method and Description
String	getMetrics(String metricGroup) Query metric names by metric group
String	getSeries(javax.servlet.http.HttpServletRequest request, String metric, String source, String start, String end) Query metrics stored in HBase table
String	getSeriesBySessionAttribute(javax.servlet.http.HttpServletRequest request, String metricGroup, String metric, String skey, String start, String end) Query metric series by session key, this is useful to query same metric from multiple data sources, such as multiple hosts
String	getSourceNames(javax.servlet.http.HttpServletRequest request, String metricGroup) Query metrics source names by metric group
String	getTables() Query all metric group names in HBase

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsController

public MetricsController()

Method Detail

getSeries

public String getSeries(@Context
                        javax.servlet.http.HttpServletRequest request,
                        String metric,
                        String source,
                        String start,
                        String end)

Query metrics stored in HBase table

Parameters:

request - is HTTP request object

metric - is metric name

source - is data source

start - is start time

end - is end time

Returns:

Metrics JSON

getSeriesBySessionAttribute

public String getSeriesBySessionAttribute(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          String metricGroup,
                                          String metric,
                                          String skey,
                                          String start,
                                          String end)

Query metric series by session key, this is useful to query same metric from multiple data sources, such as multiple hosts

Parameters:

request - is HTTP request object

metricGroup - is metric group name

metric - is metric name

skey - is session key which maps to multiple data sources

start - is start time

end - is end time

Returns:

List of metric series

getTables

public String getTables()

Query all metric group names in HBase

Returns:

a list of metric groups

getMetrics

public String getMetrics(String metricGroup)

Query metric names by metric group

Parameters:

metricGroup - is name of metric group

Returns:

a list of metric names

getSourceNames

public String getSourceNames(@Context
                             javax.servlet.http.HttpServletRequest request,
                             String metricGroup)

Query metrics source names by metric group

Parameters:

request - HTTP Request object

metricGroup - is name of metric group

Returns:

a list of metric source names