org.onosproject.influxdbmetrics

Interface InfluxDbMetricsRetriever

All Known Implementing Classes:

DefaultInfluxDbMetricsRetriever

public interface InfluxDbMetricsRetriever

A Metric retriever interface for querying metrics value from influxDB server.

Method Summary

Modifier and Type	Method and Description
Map<org.onosproject.cluster.NodeId,Map<String,InfluxMetric>>	allMetrics() Returns last metric values from all nodes.
Map<org.onosproject.cluster.NodeId,Map<String,List<InfluxMetric>>>	allMetrics(int period, TimeUnit unit) Returns metric values of all nodes within a given period of time.
void	config(String address, int port, String database, String username, String password) Configures default parameters for influx database metrics retriever.
InfluxMetric	metric(org.onosproject.cluster.NodeId nodeId, String metricName) Returns a last metric value from a given node.
List<InfluxMetric>	metric(org.onosproject.cluster.NodeId nodeId, String metricName, int period, TimeUnit unit) Returns metric value of a given node within a given period of time.
Map<org.onosproject.cluster.NodeId,InfluxMetric>	metricsByName(String metricName) Returns a collection of last metric values from all nodes.
Map<org.onosproject.cluster.NodeId,List<InfluxMetric>>	metricsByName(String metricName, int period, TimeUnit unit) Returns a collection of last metric values of all nodes within a given period of time.
Map<String,InfluxMetric>	metricsByNodeId(org.onosproject.cluster.NodeId nodeId) Returns last metric values from a node.
Map<String,List<InfluxMetric>>	metricsByNodeId(org.onosproject.cluster.NodeId nodeId, int period, TimeUnit unit) Returns metric values of a node within a given period of time.

Method Detail

allMetrics

Map<org.onosproject.cluster.NodeId,Map<String,InfluxMetric>> allMetrics()

Returns last metric values from all nodes.

Returns:

all metrics from all nodes

metricsByNodeId

Map<String,InfluxMetric> metricsByNodeId(org.onosproject.cluster.NodeId nodeId)

Returns last metric values from a node.

Parameters:

nodeId - node identification

Returns:

all metrics from a given node

metricsByName

Map<org.onosproject.cluster.NodeId,InfluxMetric> metricsByName(String metricName)

Returns a collection of last metric values from all nodes.

Parameters:

metricName - metric name

Returns:

a collection of metrics from all nodes

metric

InfluxMetric metric(org.onosproject.cluster.NodeId nodeId,
                    String metricName)

Returns a last metric value from a given node.

Parameters:

nodeId - node identification

metricName - metric name

Returns:

a metric value from a given node

allMetrics

Map<org.onosproject.cluster.NodeId,Map<String,List<InfluxMetric>>> allMetrics(int period,
                                                                              TimeUnit unit)

Returns metric values of all nodes within a given period of time.

Parameters:

period - projected period

unit - time unit

Returns:

all metric values of all nodes

metricsByNodeId

Map<String,List<InfluxMetric>> metricsByNodeId(org.onosproject.cluster.NodeId nodeId,
                                               int period,
                                               TimeUnit unit)

Returns metric values of a node within a given period of time.

Parameters:

nodeId - node identification

period - projected period

unit - time unit

Returns:

metric value of a node

metricsByName

Map<org.onosproject.cluster.NodeId,List<InfluxMetric>> metricsByName(String metricName,
                                                                     int period,
                                                                     TimeUnit unit)

Returns a collection of last metric values of all nodes within a given period of time.

Parameters:

metricName - metric name

period - projected period

unit - time unit

Returns:

metric value of all nodes

metric

List<InfluxMetric> metric(org.onosproject.cluster.NodeId nodeId,
                          String metricName,
                          int period,
                          TimeUnit unit)

Returns metric value of a given node within a given period of time.

Parameters:

nodeId - node identification

metricName - metric name

period - projected period

unit - time unit

Returns:

metric value of a node

config

void config(String address,
            int port,
            String database,
            String username,
            String password)

Configures default parameters for influx database metrics retriever.

Parameters:

address - IP address of influxDB server

port - Port number of influxDB server

database - Database name of influxDB server

username - Username of influxDB server

password - Password of influxDB server