◄
►

Orchestrator Diagnostics

The Orchestrator Diagnostics bundle is a collection of diagnostic information to troubleshoot the Orchestrator. For Orchestrator on-prem installation, Operators can collect the Orchestrator Diagnostic bundle from the Orchestrator UI and provide it to the Arista Support team for offline analysis and troubleshooting.

In the Operator portal, navigate to Orchestrator > System Properties , and then set the System property session.options.enableBastionOrchestrator to True to view the Diagnostics tab.
Figure 1. Diagnostic Tab
The following are the options available to troubleshoot Orchestrator Diagnostics:
  • Diagnostic Bundles: Request and download a diagnostic bundle.
  • Database Statistics: Provides read-only access view of some of the information from a diagnostic bundle.

Diagnostic Bundles

To access the diagnostic bundles perform the following steps:
  1. In Operator portal, select the Orchestrator tab.
  2. In the left navigation pane, select Diagnostics. The Diagnostic Bundles page appears with the existing diagnostic bundles.
    Figure 2. Diagnostic Bundles

    The Orchestrator Diagnostics table grid includes the following information:

    Table 1. Orchestrator Diagnostics Field Descriptions
    Field Description
    Request Status The following are the request status:
    • Complete
    • In Progress

    If a bundle has not completed the download, the In Progress status appears.
    Reason for Generation The specific reason given for generating a diagnostic bundle. Select the Request Diagnostic Bundle button to include a description of the bundle.
    User The individual logged into the SD-WAN Orchestrator.
    Generated The date and time when the diagnostic bundle request was sent.
    Update Cleanup Date The default Cleanup Date is three months after the generated date, when the bundle will be automatically deleted. If you wish to extend the cleanup date, then select the bundle and then select this option to make the required changes. For more information, see the Update Cleanup Date section below.

Requesting Diagnostic Bundle

To generate a new Diagnostic bundle perform the following steps:
  1. Orchestrator Diagnostics Request Diagnostic Bundle.
  2. In the Request Diagnostic Bundle dialog, enter the reason for generation.
    Figure 3. Request Diagnostic Bundle
    Table 2. Request Diagnostic Bundle Field Descriptions
    Field Description
    Reason for Generation Optionally, you can enter your reason for generating the bundle.
  3. Select Submit.

    The Diagnostic Bundles page displays the details of the bundle being generated, along with the status.

    To search a specific diagnostic bundle, enter a relevant search text in the Search box. For advanced search, select the filter icon next to the Search box to filter the results by specific criteria.

Downloading a Diagnostic Bundle

You can download the generated Diagnostic bundles to troubleshoot an Orchestrator.

To download a generated bundle, select the required check box in the Request Status column and select Download Bundle. The bundle is downloaded as a ZIP file.

You can send the downloaded bundle to a VMware Support representative for debugging the data.

Update Cleanup Date

The completed bundles get deleted automatically on the date displayed in the column called Cleanup Date.

  1. To update the cleanup date of a generated bundle, select the required check box in the Request Status column and select Update Cleanup Date.
  2. In the Update Cleanup Date pop-up window, choose the date on which the selected bundles should be deleted and select Update.
    Figure 4. Update Cleanup Date
  3. Select the Keep Forever check box to retain the bundle, so that the bundle does not get deleted automatically.
    The Orchestrator Diagnostics table grid updates to reflect the changes to the Cleanup Date.

Deleting a Diagnostic Bundle

To delete a bundle manually, select the required check box in the Request Status column and select Delete.

Database Statistics

The Database Statistics tab provides read-only access view of the information from a diagnostic bundle. To view it, select Database Statistics option available at the top of the window.

If you require additional information, go to the Diagnostic Bundles tab, request a diagnostic bundle, and download it locally.

The Database Statistics tab displays the following information:
Figure 5. Database Statistics - Example 1
Figure 6. Database Statistics - Example 2
Figure 7. Database Statistics - Example 3
Table 3. Database Statistics
Field Description
Database Sizes Sizes of the Orchestrator databases.
Database Table Statistics Statistical details of all tables in the Orchestrator database.
Database Storage Info Storage details of the mounted locations.
Database Process List The top 20 records of long-running SQL queries.
Database Status Variable The status variables of the MySQL server
Database System Variable System variables of the MySQL server.
Database Engine Status The InnoDB engine status of the MySQL server.