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.

The top section displays the lab status (running or not running), the lab name, the interface version, and the available disk space. If the lab encountered errors during startup, a warning banner appears with a View start logs button that lets you inspect the error details. You also have access to the following actions:

• Synchronize lab: This option forces the synchronization of users and projects based on the lab configuration in the space.
• 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: View the system configuration, including installed packages.

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.
• Generate technical documentation: This option generates technical documentation for the bricks 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 functionality if you understand what you're 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 allows you to check the resource usage of your lab. At the top, the Global section displays the current system information: free disk space, lab disk space, number of processes, total RAM, and GPU RAM (if a GPU is available). Below, the Details section shows usage charts for CPU, RAM, disk, and swap over a selected time period. You can choose from the following periods: Current day, Last hour, Last 12 hours, Last 24 hours, or Custom. When you select Custom, date pickers appear to let you define a specific range.

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 tab contains additional management tools for share links, bricks data, and apps.

Share links

The share links section displays all existing share links in your lab. Share links are generated when you share lab objects with external users. From this section, you can view the details of each share link, update its validity, or delete it.

To clean up outdated links, click on Clean share links. A dialog appears with two options: Delete expired share links and Delete invalid share links (links whose shared object has been deleted). Both options are enabled by default.

Bricks data

The bricks data section displays a list of external files and folders downloaded by tasks. A task may download external files it needs to run, such as a database required 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.

Apps

The apps section lets you monitor and manage the applications running in your lab. For each running app, the following information is displayed:

• App status (RUNNING, STOPPED, or STARTING)
• The user who started the app and the start time
• Number of browser connections
• Config path and app details (app type, input resources, environment information)

You can stop an individual app by clicking Stop app, or stop all apps at once using Stop all app. Stopped apps are automatically restarted when requested. You can also click View app to navigate to the app resource, or View logs to inspect the app logs for a specific time period.

The Nginx menu provides options to download the Nginx configuration file, access log, and error log.