Diagnostic Reporting Tool
Introduction
The Diagnostic Reporting Tool (DRT) is used to collect diagnostic information used by engineers to investigate problems. The DRT provides an interface to configure and generate a report containing the appropriate data.
Depending on the configuration, the report may include data collected from the OLT and EMS. Data collection using the DRT is not service affecting and may be performed outside of a maintenance window.
The data collected is bundled into a report file and saved to a specified location. This file can then be sent to Tellabs for analysis.
Document Number
ENG-010678
Applies to
The DRT is available for Panorama PON Manager starting with version 31.0. DRT support is provided for all OLTs running software releases SR31.0 and later.
Running the DRT
Procedure Overview
The following procedure is used to configure and generate a diagnostic report using the DRT. Each step in the procedure is explained further in subsequent sections of this app note.
- Launch the DRT
- Fill in the Headline and Detailed Problem Description
- Customize the Report
- Select the OLTs to be included in the report
- Select the equipment, for each OLT, to be included in the report
- Select the report categories
- Specify the report options
- Specify where to save the report
- Generate the Report
Launch the DRT
To launch the DRT select Help » Send Diagnostic Report, from the main menu.
The DRT dialog window will display. This dialog allows you to specify the OLTs, equipment, report categories, and other customizations for the diagnostic report. When launched, the DRT dialog window appears as follows:
Headline and Problem Description
The Headline and Detailed Problem Description fields are used to provide contextual information to the engineer analyzing the report. This information is written into a summary file bundled in the report. These are required fields.
The Headline should be a summary title that includes the customer name and site. The Detailed Problem Description should be a detailed description of the problem. It can include notes from the investigating TAC agent as well as relevant TAC case notes. The point of this information is to provide the engineer with context for analysis of the report.
Customize the Report
The DRT provides a configuration interface for report customization. The configuration allows control over the OLTs, equipment and data to be included in a report. Information can be collected from both the OLT and the EMS. The report configuration can effect the time needed to generate the report. To configure a report, it is important to understand the problem being investigated, the time constraints, the OLTs and equipment involved, and the type of data required. Tellabs TAC can provide configuration guidance for specific cases.
Select OLTs
The Select OLTs pane allows the user to specify the OLTs to be included in the report. More than one OLT can be selected.
To include an OLT in the report, select the OLT name from the Available OLTs list box and click the > button. The OLT will be moved to the Selected OLTs list box.
To remove an OLT from the report, select the OLT name in the Selected OLTs list box and click the < button. The OLT will be moved back to the Available OLTs list box.
You can use the shift key to select multiple OLTs to move from either pick list.
Select Equipment
For each OLT selected, the DRT dialog will display a panel to specify the equipment to include in the report.
To include a piece of equipment in the report, select the name in the Available Equipment list and click the > button. The equipment will be moved to the Selected Equipment list box. To remove a piece of equipment from the report, select the name in the Selected Equipment list box and click the < button. The equipment should be moved back to the Available Equipment list box. You can use the shift key to select multiple pieces of equipment to move from either list box.
If you do not select any equipment for an OLT, only the EMS data for that OLT will be included in the report. The OLT data, which includes logs and status, is often crucial in diagnosis. For this reason, it is important to understand the problem being investigated and what equipment is involved. Tellabs TAC can provide guidance on this decision.
Select Categories
Once a piece of equipment for an OLT is selected, the DRT dialog will display a panel to specify the report categories to collect. The categories specify the type of data to collect from the OLT for the report. The categories selected apply to all OLTs and equipment included in the report.
To include a category in the report, select it in the Available Categories list box and click the > button. The category will be moved to the Selected Categories list box. To remove a category from the report, select it in the Selected Categories list box and click the < button. The equipment will be moved back to the Available Categories list box. The user can use the shift key to select multiple categories to move from either list.
Specify Report Options
The DRT provides several configuration options that allow further customization of the report. These options are listed in the options pane.
- Bypass EMS Log Collection - Omit logs from the EMS in the report. EMS logs are persistent and can be collected later when constrained by time.
- Bypass OLT Backup Collection - Omit the XML backup file when generating the report. The XML backup file stores the complete configuration for the OLT. This file is persistent and will survive most recovery actions. It can be collected later when constrained by time.
- Mask IP Address in the collected files - This option is a security feature that masks any IP addresses in the report. Any IP addresses will appear as xxx.xxx.xxx.xxx.
Check the appropriate boxes as desired.
Specify Where to Save the Report
To specify the location to save the report, click the Save As... button, navigate to the desired location and specify the file name. The report is generated as a zipped tarball (.tgz) file.
The default location is relative to the Panorama installation directory (<INSTALL_PATH>/Tellabs/PanoramaPON_<VERSION>/bbmgr/client/data). You can use the default location or specify something more convenient if desired.
Generate the Report
To generate the report, click the Generate button at the bottom of the dialog window. Data collection will then begin, and the status will be shown in the Status field. On completion, the Status field will display the location of the report file. This file can then be submitted to Tellabs for review.
Staged Report Generation
When network operation is affected, the time required to restore impacted service is critical. However, it is precisely during this time that diagnostic data should be collected. To minimize the duration of gathering diagnostic data, a staged approach can be used.
Much of the diagnostic information collected by the DRT is persistent and will survive remediation efforts. Although this data is important to understanding the root cause, it can be collected once service is restored.
To gather transient data that might be lost during recovery efforts, first produce a report that is configured as follows:
- Only impacted OLTs are selected
- Only impacted Equipment is selected
- Only the "Retrieve OLT Status" category is selected
- The "Bypass EMS Log Collection" option is selected
- The "Bypass OLT Backup Collection" option is selected
To customize the report for such situations, a determination needs to be made regarding the OLT and equipment experiencing a problem. This decision often requires the advice of a Tellabs TAC agent.
Once service is restored, a second report can be generated to collect the logs and EMS data omitted from the first report. Both reports can then be submitted to Tellabs for review.