org.onosproject.influxdbmetrics

Class DefaultInfluxDbMetricsRetriever

java.lang.Object

org.onosproject.influxdbmetrics.DefaultInfluxDbMetricsRetriever

All Implemented Interfaces:

InfluxDbMetricsRetriever

@Service
public class DefaultInfluxDbMetricsRetriever
extends Object
implements InfluxDbMetricsRetriever

A Metric retriever implementation for querying metrics from influxDB server.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.core.CoreService	coreService
protected String	database

Constructor Summary

Constructors

Constructor and Description
DefaultInfluxDbMetricsRetriever()

Method Summary

Modifier and Type	Method and Description
void	activate()
protected Map<org.onosproject.cluster.NodeId,Set<String>>	allMetricNames() Returns all metric names that bound with node identification.
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.
void	deactivate()
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.

Methods inherited from class java.lang.Object

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

Field Detail

coreService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.core.CoreService coreService

database

protected String database

Constructor Detail

DefaultInfluxDbMetricsRetriever

public DefaultInfluxDbMetricsRetriever()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

config

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

Description copied from interface: InfluxDbMetricsRetriever

Configures default parameters for influx database metrics retriever.

Specified by:

config in interface InfluxDbMetricsRetriever

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

allMetrics

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

Description copied from interface: InfluxDbMetricsRetriever

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

Specified by:

allMetrics in interface InfluxDbMetricsRetriever

Parameters:

period - projected period

unit - time unit

Returns:

all metric values of all nodes

metricsByNodeId

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

Description copied from interface: InfluxDbMetricsRetriever

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

Specified by:

metricsByNodeId in interface InfluxDbMetricsRetriever

Parameters:

nodeId - node identification

period - projected period

unit - time unit

Returns:

metric value of a node

metricsByName

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

Description copied from interface: InfluxDbMetricsRetriever

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

Specified by:

metricsByName in interface InfluxDbMetricsRetriever

Parameters:

metricName - metric name

period - projected period

unit - time unit

Returns:

metric value of all nodes

metric

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

Description copied from interface: InfluxDbMetricsRetriever

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

Specified by:

metric in interface InfluxDbMetricsRetriever

Parameters:

nodeId - node identification

metricName - metric name

period - projected period

unit - time unit

Returns:

metric value of a node

allMetrics

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

Description copied from interface: InfluxDbMetricsRetriever

Returns last metric values from all nodes.

Specified by:

allMetrics in interface InfluxDbMetricsRetriever

Returns:

all metrics from all nodes

metricsByNodeId

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

Description copied from interface: InfluxDbMetricsRetriever

Returns last metric values from a node.

Specified by:

metricsByNodeId in interface InfluxDbMetricsRetriever

Parameters:

nodeId - node identification

Returns:

all metrics from a given node

metricsByName

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

Description copied from interface: InfluxDbMetricsRetriever

Returns a collection of last metric values from all nodes.

Specified by:

metricsByName in interface InfluxDbMetricsRetriever

Parameters:

metricName - metric name

Returns:

a collection of metrics from all nodes

metric

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

Description copied from interface: InfluxDbMetricsRetriever

Returns a last metric value from a given node.

Specified by:

metric in interface InfluxDbMetricsRetriever

Parameters:

nodeId - node identification

metricName - metric name

Returns:

a metric value from a given node

allMetricNames

protected Map<org.onosproject.cluster.NodeId,Set<String>> allMetricNames()

Returns all metric names that bound with node identification.

Returns:

all metric names