ControlMetricsFactory (onos-app-cpman 1.5.0 API)

java.lang.Object
- org.onosproject.cpman.impl.ControlMetricsFactory

```
public final class ControlMetricsFactory
extends Object
```
Singleton class to provide various control plane metrics to other components.

Constructor Summary

Constructors
Constructor and Description

ControlMetricsFactory()

Constructors
Constructor and Description
`ControlMetricsFactory()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllControlMessageMetrics(Set<org.onosproject.net.DeviceId> deviceIds)` Adds control metrics for all devices.
`void`	`addControlMessageMetricsByDeviceId(org.onosproject.net.DeviceId deviceId)` Adds control metrics of a new device.
`void`	`addDiskMetricsByPartition(String partitionName)` Adds control metrics of a disk.
`void`	`addNetworkMetricsByInterface(String interfaceName)` Adds control metrics of a ethernet interface.
`MetricsAggregator`	`cpuIdleTime()` Returns CPU idle time metric aggregator.
`MetricsAggregator`	`cpuLoadMetric()` Returns CPU load metric aggregator.
`MetricsAggregator`	`diskReadBytes(String resourceName)` Returns disk read bytes metric aggregator.
`MetricsAggregator`	`diskWriteBytes(String resourceName)` Returns disk write bytes metric aggregator.
`Map<org.onosproject.net.DeviceId,MetricsAggregator>`	`flowmodPacket()` Returns flow-mod packet metric aggregator of all devices.
`MetricsAggregator`	`flowmodPacket(org.onosproject.net.DeviceId deviceId)` Returns flow-mod packet metric aggregator of a specified device.
`Map<org.onosproject.net.DeviceId,MetricsAggregator>`	`flowrmvPacket()` Returns flow-removed packet metric aggregator of all devices.
`MetricsAggregator`	`flowrmvPacket(org.onosproject.net.DeviceId deviceId)` Returns flow-removed packet metric aggregator of a specified device.
`Set<org.onosproject.net.DeviceId>`	`getDeviceIds()` Returns all device identifiers.
`Set<String>`	`getDiskPartitions()` Returns all disk partition names.
`static ControlMetricsFactory`	`getInstance()` Returns an instance of control metrics factory.
`Set<String>`	`getNetworkInterfaces()` Returns all network interface names.
`Map<org.onosproject.net.DeviceId,MetricsAggregator>`	`inboundPacket()` Returns inbound packet metric aggregator of all devices.
`MetricsAggregator`	`inboundPacket(org.onosproject.net.DeviceId deviceId)` Returns inbound packet metric aggregator of a specified device.
`void`	`initialization(org.onlab.metrics.MetricsService metricsService, org.onosproject.net.device.DeviceService deviceService)` Initializes the control metrics factory instance using the given metric service and device service.
`boolean`	`isMonitor()` Returns monitoring status.
`MetricsAggregator`	`memoryFreeRatio()` Returns free memory ratio metric aggregator.
`MetricsAggregator`	`memoryUsedRatio()` Returns used memory ratio metric aggregator.
`MetricsAggregator`	`nwIncomingBytes(String interfaceName)` Returns incoming bytes metric aggregator.
`MetricsAggregator`	`nwIncomingPackets(String interfaceName)` Returns incoming packets metric aggregator.
`MetricsAggregator`	`nwOutgoingBytes(String interfaceName)` Returns outgoing bytes metric aggregator.
`MetricsAggregator`	`nwOutgoingPackets(String interfaceName)` Returns outgoing packets metric aggregator.
`Map<org.onosproject.net.DeviceId,MetricsAggregator>`	`outboundPacket()` Returns outgoing packet metric aggregator of all devices.
`MetricsAggregator`	`outboundPacket(org.onosproject.net.DeviceId deviceId)` Returns outbound packet metric aggregator of a specified device.
`protected void`	`registerMetrics()` Registers new control metrics.
`void`	`removeControlMessageMetricsByDeviceId(org.onosproject.net.DeviceId deviceId)` Removes control metrics of an existing device.
`void`	`removeDiskMetricsByResourceName(String partitionName)` Removes control metrics of a disk.
`void`	`removeNetworkInterfacesByResourceName(String interfaceName)` Removes control metrics of a network interface.
`Map<org.onosproject.net.DeviceId,MetricsAggregator>`	`replyPacket()` Returns reply packet metric aggregator of all devices.
`MetricsAggregator`	`replyPacket(org.onosproject.net.DeviceId deviceId)` Returns reply packet metric aggregator of a specified device.
`Map<org.onosproject.net.DeviceId,MetricsAggregator>`	`requestPacket()` Returns request packet metric aggregator of all devices.
`MetricsAggregator`	`requestPacket(org.onosproject.net.DeviceId deviceId)` Returns request packet metric aggregator of a specified device.
`protected void`	`startMonitor()` Enable control plane monitoring.
`protected void`	`stopMonitor()` Disable control plane monitoring.
`MetricsAggregator`	`sysCpuTimeMetric()` Returns system CPU time metric aggregator.
`MetricsAggregator`	`totalCpuTimeMetric()` Returns total CPU time metric aggregator.
`protected void`	`unregisterMetrics()` Unregisters all control metrics.
`MetricsAggregator`	`userCpuTime()` Returns user CPU time metric aggregator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ControlMetricsFactory
```
public ControlMetricsFactory()
```
- Method Detail
  - initialization
