org.hawkular.client.metrics.clients

Interface CounterClient

All Known Implementing Classes:

DefaultCounterClient

public interface CounterClient

Method Summary

Modifier and Type	Method and Description
ClientResponse<Empty>	addCounterData(List<org.hawkular.metrics.model.Metric<Long>> counters) Add data points for multiple counters.
ClientResponse<Empty>	createCounter(Boolean overwrite, org.hawkular.metrics.model.Metric<Long> metric) Create counter metric.
ClientResponse<Empty>	createCounterData(String id, List<org.hawkular.metrics.model.DataPoint<Long>> data) Add data for a single counter.
ClientResponse<Empty>	deleteCounterMetricTags(String id, org.hawkular.metrics.model.param.Tags tags) Delete tags associated with the metric definition.
ClientResponse<List<org.hawkular.metrics.model.DataPoint<Long>>>	findCounterData(String id, String start, String end, Integer limit, Order order) Retrieve counter data points.
ClientResponse<Map<String,List<String>>>	findCounterMetrics(org.hawkular.metrics.model.param.Tags tags) Retrieve counter type’s tag values
ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>>	findCounterMetricStats(String id, String start, String end, Boolean fromEarliest, Integer bucketsCount, org.hawkular.metrics.model.param.Duration bucketDuration, org.hawkular.metrics.model.param.Percentiles percentiles, Integer limit, Order order) Retrieve counter data points.
ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>>	findCounterRate(String id, String start, String end, Integer limit, Order order, Integer bucketsCount, org.hawkular.metrics.model.param.Duration bucketDuration, org.hawkular.metrics.model.param.Percentiles percentiles) Retrieve counter rate data points.
ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>>	findCounterRateDataStats(String start, String end, Integer bucketsCount, org.hawkular.metrics.model.param.Duration bucketDuration, org.hawkular.metrics.model.param.Percentiles percentiles, org.hawkular.metrics.model.param.Tags tags, List<String> metricNames, Boolean stacked) Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names.
ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>>	findCounterRateStats(String id, String start, String end, Integer bucketsCount, org.hawkular.metrics.model.param.Duration bucketDuration, org.hawkular.metrics.model.param.Percentiles percentiles) Retrieve stats for counter rate data points.
ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>>	findCounterStats(String start, String end, Integer bucketsCount, org.hawkular.metrics.model.param.Duration bucketDuration, org.hawkular.metrics.model.param.Percentiles percentiles, org.hawkular.metrics.model.param.Tags tags, List<String> metricNames, Boolean stacked) Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names.
ClientResponse<org.hawkular.metrics.model.Metric<Long>>	getCounter(String id) Retrieve a counter definition.
ClientResponse<Map<String,org.hawkular.metrics.model.TaggedBucketPoint>>	getCounterMetricStatsTags(String id, org.hawkular.metrics.model.param.Tags tags, String start, String end, org.hawkular.metrics.model.param.Percentiles percentiles) Fetches data points and groups them into buckets based on one or more tag filters.
ClientResponse<Map<String,String>>	getCounterMetricTags(String id) Retrieve tags associated with the metric definition.
ClientResponse<List<org.hawkular.metrics.model.Metric<Long>>>	getCounters(org.hawkular.metrics.model.param.Tags tags) Find tenant’s counter metric definitions.
ClientResponse<Empty>	updateCountersMetricTags(String id, Map<String,String> tags) Update tags associated with the metric definition.

Method Detail

getCounters

ClientResponse<List<org.hawkular.metrics.model.Metric<Long>>> getCounters(org.hawkular.metrics.model.param.Tags tags)

Find tenant’s counter metric definitions.

Parameters:

tags -

Returns:

createCounter

ClientResponse<Empty> createCounter(Boolean overwrite,
                                    org.hawkular.metrics.model.Metric<Long> metric)

Create counter metric.

Parameters:

overwrite -

metric -

Returns:

findCounterRateDataStats

ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>> findCounterRateDataStats(String start,
                                                                                             String end,
                                                                                             Integer bucketsCount,
                                                                                             org.hawkular.metrics.model.param.Duration bucketDuration,
                                                                                             org.hawkular.metrics.model.param.Percentiles percentiles,
                                                                                             org.hawkular.metrics.model.param.Tags tags,
                                                                                             List<String> metricNames,
                                                                                             Boolean stacked)

Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied to the data points in each bucket to produce statistics or aggregated metrics.

Parameters:

start -

end -

bucketsCount -

bucketDuration -

percentiles -

tags -

metricNames -

stacked -

Returns:

addCounterData

