8. Debug an AML-IP network with the AML Dashboard

8.1. Background

The AML Dashboard is a web-based tool that allows users to interact with the AML framework.

This tutorial showcases the debugging process of an AML-IP network using the AML Dashboard.

../../_images/debugger_dashboard.png

8.2. Prerequisites

Ensure you have installed the AML Dashboard using one of the following methods:

For more information, check the AML Dashboard Interfaces and AML Dashboard Usage sections.

8.3. Running the demo

To run the necessary components for debugging an AML-IP network using the AML Dashboard, follow these steps:

8.3.1. Start the backend server

  1. Navigate to the backend directory.

cd backend
  1. Load the AML-IP environment.

source /AML-IP/install/setup.bash
  1. Start the server:

python3 server.py

8.3.2. Start the AML Dashboard

  1. Navigate to the frontend/aml_dashboard directory.

cd frontend/aml_dashboard
  1. Start the AML Dashboard:

npm run dev
  1. Access the dashboard at http://localhost:5173/.

8.4. Debugging the AML-IP network

To debug an AML-IP network:

  1. Navigate to the Status tab on the AML Dashboard.

The Status tab provides a detailed overview of all active nodes within the AML-IP network, automatically refreshing every second to offer real-time updates.

In this tab, you can confirm whether all expected nodes are properly connected and operating as intended.

If the table shows no nodes, this typically indicates that the backend server or the individual nodes have not been correctly initialized. Ensure that you have followed the setup instructions provided earlier.

By default, the backend server starts with the following three nodes:

If no modifications have been made, these three nodes should be visible in the table once the backend is running.