Xena Knowledge Base

Statistics Logging and Reporting


The Statistics Logging and Reporting function lets you periodically poll statistics counters for all ports or streams in a testbed and log those counters to a CSV or XML file. The function also enables generation of reports of most of the logged counters in PDF or HTML format.

IMPORTANT: Reporting requires Xena software release 78 or higher.

Port Scope

The logging function works on all ports in a given testbed. You can enable logging on multiple testbeds at the same time.

Configuration Panel

This function is handled by the Statistics Logging and Reporting panel. This panel is by default shown in the bottom part as one of the “auto-hide” panels.

The panel is shown in the image below.

Logging and Reporting Configuration

The Statistics Logging and Reporting panel provides the following configuration options:

Option Explanation
State and Content
Enable Logging: Selects whether the statistics logging definition is enabled or not. Needs to be selected to enable Reporting.
Counter Types: Pressing this button will enable you to select which counters to include in the log and the report. Please observe that rate counters (e.g. Receive Rate) and Latency and Jitter 1 sec. counters will not be shown in report tables – they may however be included in charts in reports

See below for an overview of selectable counter types (availability depends on test module and selection of Source Resolution for some of the counters).

State Control: This button will either start or stop a logging session.
Elapsed Time: Shows the elapsed time for an active logging session.
Logging Target: Choose between Text File (normal counter logging), No Logging (Reporting may still be activated). Plugin Handler and Custom Handler: For future use.
Poll Interval: Specifies the interval between polls. The default value is 1 second. The minimum value is 1 second.
Log Duration: Specifies the total desired duration of a collection period. You can specify this duration as a number of days + an hour:minute:second option. The total duration could thus for instance be 2 days, 4 hours and 30 minutes.

This option is only valid if the Run Until Stopped option is not selected.

Run Until Stopped: If this option is selected the collection will run until it is manually stopped.
Start/Stop on Global: Start and stop of logging and reporting follows start and stop of the Global Statistics.
Report Properties
Generate Report Check to enable reporting
Report Title Here enter the header of the report
Report File Types Open dialog and click to select PDF and/or HTML reports
Selected Types Shows selected report file type(s)
PDF Page Settings Open this dialog to configure the layout of PDF files. Most settings in this dialog should be self-explanatory. When Outline From Headings is checked the pdf report will include a table of contents in the left side of the report.
Chart Settings Open this dialog to select the counters to be included as charts in the report and configure the layout of the charts.
Counters can be selected individually by clicking Select at Chart Counter Types and then select the counters to be charted in the report. Alternatively Charts Selected For Logging can be checked: Then all counters selected in State and Content/Counter Types will be charted in the report.
Curr. Report Directory Shows directory where most recent report is stored
Open Report Directory Opens the directory where most recent report is stored
Report Information
Company Name: Text entered here will be included in the report
Tester Name Text entered here will be included in the report
Test Description Text entered here will be included in the report
Selected Logo Image Path to uploaded Custom Logo Image or (Xena logo) if no logo has been uploaded. The logo will be included in the report
Custom Logo Image Opens a dialog for upload of the logo that will be included in the report
Clear Logo Image Clears the (Xena logo) to be included in the report
Log File Name and Location
(This section is shown when Logging Target Text File is selected)
File Name Prefix: This string will be used as the prefix for the logging filenames.
Append Timestamp: If selected a timestamp on the form “YYYYMMDD_HHMMSS” will be appended to the filename.
Separate Run Directories: All logfiles will be located under the
\Documents\Xena\XenaManager\PortLog\\ directory.If this option is selected the logfiles for different logging runs will be placed in separate subdirectories under this master directory. The subdirectory name will be a timestamp on the form “YYYYMMDD_HHMMSS”.If the option is not selected all logging files will be placed directly in the directory described above.
File Type: This determines the format of the logfile. You can select between CSV (Comma Separated Value) or XML format.
Curr. Log Directory Shows directory where most recent log file is stored
Open Log Directory Opens the directory where most recent log file is stored
Disk Space Management
Archive Large Files: Selecting this option will make the logging function save the current logfile to an archive file and start a new logfile when the logfile reaches a certain size.

The archive files will be named prefix.archive_no.extension. The archive numbering will be sequential so that the file with the highest number is the most recent archive file. The currently active logfile will still be called prefix.extension.

Archive File Size: The file size where archiving should take place.
Limit Archive File No: If this option is selected the application will limit the number of archive files for a single logging run. This can be used for long-running logging tasks to prevent the harddisk from filling up.
Max. Archive Files: The maximum number of archive files to keep. This option is only valid if the Limit Archive File No option is selected.

Controlling Logging and Reporting State

Starting and Stopping Logging and Reporting

As stated above the State Control button allows you to start or stop the logging and reporting process. While the logging and reporting are in progress it will not be possible to change any configuration parameters. While logging and reporting are in progress the Elapsed Time counter will increment showing the total duration of the process.

Output Formats

CSV File Format

The CSV file will contain a number of lines. Each line will represent all enabled logging data for one port for a single poll. A line will have the following format: Timestamp, Port ID, { CounterValue, }*

Field Explanation
Timestamp The data and time for the logged data line on the form “YYYYMMDD-HHMMSS”.
Port ID The port identification on the form “P-chassismoduleport”,
CounterValue The counter value. All values are expressed as a decimal number.

The file will also contain a header row describing the selected counter types.

XML File Format

The XML file format will be similar to the following example:

 version="1.0" encoding="utf-8"?>

<pollsamples><selectedcountertypes< span=""> Values="TxBps,TxFps,TxBytes,TxFrames,RxBps,RxFps,RxBytes,RxFrames" /></selectedcountertypes<>
  <element< span=""> Timestamp="20130331-174155" Type="Notification" Text="Log initialized" /></element<>
  <element< span=""> Timestamp="20130331-174156" Type="Sample" Port="P-0-10-2" Values="0,0,0,0,0,0,2.91E+06,4.3E+04" /></element<>
  <element< span=""> Timestamp="20130331-174156" Type="Sample" Port="P-0-10-3" Values="0,0,0,0,0,0,1.51E+05,581" /></element<>

All data is kept under a root tag called PollSamples.

The first node is called SelectedCounterTypes. The “Value” attribute describes the selected counter types in comma-separated format.

Each poll sample is represented using the Element node tag and has the “Type” attribute set to “Sample”. The “Values” attribute contains the sample values in the same order as is given by the SelectedCounterTypes tag.

Element nodes with Type = “Notification” represents notification messages.