org.onosproject.gangliametrics

Class DefaultGangliaMetricsReporter

java.lang.Object

org.onosproject.gangliametrics.DefaultGangliaMetricsReporter

All Implemented Interfaces:

org.onlab.metrics.MetricsReporter, GangliaMetricsReporter

public class DefaultGangliaMetricsReporter
extends Object
implements GangliaMetricsReporter

A metric report that reports all metrics value to ganglia monitoring server.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	address
protected org.onosproject.cfg.ComponentConfigService	cfgService
protected org.onosproject.core.CoreService	coreService
protected String	metricNames
protected org.onlab.metrics.MetricsService	metricsService
protected boolean	monitorAll
protected int	port
protected int	ttl

Constructor Summary

Constructors

Constructor and Description
DefaultGangliaMetricsReporter()

Method Summary

Modifier and Type	Method and Description
void	activate()
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

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; default metric names are \'default\'")
protected String metricNames

address

@Property(name="address",
          value="localhost",
          label="IP address of ganglia monitoring server; default is localhost")
protected String address

port

@Property(name="port",
          intValue=8649,
          label="Port number of ganglia monitoring server; default is 8649")
protected int port

ttl

@Property(name="ttl",
          intValue=1,
          label="TTL value of ganglia monitoring server; default is 1")
protected int ttl

Constructor Detail

DefaultGangliaMetricsReporter

public DefaultGangliaMetricsReporter()

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

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

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