org.onosproject.influxdbmetrics

Class DefaultInfluxDbMetricsReporter

java.lang.Object

org.onosproject.influxdbmetrics.DefaultInfluxDbMetricsReporter

All Implemented Interfaces:

org.onlab.metrics.MetricsReporter, InfluxDbMetricsReporter

@Service
public class DefaultInfluxDbMetricsReporter
extends Object
implements InfluxDbMetricsReporter

A Metric reporter that reports all metrics value to influxDB server.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	address
protected org.onosproject.cfg.ComponentConfigService	cfgService
protected org.onosproject.cluster.ClusterService	clusterService
protected org.onosproject.core.CoreService	coreService
protected String	database
protected String	metricNames
protected org.onlab.metrics.MetricsService	metricsService
protected boolean	monitorAll
protected String	password
protected int	port
protected String	username

Constructor Summary

Constructors

Constructor and Description
DefaultInfluxDbMetricsReporter()

Method Summary

Modifier and Type	Method and Description
void	activate()
protected com.codahale.metrics.MetricRegistry	addHostPrefix(com.codahale.metrics.MetricRegistry metricRegistry) Appends node IP prefix to all performance metrics.
void	config(String address, int port, String database, String username, String password) Configures default parameters for influx database metrics reporter.
protected boolean	containsName(String full, String prefixes) Looks up whether the metric name contains the given prefix keywords.
void	deactivate()
protected com.codahale.metrics.MetricRegistry	filter(com.codahale.metrics.MetricRegistry metricRegistry) Filters the metrics to only include a set of the given metrics.
void	modified(org.osgi.service.component.ComponentContext context)
void	notifyMetricsChange()
void	restartReport()
void	startReport()
void	stopReport()

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

metricsService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onlab.metrics.MetricsService metricsService

cfgService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cfg.ComponentConfigService cfgService

clusterService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cluster.ClusterService clusterService

monitorAll

@Property(name="monitorAll",
          boolValue=true,
          label="Enable to monitor all of metrics stored in metric registry default is true")
protected boolean monitorAll

metricNames

@Property(name="metricNames",
          value="default",
          label="Names of metric to be monitored in third party monitoring server; default metric names are \'default\'")
protected String metricNames

address

protected String address

port

protected int port

database

protected String database

username

protected String username

password

protected String password

Constructor Detail

DefaultInfluxDbMetricsReporter

public DefaultInfluxDbMetricsReporter()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

modified

@Modified
public void modified(org.osgi.service.component.ComponentContext context)

startReport

public void startReport()

Specified by:

startReport in interface org.onlab.metrics.MetricsReporter

stopReport

public void stopReport()

Specified by:

stopReport in interface org.onlab.metrics.MetricsReporter

restartReport

public void restartReport()

Specified by:

restartReport in interface org.onlab.metrics.MetricsReporter

notifyMetricsChange

public void notifyMetricsChange()

Specified by:

notifyMetricsChange in interface org.onlab.metrics.MetricsReporter

config

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

Description copied from interface: InfluxDbMetricsReporter

Configures default parameters for influx database metrics reporter.

Specified by:

config in interface InfluxDbMetricsReporter

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

filter

protected com.codahale.metrics.MetricRegistry filter(com.codahale.metrics.MetricRegistry metricRegistry)

Filters the metrics to only include a set of the given metrics.

Parameters:

metricRegistry - original metric registry

Returns:

filtered metric registry

addHostPrefix

protected com.codahale.metrics.MetricRegistry addHostPrefix(com.codahale.metrics.MetricRegistry metricRegistry)

Appends node IP prefix to all performance metrics.

Parameters:

metricRegistry - original metric registry

Returns:

prefix added metric registry

containsName

protected boolean containsName(String full,
                               String prefixes)

Looks up whether the metric name contains the given prefix keywords. Note that the keywords are separated with comma as delimiter.

Parameters:

full - the original metric name that to be compared with

prefixes - the prefix keywords that are matched against with the metric name

Returns:

boolean value that denotes whether the metric name starts with the given prefix