gws_academy

The monitoring page allows you to access technical information and monitor your lab. To access it, click on Settings > Monitoring. 

Dashboard

The Dashboard page provides you with general information about your lab and details about the installed bricks.

In the top section, you can see the current status of your lab, including the lab name and the interface version. The available disk space is also displayed.

Note: If the lab encountered errors during startup, a warning banner appears at the top. Click View start logs to review the error details.

Below the lab status, you will find several action buttons:

• Synchronize lab: Opens a dialog where you can choose what to synchronize. You can enable or disable the synchronization of users, folders, scenarios, and notes using the provided checkboxes.
• Clean unused data: This is useful for freeing up disk space. It removes temporary files and resources that were not properly deleted (shadow resources).
• Delete unavailable typings: This removes process and resource types that no longer exist due to a brick update.
• System configuration: Opens a dialog displaying the current system configuration of the lab.

In the brick section, you can find specific information about each installed brick:

• Name, version, and status of the brick, along with additional data in the expanded section (repository type, commit, brick path, and parent brick).
• Generate technical doc: This option generates technical documentation for the brick to be uploaded to the community.
• Call migration manually: Use this option to manually trigger a brick migration to a specific version. Only use this if you understand what you are doing.
• Delete unavailable typings: This removes process and resource types from this brick that no longer exist due to a brick update.

Monitoring

The Monitoring page enables you to check the current resource usage of your lab. It is divided into two sections: a global overview and a detailed view with customizable time periods.

Global

The global section displays the current state of your lab's resources:

• Disk space: A visual indicator of the available disk space, along with the used, total, and available disk space values.
• Number of processes: The number of CPU processes available on the server.
• Total RAM: The total amount of memory available on the server.
• GPU RAM total: The total GPU memory available, displayed only if the server has a GPU.

Details

The details section shows monitoring charts for CPU, RAM, SWAP, disk, network, and GPU usage over a selected time period. Use the Period dropdown to choose the time range:

• Current day: From the start of today until now (default).
• Last hour: The last 60 minutes.
• Last 12 hours: The last 12 hours.
• Last 24 hours: The last 24 hours.
• Custom: Select a custom date range using the From and To date pickers.

Virtual environments

The virtual environments page allows you to manage the installed virtual environments in the lab.

For each environment, you can:

• View detailed information about the environment, such as its location on the server, size, and the configuration file used to generate it.
• Delete the environment to free up space or because there was an issue during environment installation. Deleting a virtual environment is safe, as it can be reinstalled if necessary.

You also have the option to delete all virtual environments to free up space. The virtual environments will be reinstalled when needed, but this process may take a few minutes depending on the specific environment.

Logs

The logs page provides access to the server logs of the lab. A new log file is created for each day.

For each log file, you have the following options:

• View logs: Open the logs directly in the browser. However, it is not recommended for log files larger than 1MB.
• Download file: Download the log file to your computer for further investigation or analysis.

Credentials

The credentials page allows you to view and manage credentials stored in your lab. This is a secure location for storing credentials required by the lab for external communication. Some tasks, such as the Send resource to S3 bucket, require credentials as part of their configuration. When using credentials in a task, only the name of the credentials is stored, ensuring safety when sharing.

To create credentials, follow these steps:

1. Click on the Create credentials button.
2. Provide a unique name for your credentials.
3. Set the type of credentials.
4. Optionally provide a description.
5. Fill in the credentials data based on the selected type. If you choose the Other type, you need to provide key/value pairs for the credentials. The key allows the task to retrieve the correct information when accessing the credentials.
6. Click on Save to create the credentials.

For each set of credentials, you can:

• Update credentials: This requires you to enter your username/password again. It allows you to view and modify the credentials data.
• Delete credentials: This action permanently deletes the credentials. If any tasks were using those credentials, they will no longer function.

Activities

The activities section allows you to monitor user activities in the lab. Various actions are logged, including login events, experiment creation, execution, and deletion, report creation and deletion, object validation, and archiving, among others.

You can utilize the search functionality to filter and narrow down the displayed activities based on your specific requirements or areas of interest. This enables you to efficiently track and review user actions within the lab environment.

Other

The Other page groups additional management tools: share links, bricks data, and running applications.

Share links

The share links section allows you to monitor all the existing share links of your lab. It displays the share links for various lab objects, showing the object type, name, validity date, and creation date. From this section, you can directly manage the share links by updating their validity or deleting them as needed.

Click Clean share links to open a dialog where you can choose to delete expired share links and/or invalid share links (links where the shared object has been deleted).

Bricks data

The bricks data section displays a list of external files and folders downloaded by tasks. A task may download an external file if it requires it to run, such as a database needed for analysis.

From this section, you can view and delete individual brick data entries. You can also click Delete all brick data to remove all downloaded files at once, freeing up disk space.

Apps

The apps section shows the status of all currently running applications in your lab. Each running app is displayed as a separate card with the following information:

• App status: The current state of the app (Running, Stopped, or Starting).
• Started: The user who started the app and the date it was started.
• Number of browser connections: How many active browser connections are currently open.
• Config path: The path to the configuration file used by the app.
• App type, input resources, and environment details.

For each app, you can:

• Stop app: Stop an individual running app. The app will automatically restart when requested.
• View app: Navigate to the app resource to view it.
• View logs: Open the app's logs.

At the top of the section, you can click Stop all app to stop all running applications at once. You can also access Nginx server files through the Nginx menu: download the Nginx configuration, access log, or error log.