```
public void initialization(org.onlab.metrics.MetricsService metricsService,
                           org.onosproject.net.device.DeviceService deviceService)
```
    Initializes the control metrics factory instance using the given metric service and device service. Makes sure that we only initialize control metrics factory instance once.
    
    Parameters:
    
    metricsService - metric service
    
    deviceService - device service
  - addControlMessageMetricsByDeviceId
```
public void addControlMessageMetricsByDeviceId(org.onosproject.net.DeviceId deviceId)
```
    Adds control metrics of a new device.
    
    Parameters:
    
    deviceId - device identifier
  - addDiskMetricsByPartition
```
public void addDiskMetricsByPartition(String partitionName)
```
    Adds control metrics of a disk.
    
    Parameters:
    
    partitionName - disk partition name
  - addNetworkMetricsByInterface
```
public void addNetworkMetricsByInterface(String interfaceName)
```
    Adds control metrics of a ethernet interface.
    
    Parameters:
    
    interfaceName - network interface name
  - removeControlMessageMetricsByDeviceId
```
public void removeControlMessageMetricsByDeviceId(org.onosproject.net.DeviceId deviceId)
```
    Removes control metrics of an existing device.
    
    Parameters:
    
    deviceId - device identifier
  - removeDiskMetricsByResourceName
```
public void removeDiskMetricsByResourceName(String partitionName)
```
    Removes control metrics of a disk.
    
    Parameters:
    
    partitionName - disk partition name
  - removeNetworkInterfacesByResourceName
```
public void removeNetworkInterfacesByResourceName(String interfaceName)
```
    Removes control metrics of a network interface.
    
    Parameters:
    
    interfaceName - network interface name
  - getDeviceIds
```
public Set<org.onosproject.net.DeviceId> getDeviceIds()
```
    Returns all device identifiers.
    
    Returns:
    
    a collection of device identifiers
  - getDiskPartitions
```
public Set<String> getDiskPartitions()
```
    Returns all disk partition names.
    
    Returns:
    
    a collection of disk partitions.
  - getNetworkInterfaces
```
public Set<String> getNetworkInterfaces()
```
    Returns all network interface names.
    
    Returns:
    
    a collection of network interfaces.
  - addAllControlMessageMetrics
```
public void addAllControlMessageMetrics(Set<org.onosproject.net.DeviceId> deviceIds)
```
    Adds control metrics for all devices.
    
    Parameters:
    
    deviceIds - a set of device identifiers
  - isMonitor
```
public boolean isMonitor()
```
    Returns monitoring status.
    
    Returns:
    
    monitoring status
  - startMonitor
```
protected void startMonitor()
```
    Enable control plane monitoring.
  - stopMonitor
```
protected void stopMonitor()
```
    Disable control plane monitoring.
  - registerMetrics
```
protected void registerMetrics()
```
    Registers new control metrics.
  - unregisterMetrics
```
protected void unregisterMetrics()
```
    Unregisters all control metrics.
  - cpuLoadMetric
```
public MetricsAggregator cpuLoadMetric()
```
    Returns CPU load metric aggregator.
    
    Returns:
    
    metric aggregator
  - totalCpuTimeMetric
```
public MetricsAggregator totalCpuTimeMetric()
```
    Returns total CPU time metric aggregator.
    
    Returns:
    
    metric aggregator
  - sysCpuTimeMetric
```
public MetricsAggregator sysCpuTimeMetric()
```
    Returns system CPU time metric aggregator.
    
    Returns:
    
    metric aggregator
  - userCpuTime
```
public MetricsAggregator userCpuTime()
```
    Returns user CPU time metric aggregator.
    
    Returns:
    
    metric aggregator
  - cpuIdleTime
```
public MetricsAggregator cpuIdleTime()
```
    Returns CPU idle time metric aggregator.
    
    Returns:
    
    metric aggregator
  - memoryFreeRatio
```
public MetricsAggregator memoryFreeRatio()
```
    Returns free memory ratio metric aggregator.
    
    Returns:
    
    metric aggregator
  - memoryUsedRatio
```
public MetricsAggregator memoryUsedRatio()
```
    Returns used memory ratio metric aggregator.
    
    Returns:
    
    metric aggregator
  - diskReadBytes
```
public MetricsAggregator diskReadBytes(String resourceName)
```
    Returns disk read bytes metric aggregator.
    
    Parameters:
    
    resourceName - name of disk resource
    
    Returns:
    
    metric aggregator
  - diskWriteBytes
```
public MetricsAggregator diskWriteBytes(String resourceName)
```
    Returns disk write bytes metric aggregator.
    
    Parameters:
    
    resourceName - name of disk resource
    
    Returns:
    
    metric aggregator
  - nwIncomingBytes
