org.apache.hadoop.chukwa.datastore

Class ChukwaHBaseStore

java.lang.Object

org.apache.hadoop.chukwa.datastore.ChukwaHBaseStore

public class ChukwaHBaseStore
extends Object

Constructor Summary

Constructors

Constructor and Description
ChukwaHBaseStore()

Method Summary

Modifier and Type	Method and Description
static void	closeHBase()
static String	createChart(Chart chart) Create a chart in HBase.
static String	createChart(String id, String title, String[] metrics, String source, String yunitType) Create a chart in HBase by specifying parameters.
static String	createCircle(String id, String title, String[] metrics, String source, String suffixLabel, String direction) Create a chart in HBase by specifying parameters.
static String	createTile(String id, String title, String bannerText, String suffixLabel, String[] metrics, String source, String icon) Create a tile in HBase by specifying parameters.
static boolean	createWidget(Widget widget) Create a widget in HBase.
static boolean	deleteWidget(String title) Delete a widget in HBase.
static Chart	getChart(String id) Get a chart from HBase by ID.
static ArrayList<SeriesMetaData>	getChartSeries(ArrayList<SeriesMetaData> series, long startTime, long endTime) Return data for multiple series of metrics stored in HBase.
static Set<String>	getClusterNames(long startTime, long endTime) Scan chukwa table and find cluster tag from annotation column family from a range of entries.
static Dashboard	getDashboard(String id, String user)
static List<String>	getData(ArrayList<SeriesMetaData> series, long startTime, long endTime)
static void	getHBaseConnection()
static Heatmap	getHeatmap(String metricGroup, String metric, long startTime, long endTime, double max, double scale, int width, int height)
static Set<String>	getMetricGroups()
static Set<String>	getMetricNames(String metricGroup)
static Series	getSeries(String metric, String source, long startTime, long endTime) Scan chukwa table for a full metric name based on time ranges.
static Series	getSeries(String metricGroup, String metric, String source, long startTime, long endTime) Scan chukwa table for a particular metric group and metric name based on time ranges.
static Set<String>	getSourceNames(String dataType)
static boolean	isDefaultExists()
static List<Widget>	listWidget(int limit, int offset) List widgets stored in HBase.
static void	populateDefaults()
static void	putChart(String id, Chart chart) Update a chart in HBase by ID.
static List<Widget>	searchWidget(String query) Find widget by title prefix in HBase.
static boolean	updateDashboard(String id, String user, Dashboard dash)
static boolean	updateWidget(String title, Widget widget) Update a widget in HBase.
static Widget	viewWidget(String title) View a widget information in HBase.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChukwaHBaseStore

public ChukwaHBaseStore()

Method Detail

getHBaseConnection

public static void getHBaseConnection()
                               throws IOException

Throws:

IOException

closeHBase

public static void closeHBase()

getSeries

public static Series getSeries(String metricGroup,
                               String metric,
                               String source,
                               long startTime,
                               long endTime)

Scan chukwa table for a particular metric group and metric name based on time ranges.

Parameters:

metricGroup - metric group name

metric - metric name

source - source of the metric

startTime - start time

endTime - end time

Returns:

Series object

getSeries

public static Series getSeries(String metric,
                               String source,
                               long startTime,
                               long endTime)

Scan chukwa table for a full metric name based on time ranges.

Parameters:

metric - metric group name and metric name combined

source - source of the metric

startTime - start time

endTime - end time

Returns:

Series object

getMetricNames

public static Set<String> getMetricNames(String metricGroup)

getMetricGroups

public static Set<String> getMetricGroups()

getSourceNames

public static Set<String> getSourceNames(String dataType)

getHeatmap

public static Heatmap getHeatmap(String metricGroup,
                                 String metric,
                                 long startTime,
                                 long endTime,
                                 double max,
                                 double scale,
                                 int width,
                                 int height)

getClusterNames

public static Set<String> getClusterNames(long startTime,
                                          long endTime)

Scan chukwa table and find cluster tag from annotation column family from a range of entries.

Parameters:

startTime - start time in epoch

