Skip to main content

Monitor a workspace

Follow the metrics of the services in your workspace on a monitoring dashboard. Connect the workspace to the Monitoring Workspace, then import the dashboard template.

Prerequisites​

  • Permission to view the Monitoring tab of the workspace. Without it, the tab shows "You do not have sufficient permissions to view this page!".
  • The dashboard template of the service you want to monitor. See Download a dashboard template.

Connect the workspace to monitoring​

  1. Select Data platform → Workspace management, then select your workspace.
  2. Select the Monitoring tab.
  3. Check the Monitoring Workspace details in the table.
  4. In the Action column, select Integrate.

The portal connects the workspace to the Monitoring Workspace.

Monitoring tab of a workspace with the Monitoring Workspace table, an Active datasource, and Integrated status Enabled

ColumnDescription
IDThe ID of the Monitoring Workspace.
Workspace nameThe name of the Monitoring Workspace.
URLThe link to the monitoring dashboard.
Datasource typeThe datasource type, Metric.
Datasource statusActivating, Active, Active Failed, Inactive, or Deactivate Failed.
Integrated statusEnabled or Disabled.
ActionIntegrate connects the workspace. After the connection, the button changes to Disconnect.

A connected workspace shows Active in Datasource status, Enabled in Integrated status, and Disconnect in the Action column.

note

After you select Disconnect, the workspace stops sending monitoring data to the Monitoring Workspace.

Open the monitoring dashboard​

Open the dashboard after the workspace is connected.

  1. Select Data platform → Workspace management, then select your workspace.
  2. Select the Monitoring tab.
  3. Select the link in the URL column.

The monitoring dashboard opens in a new browser tab.

Download a dashboard template​

Each service has its own dashboard template, a JSON file. Download the template of each service you want to monitor.

ServiceTemplate
Orchestration (Airflow)airflow-dashboard.json
CDC Servicecdc-dashboard.json
Flinkflink-dashboard.json
Query Engine (Trino)trino-dashboard.json

Import the dashboard template​

Import the template to get a dashboard for the workspace's services. Do these steps in the monitoring dashboard.

  1. In the left menu, select Dashboards.
  2. Select New → New folder.
  3. Enter a folder name, for example Workspace Monitoring, then select Create.
  4. Open the new folder, then select New → Import.
  5. On the Import Dashboard screen, select Upload JSON file, then choose the template file you downloaded. You can also drag the file onto the screen.
  6. Select Load.
  7. Check the dashboard Name, UID, and Folder.
  8. Select Import.

The dashboard is created and shows the metrics of the service. Use the lists at the top of the dashboard, such as Workspace, to choose what it shows.

Next steps​