```
public MetricsAggregator nwIncomingBytes(String interfaceName)
```
    Returns incoming bytes metric aggregator.
    
    Parameters:
    
    interfaceName - name of network interface
    
    Returns:
    
    metric aggregator
  - nwOutgoingBytes
```
public MetricsAggregator nwOutgoingBytes(String interfaceName)
```
    Returns outgoing bytes metric aggregator.
    
    Parameters:
    
    interfaceName - name of network interface
    
    Returns:
    
    metric aggregator
  - nwIncomingPackets
```
public MetricsAggregator nwIncomingPackets(String interfaceName)
```
    Returns incoming packets metric aggregator.
    
    Parameters:
    
    interfaceName - name of network interface
    
    Returns:
    
    metric aggregator
  - nwOutgoingPackets
```
public MetricsAggregator nwOutgoingPackets(String interfaceName)
```
    Returns outgoing packets metric aggregator.
    
    Parameters:
    
    interfaceName - name of network interface
    
    Returns:
    
    metric aggregator
  - inboundPacket
```
public Map<org.onosproject.net.DeviceId,MetricsAggregator> inboundPacket()
```
    Returns inbound packet metric aggregator of all devices.
    
    Returns:
    
    metric aggregator
  - outboundPacket
```
public Map<org.onosproject.net.DeviceId,MetricsAggregator> outboundPacket()
```
    Returns outgoing packet metric aggregator of all devices.
    
    Returns:
    
    metric aggregator
  - flowmodPacket
```
public Map<org.onosproject.net.DeviceId,MetricsAggregator> flowmodPacket()
```
    Returns flow-mod packet metric aggregator of all devices.
    
    Returns:
    
    metric aggregator
  - flowrmvPacket
```
public Map<org.onosproject.net.DeviceId,MetricsAggregator> flowrmvPacket()
```
    Returns flow-removed packet metric aggregator of all devices.
    
    Returns:
    
    metric aggregator
  - requestPacket
```
public Map<org.onosproject.net.DeviceId,MetricsAggregator> requestPacket()
```
    Returns request packet metric aggregator of all devices.
    
    Returns:
    
    metric aggregator
  - replyPacket
```
public Map<org.onosproject.net.DeviceId,MetricsAggregator> replyPacket()
```
    Returns reply packet metric aggregator of all devices.
    
    Returns:
    
    metric aggregator
  - inboundPacket
```
public MetricsAggregator inboundPacket(org.onosproject.net.DeviceId deviceId)
```
    Returns inbound packet metric aggregator of a specified device.
    
    Parameters:
    
    deviceId - device identifier
    
    Returns:
    
    metric aggregator
  - outboundPacket
```
public MetricsAggregator outboundPacket(org.onosproject.net.DeviceId deviceId)
```
    Returns outbound packet metric aggregator of a specified device.
    
    Parameters:
    
    deviceId - device identifier
    
    Returns:
    
    metric aggregator
  - flowmodPacket
```
public MetricsAggregator flowmodPacket(org.onosproject.net.DeviceId deviceId)
```
    Returns flow-mod packet metric aggregator of a specified device.
    
    Parameters:
    
    deviceId - device identifier
    
    Returns:
    
    metric aggregator
  - flowrmvPacket
```
public MetricsAggregator flowrmvPacket(org.onosproject.net.DeviceId deviceId)
```
    Returns flow-removed packet metric aggregator of a specified device.
    
    Parameters:
    
    deviceId - device identifier
    
    Returns:
    
    metric aggregator
  - requestPacket
```
public MetricsAggregator requestPacket(org.onosproject.net.DeviceId deviceId)
```
    Returns request packet metric aggregator of a specified device.
    
    Parameters:
    
    deviceId - device identifier
    
    Returns:
    
    metric aggregator
  - replyPacket
```
public MetricsAggregator replyPacket(org.onosproject.net.DeviceId deviceId)
```
    Returns reply packet metric aggregator of a specified device.
    
    Parameters:
    
    deviceId - device identifier
    
    Returns:
    
    metric aggregator
  - getInstance
```
public static ControlMetricsFactory getInstance()
```
    Returns an instance of control metrics factory.
    
    Returns:
    
    instance of control metrics factory

Class ControlMetricsFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ControlMetricsFactory

Method Detail

initialization

addControlMessageMetricsByDeviceId

addDiskMetricsByPartition

addNetworkMetricsByInterface

removeControlMessageMetricsByDeviceId

removeDiskMetricsByResourceName

removeNetworkInterfacesByResourceName

getDeviceIds

getDiskPartitions

getNetworkInterfaces

addAllControlMessageMetrics

isMonitor

startMonitor

stopMonitor

registerMetrics

unregisterMetrics

cpuLoadMetric

totalCpuTimeMetric

sysCpuTimeMetric

userCpuTime

cpuIdleTime

memoryFreeRatio

memoryUsedRatio

diskReadBytes

diskWriteBytes

nwIncomingBytes

nwOutgoingBytes

nwIncomingPackets

nwOutgoingPackets

inboundPacket

outboundPacket

flowmodPacket

flowrmvPacket

requestPacket

replyPacket

inboundPacket

outboundPacket

flowmodPacket

flowrmvPacket

requestPacket

replyPacket

getInstance