# Cluster Monitoring

## Overview

VESSL Clusters comes with a built-in **cluster dashboard** that provides a visualization of cluster usage and status down to each node and workload. This is enabled by the **VESSL Cluster Agent** which sends real-time information about the clusters and workloads running on the cluster such as node specifications and model metrics.

Dashboard setup is done automatically as you integrate your cloud or on-prem servers using `vessl cluster create` command.

{% hint style="info" %}
Users on the Enterprise can use VESSL's custom cluster agent to route the monitoring information to your monitoring tools like Datadog and Grafana.

Contact us at [support@vessl.ai](https://vessl.ai/talk-to-sales) or through our [community Slack](https://join.slack.com/t/vessl-ai-community/shared_invite/zt-1a6schu04-NyjRKE0UMli58Z_lthBICA) for more details.
{% endhint %}

## Cluster-level Monitoring

Multi-cluster monitoring of resource usage and ongoing workloads is available under **🗂️ Clusters**. Here, you can get an overview of the integrated clusters.

<figure><img src="https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-4172dfad409612ecaf70ca7759f849045bc38b22%2Fimage%20(5).png?alt=media" alt=""><figcaption></figcaption></figure>

* Cluster status — Connection and incident status of a cluster.
* Available nodes — Available number of worker nodes.
* Real-time resource usage — Real-time resource usage of CPU cores, RAM, and GPUs.
* Ongoing workloads by type — The number of running notebook servers (Workspaces) and training jobs (Experiments).

Clicking the cluster guides you to the **Summary** tab which holds more detailed information about the cluster.

#### (1) Summary

The summary section presents the basic information about the cluster including the connection and incident status.

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-ff489978228cb18e1dfa8cb41d81a8c5db01fe5e%2Fimage%20\(8\).png?alt=media)

#### (2) Quotas & Usage

Quotas & Usage shows the organization-wide and personal resource quota for the cluster, including the number of GPU hours and occupiable GPUs and CPUs. This is set by the organization admin. Refer to our next section in the documentation VESSL Cluster's features on cluster administration.

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-337c656c4858834efa24d1ec389bf9deab39215a%2Fimage%20\(11\).png?alt=media)

#### (3) Resource Statistics

This section shows you how much CPU, GPU, and memory have been requested (and allocated) and are currently being used.

{% hint style="info" %}
Note that when you are using VESSL Workspaces (notebook servers) you may be occupying a node without actively using the resources — you are only actively using the resources only when the cell is running.
{% endhint %}

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-c05dc5d38c83f153d279c1f6860cb89fb055a23d%2Fimage%20\(4\).png?alt=media)

#### (4) Workloads

This section shows all ongoing workloads on the cluster with information on the occupying node, resource consumption, creator, and the created date. If you are an organization admin, clicking the workload name guides you to the detailed workload page under **🗂️ Projects** or **🗂️ Workspaces**.

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-c5a48923eedb2c5a405181690e9770c7d1d34fea%2Fimage%20\(24\).png?alt=media)

## Node-level Monitoring

Under **Nodes**, you can view all the worker nodes tied to the cluster with their real-time CPU, Memory, and GPU usage, ongoing workloads by their type, and incident status. You can select the checkbox to get more in-depth information.

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-7df7996749fdf4704901276a35c48d1e9e1500a9%2Fimage%20\(27\).png?alt=media)

#### (1) Metadata

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-cbfb1648bb69daae3f9db47a09267e2798ed3763%2Fimage%20\(16\).png?alt=media)

#### (2) System metrics

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-aca17c53b93ca2fb2abfce378d21dd068745c4e1%2Fimage%20\(15\).png?alt=media)

#### (3) Workloads

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-8cb30aa807bcaacac0ee03d9daa98b751a5d4531%2Fimage%20\(25\).png?alt=media)

#### (4) Issues

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-065664da7e55c0cdeb083629934d7ae324299524%2Fimage%20\(23\).png?alt=media)

## Workload-level Monitoring

Under **Workloads**, you can view the workload log related to the cluster with the current status, occupying node, resource consumption, and a visualization of the usage history.

![](https://2108357329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpBAp67pQ7cvWPR2lxOZ3%2Fuploads%2Fgit-blob-b6b4a870874d3be7909dc8e5742c73c55a219f14%2Fimage%20\(28\).png?alt=media)

{% hint style="info" %}
If you are on the Enterprise plan and wish to send the cluster information collected by VESSL Cluster Agent to your central infra monitoring tool such as Datadog and Grafana, contact us at [support@vessl.ai](https://vessl.ai/talk-to-sales).
{% endhint %}