endTime - start time in epoch

Returns:

Set of cluster names

getChart

public static Chart getChart(String id)

Get a chart from HBase by ID.

Parameters:

id - Chart ID

Returns:

Chart object

putChart

public static void putChart(String id,
                            Chart chart)

Update a chart in HBase by ID.

Parameters:

id - Chart ID

chart - Chart Object

createChart

public static String createChart(String id,
                                 String title,
                                 String[] metrics,
                                 String source,
                                 String yunitType)
                          throws URISyntaxException

Create a chart in HBase by specifying parameters.

Parameters:

id - is unique chart identifier

title - is searchable name of the chart

metrics - is list of metric names to render chart

source - is data source name

yunitType - is y axis unit type

Returns:

Chart ID

Throws:

URISyntaxException - if metrics name can not compose valid URL syntax

createCircle

public static String createCircle(String id,
                                  String title,
                                  String[] metrics,
                                  String source,
                                  String suffixLabel,
                                  String direction)
                           throws URISyntaxException

Create a chart in HBase by specifying parameters.

Parameters:

id - is unique chart identifier

title - is searchable name of the chart

metrics - is list of metric names to render ring chart

source - is data source name

suffixLabel - is text label to append to metric values

direction - sets the threshold to have either upper limit or lower limit

Returns:

Chart ID

Throws:

URISyntaxException - if metrics name can not compose valid URL syntax

createTile

public static String createTile(String id,
                                String title,
                                String bannerText,
                                String suffixLabel,
                                String[] metrics,
                                String source,
                                String icon)
                         throws URISyntaxException

Create a tile in HBase by specifying parameters.

Parameters:

id - is unique tile identifier

title - is searchable name of the tile widget

bannerText - is description of the tile widget

suffixLabel - is text label to append to metric values

metrics - is list of metric names to render tile widget

source - is data source name

icon - is emoji symbol to render beside tile widget

Returns:

Widget ID

Throws:

URISyntaxException - if metrics name can not compose valid URL syntax

createChart

public static String createChart(Chart chart)

Create a chart in HBase.

Parameters:

chart - is a chukwa Chart object

Returns:

id of newly created chart

getChartSeries

public static ArrayList<SeriesMetaData> getChartSeries(ArrayList<SeriesMetaData> series,
                                                       long startTime,
                                                       long endTime)

Return data for multiple series of metrics stored in HBase.

Parameters:

series - is SeriesMetaData object

startTime - sets the start time of metrics

endTime - sets the end time of metrics

Returns:

A list of Series meta data

listWidget

public static List<Widget> listWidget(int limit,
                                      int offset)

List widgets stored in HBase.

Parameters:

limit - sets the number of widgets to return

offset - sets the starting point to return widgets

Returns:

List of Widgets

getData

public static List<String> getData(ArrayList<SeriesMetaData> series,
                                   long startTime,
                                   long endTime)

searchWidget

public static List<Widget> searchWidget(String query)

Find widget by title prefix in HBase.

Parameters:

query - is prefix query of widget title.

Returns:

List of Widgets

viewWidget

public static Widget viewWidget(String title)

View a widget information in HBase.

Parameters:

title - is title of the widget.

Returns:

List of Widgets

createWidget

public static boolean createWidget(Widget widget)

Create a widget in HBase.

Parameters:

widget - is chukwa Widget object

Returns:

true if widget is created

updateWidget

public static boolean updateWidget(String title,
                                   Widget widget)

Update a widget in HBase.

Parameters:

title - is searchable title in a widget

widget - is Chukwa Widget object

Returns:

true if widget has been updated

deleteWidget

public static boolean deleteWidget(String title)

Delete a widget in HBase.

Parameters:

title - is searchable title in a widget

Returns:

true if widget has been deleted

isDefaultExists

public static boolean isDefaultExists()

populateDefaults

public static void populateDefaults()

getDashboard

public static Dashboard getDashboard(String id,
                                     String user)

updateDashboard

public static boolean updateDashboard(String id,
                                      String user,
                                      Dashboard dash)