net.floodlightcontroller.debugcounter

Interface IDebugCounterService

All Superinterfaces:

IFloodlightService

All Known Implementing Classes:

DebugCounterServiceImpl, MockDebugCounterService

public interface IDebugCounterService
extends IFloodlightService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDebugCounterService.MetaData

Method Summary

Modifier and Type	Method and Description
java.util.List<DebugCounterResource>	getAllCounterValues() Get counter values and associated information for all counters in the system
java.util.List<DebugCounterResource>	getCounterHierarchy(java.lang.String moduleName, java.lang.String counterHierarchy) Get counter value and associated information for the specified counterHierarchy.
java.util.List<DebugCounterResource>	getModuleCounterValues(java.lang.String moduleName) Get counter values and associated information for all counters associated with a module.
IDebugCounter	registerCounter(java.lang.String moduleName, java.lang.String counterHierarchy, java.lang.String counterDescription, IDebugCounterService.MetaData... metaData) All modules that wish to have the DebugCounterService count for them, must register their counters by making this call (typically from that module's 'startUp' method).
boolean	registerModule(java.lang.String moduleName) All modules that wish to have the DebugCounterService count for them, must register themselves.
boolean	removeCounterHierarchy(java.lang.String moduleName, java.lang.String counterHierarchy) Removes/deletes the counter hierarchy AND ALL LEVELS BELOW it in the hierarchy.
void	resetAllCounters() Resets the values of all counters in the system.
boolean	resetAllModuleCounters(java.lang.String moduleName) Resets the values of all counters belonging to a module with the given 'moduleName'.
boolean	resetCounterHierarchy(java.lang.String moduleName, java.lang.String counterHierarchy) Resets the value of counters in the hierarchy to zero.

Method Detail

registerModule

boolean registerModule(java.lang.String moduleName)

All modules that wish to have the DebugCounterService count for them, must register themselves. If a module is registered multiple times subsequent registrations will reset all counter in the module.

Parameters:

moduleName -

Returns:

true if the module is registered for the first time, false if the modue was previously registered

registerCounter

IDebugCounter registerCounter(java.lang.String moduleName,
                              java.lang.String counterHierarchy,
                              java.lang.String counterDescription,
                              IDebugCounterService.MetaData... metaData)

All modules that wish to have the DebugCounterService count for them, must register their counters by making this call (typically from that module's 'startUp' method). The counter can then be updated, displayed, reset etc. using the registered moduleName and counterHierarchy.

Parameters:

moduleName - the name of the module which is registering the counter eg. linkdiscovery or controller or switch

counterHierarchy - the hierarchical counter name specifying all the hierarchical levels that come above it. For example: to register a drop counter for packet-ins from a switch, the counterHierarchy can be "00:00:00:00:01:02:03:04/pktin/drops" It is necessary that counters in hierarchical levels above have already been pre-registered - in this example: "00:00:00:00:01:02:03:04/pktin" and "00:00:00:00:01:02:03:04"

counterDescription - a descriptive string that gives more information of what the counter is measuring. For example, "Measures the number of incoming packets seen by this module".

metaData - variable arguments that qualify a counter eg. warn, error etc.

Returns:

IDebugCounter with update methods that can be used to update a counter.

resetCounterHierarchy

boolean resetCounterHierarchy(java.lang.String moduleName,
                              java.lang.String counterHierarchy)

Resets the value of counters in the hierarchy to zero. Note that the reset applies to the level of counter hierarchy specified AND ALL LEVELS BELOW it in the hierarchy. For example: If a hierarchy exists like "00:00:00:00:01:02:03:04/pktin/drops" specifying a reset hierarchy: "00:00:00:00:01:02:03:04" will reset all counters for the switch dpid specified; while specifying a reset hierarchy: ""00:00:00:00:01:02:03:04/pktin" will reset the pktin counter and all levels below it (like drops) for the switch dpid specified.

Returns:

false if the given moduleName, counterHierarchy does not exist

resetAllCounters

void resetAllCounters()

Resets the values of all counters in the system.

resetAllModuleCounters

boolean resetAllModuleCounters(java.lang.String moduleName)

Resets the values of all counters belonging to a module with the given 'moduleName'.

Returns:

false if the given module name does not exists

removeCounterHierarchy

boolean removeCounterHierarchy(java.lang.String moduleName,
                               java.lang.String counterHierarchy)

Removes/deletes the counter hierarchy AND ALL LEVELS BELOW it in the hierarchy. For example: If a hierarchy exists like "00:00:00:00:01:02:03:04/pktin/drops" specifying a remove hierarchy: "00:00:00:00:01:02:03:04" will remove all counters for the switch dpid specified; while specifying a remove hierarchy: ""00:00:00:00:01:02:03:04/pktin" will remove the pktin counter and all levels below it (like drops) for the switch dpid specified.

Returns:

false if the given moduleName, counterHierarchy does not exist

getCounterHierarchy

java.util.List<DebugCounterResource> getCounterHierarchy(java.lang.String moduleName,
                                                         java.lang.String counterHierarchy)

Get counter value and associated information for the specified counterHierarchy. Note that information on the level of counter hierarchy specified AND ALL LEVELS BELOW it in the hierarchy will be returned. For example, if a hierarchy exists like "00:00:00:00:01:02:03:04/pktin/drops", then specifying a counterHierarchy of "00:00:00:00:01:02:03:04/pktin" in the get call will return information on the 'pktin' as well as the 'drops' counters for the switch dpid specified. If the module or hierarchy is not registered, returns an empty list

Returns:

A list of DebugCounterResource or an empty list if the counter could not be found

getAllCounterValues

java.util.List<DebugCounterResource> getAllCounterValues()

Get counter values and associated information for all counters in the system

Returns:

the list of values/info or an empty list

getModuleCounterValues

java.util.List<DebugCounterResource> getModuleCounterValues(java.lang.String moduleName)

Get counter values and associated information for all counters associated with a module. If the module is not registered, returns an empty list

Parameters:

moduleName -

Returns:

the list of values/info or an empty list