org.onosproject.cpman

Interface ControlPlaneStatsService

public interface ControlPlaneStatsService

Control Plane Statistics Service Interface.

Method Summary

Modifier and Type	Method and Description
ControlPlaneLoad	getLoad(org.onosproject.cluster.NodeId nodeId, ControlMetricType type, Optional<org.onosproject.net.DeviceId> deviceId) Obtain the control plane load of a specific device.
ControlPlaneLoad	getLoad(org.onosproject.cluster.NodeId nodeId, ControlMetricType type, Optional<org.onosproject.net.DeviceId> deviceId, int duration, TimeUnit unit) Obtain the control plane load of a specific device with a specific time duration.
void	updateMetric(ControlPlaneMetric cpm, int updateInterval) Add a new control plane metric value with a certain update interval.

Method Detail

updateMetric

void updateMetric(ControlPlaneMetric cpm,
                  int updateInterval)

Add a new control plane metric value with a certain update interval.

Parameters:

cpm - control plane metric (e.g., control message rate, cpu, memory, etc.)

updateInterval - value update interval (time unit will be in minute)

getLoad

ControlPlaneLoad getLoad(org.onosproject.cluster.NodeId nodeId,
                         ControlMetricType type,
                         Optional<org.onosproject.net.DeviceId> deviceId)

Obtain the control plane load of a specific device.

Parameters:

nodeId - node id NodeId

type - control metric type

deviceId - device id DeviceId

Returns:

control plane load

getLoad

ControlPlaneLoad getLoad(org.onosproject.cluster.NodeId nodeId,
                         ControlMetricType type,
                         Optional<org.onosproject.net.DeviceId> deviceId,
                         int duration,
                         TimeUnit unit)

Obtain the control plane load of a specific device with a specific time duration.

Parameters:

nodeId - node id NodeId

type - control metric type

duration - time duration

unit - time unit

deviceId - device id Device

Returns:

control plane load