ClientResponse<Empty> addCounterData(List<org.hawkular.metrics.model.Metric<Long>> counters)

Add data points for multiple counters.

Parameters:

counters -

Returns:

findCounterStats

ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>> findCounterStats(String start,
                                                                                     String end,
                                                                                     Integer bucketsCount,
                                                                                     org.hawkular.metrics.model.param.Duration bucketDuration,
                                                                                     org.hawkular.metrics.model.param.Percentiles percentiles,
                                                                                     org.hawkular.metrics.model.param.Tags tags,
                                                                                     List<String> metricNames,
                                                                                     Boolean stacked)

Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied tothe data points in each bucket to produce statistics or aggregated metrics.

Parameters:

start -

end -

bucketsCount -

bucketDuration -

percentiles -

tags -

metricNames -

stacked -

Returns:

findCounterMetrics

ClientResponse<Map<String,List<String>>> findCounterMetrics(org.hawkular.metrics.model.param.Tags tags)

Retrieve counter type’s tag values

Parameters:

tags -

Returns:

getCounter

ClientResponse<org.hawkular.metrics.model.Metric<Long>> getCounter(String id)

Retrieve a counter definition.

Parameters:

id -

Returns:

findCounterRate

ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>> findCounterRate(String id,
                                                                                    String start,
                                                                                    String end,
                                                                                    Integer limit,
                                                                                    Order order,
                                                                                    Integer bucketsCount,
                                                                                    org.hawkular.metrics.model.param.Duration bucketDuration,
                                                                                    org.hawkular.metrics.model.param.Percentiles percentiles)

Retrieve counter rate data points.

Parameters:

id -

start -

end -

limit -

order -

bucketsCount -

bucketDuration -

percentiles -

Returns:

findCounterRateStats

ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>> findCounterRateStats(String id,
                                                                                         String start,
                                                                                         String end,
                                                                                         Integer bucketsCount,
                                                                                         org.hawkular.metrics.model.param.Duration bucketDuration,
                                                                                         org.hawkular.metrics.model.param.Percentiles percentiles)

Retrieve stats for counter rate data points.

Parameters:

id -

start -

end -

bucketsCount -

bucketDuration -

percentiles -

Returns:

findCounterData

ClientResponse<List<org.hawkular.metrics.model.DataPoint<Long>>> findCounterData(String id,
                                                                                 String start,
                                                                                 String end,
                                                                                 Integer limit,
                                                                                 Order order)

Retrieve counter data points.

Parameters:

id -

start -

end -

limit -

order -

Returns:

createCounterData

ClientResponse<Empty> createCounterData(String id,
                                        List<org.hawkular.metrics.model.DataPoint<Long>> data)

Add data for a single counter.

Parameters:

id -

data -

Returns:

findCounterMetricStats

ClientResponse<List<org.hawkular.metrics.model.NumericBucketPoint>> findCounterMetricStats(String id,
                                                                                           String start,
                                                                                           String end,
                                                                                           Boolean fromEarliest,
                                                                                           Integer bucketsCount,
                                                                                           org.hawkular.metrics.model.param.Duration bucketDuration,
                                                                                           org.hawkular.metrics.model.param.Percentiles percentiles,
                                                                                           Integer limit,
                                                                                           Order order)

Retrieve counter data points.

Parameters:

id -

start -

end -

fromEarliest -

bucketsCount -

bucketDuration -

percentiles -

limit -

order -

Returns:

getCounterMetricStatsTags

ClientResponse<Map<String,org.hawkular.metrics.model.TaggedBucketPoint>> getCounterMetricStatsTags(String id,
                                                                                                   org.hawkular.metrics.model.param.Tags tags,
                                                                                                   String start,
                                                                                                   String end,
                                                                                                   org.hawkular.metrics.model.param.Percentiles percentiles)

Fetches data points and groups them into buckets based on one or more tag filters. The data points in each bucket are then transformed into aggregated (i.e., bucket) data points.

Parameters:

id -

tags -

start -

end -

percentiles -

Returns:

getCounterMetricTags

ClientResponse<Map<String,String>> getCounterMetricTags(String id)

Retrieve tags associated with the metric definition.

Parameters:

id -

Returns:

updateCountersMetricTags

ClientResponse<Empty> updateCountersMetricTags(String id,
                                               Map<String,String> tags)

Update tags associated with the metric definition.

Parameters:

id -

tags -

Returns:

deleteCounterMetricTags

ClientResponse<Empty> deleteCounterMetricTags(String id,
                                              org.hawkular.metrics.model.param.Tags tags)

Delete tags associated with the metric definition.

Parameters:

id -

tags -

Returns: