[OPNFLWPLUG-644] Audit data collection for various events of OpenFlow plugin. Created: 17/Mar/16  Updated: 27/Sep/21  Resolved: 12/Jul/19

Status: Resolved
Project: OpenFlowPlugin
Component/s: General
Affects Version/s: None
Fix Version/s: Neon, Sodium

Type: Improvement Priority: Medium
Reporter: Kamal Rameshan Assignee: Somashekhar Javalagi
Resolution: Done Votes: 0
Labels: neon-release
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All

Attachments: Text File log_configuration.txt    

 Description   

In a real prod environment its imperative to extract an audit trail of connection and disconnection events. Other events might also be important.

Some options to consider are

1. Have a keyword in the logs to identify its a connection event.
2. Put JMX metrics for this events (keeping a history will be difficult here)
3. Store these events in Datastore - this might be an overkill, and there are other better systems than our in-mem datastore for this purpose.

For now option 1 seems to be a low hanging fruit, for now.

 Comments   
Comment by Jozef Bacigal [ 20/Jun/17 ]

Connection and disconnections statistics is possible to get through SessionStatistics (karaf console command show-session-stats). In all logs on the DEBUG level is used alwas the same pattern to identify device as "Device:'device name'". Session statistics or MessageSpy, can be enhanced. But need to know what information are needed. MessageSpy is also available in karaf console and in LOG by using DEBUG.

Comment by Anil Vishnoi [ 12/Dec/17 ]

This story is a good enhancement for the plugin, but it requires more grooming on what can be improved here and how to expose these statistics data.

Comment by Anil Vishnoi [ 10/Sep/18 ]

Arunprakash Can you please update the ticket with the details?

Comment by Somashekhar Javalagi [ 11/Sep/18 ]
  1. Planning to define logger with a specified name (Ex: OfEventLogger) for openflowplugin, so that we can use this logger to log openflowplugin important events.
  2. We can develop a script which will modify karaf log configuration file(etc/org.ops4j.pax.logging.cfg) for configuring logger and appender for this.
  3. This script should make sure that these event logs are written into a separate file (ex: data\events\openflow), so that main events can be referred here.
  4. These main events can be following:
    (1) Openflow device connection/disconnection
    (2) OF Resync Start/Finish
    (3) Flow Count after Reconciliation
    (4) Node connector addition/deletion
    (5) Master Role Acquisition, etc

 

Comment by Somashekhar Javalagi [ 23/Oct/18 ]

Main events of openflowplugin can be logged using a separate common logger, which will be using log4j logging framework. This can be configured as a log appender in etc/org.ops4j.pax.logging file, through which we can redirect main openflowplugin event logs to a separate file. This can be helpful in debugging the problems with different phases of device connection to the SDN controller. The log appender can be configured as below in log_configuration.txt

 

 

Generated at Wed Feb 07 20:33:00 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.