community 
The purpose of the document is clarifying the logical structure of the IXN2X Log.
The IXN2X Log Documents the command transportation between the Traffic Generator and our TestShell drivers. The commands are of various origins, could be the Traffic Generator’s, the designer’s or native commands of the OS.
The IXN2X Log is a continuous log constructed of following increments. It will open with a headline which specifies the components of each line in the log (refer to Figure 1)
The Headline:
Figure 1 - IXN2X log headline structure
Head line components:
- ClientTime. The specification of the time at which the action took place. Could be used to deduct the tome interval between actions and the time of occurrence.
- msgCode. The code which was defined in the log code for a certain action.
- msgHeader. Defines the actions performed in the line and who performed it. For example:
- Execution of a Traffic Generator command.
- Execution of a TCL command.
- Traffic Generator is loading application program interface package.
- cmdTitle. Reference to the cmd action for analytical purpose.
- execProc. Description of execution procedure (as elaborated in Figure 3).
- msgBody. The description of the action taking place. For example: “ExecTclCmd” stands for execution of TCL command.
- State. The actual command statement of the issuing program (TCL etc.).
Notice that components 5 to 7 are the most important and the meaningful.
An example of the actual structure can be seen in Figure 2.
Figure 2 – Two examples of IXN2X log headline structure, argument and return code
The log consist of two types of lines: The Command line (args) which stands for “arguments” and the response line (rc) which stands for “returncode”. In the log each line can be distinguished by the argument in parentheses (Figure 3)
Figure 3 - Line type identifier
Rarely a command line will not be followed by a return code. These occurrences are not supposed to happen, it will not topple the program or equipment but it can detect something is not quite right.
Increment title paragraph
The title paragraph follows the headline of each increment. It will present details of the directories, paths, drivers, versions, packages etc. An example is presented in Figure 4.
Figure 4 - Title paragraph example
Recommendation:as mentioned before, the log is a collection of following increments. In order to analyze an error which can be reproduced, it would be best to open the log and clear its content (Ctrl A + Del + Save). That way it is easier to observe the log and locate the relevant sessions.
Log file body
The text which follows the title paragraph. The text inside the red boundary in Figure 5.
Figure 5 - Typical increment of IXN2X log
These log lines are structured as explained in the headline section. In Figure 6, a sample of a return code output is presented.
Figure 6 -ReturnCode sample
Summary
This document describes the structure of the IXN2X log file. The main components of the log arethe headline,the title paragraphand the rest isthe registry of data transformation. The document purpose is to direct the log observer to sort the meaningful details the log has to offer.
Contributors
