# Monitoring

This document describes the built-in monitoring and observability component that is part of <code class="expression">space.vars.product\_name</code>. <code class="expression">space.vars.product\_name</code> uses open source [Prometheus, Alert Manager, and Grafana](https://prometheus.io/) as the key components of it's monitoring stack behind the scenes. The <code class="expression">space.vars.product\_acronym</code> monitoring system is designed to collect infrastructure & application metrics using Prometheus exporters for various <code class="expression">space.vars.product\_acronym</code> components and services. <code class="expression">space.vars.product\_acronym</code> administrators can then leverage these metrics in a variety of ways:

* Metrics visibility via built-in charts in the <code class="expression">space.vars.product\_acronym</code> UI (coming soon)
* Default dashboards provided as part of Grafana
* Metrics that the administrators can consume to feed into their own internal monitoring platforms

## Monitoring Architecture

The <code class="expression">space.vars.product\_name</code> monitoring system leverages three primary components:

1. **Prometheus**: An open-source systems monitoring and alerting toolkit that collects and stores metrics as time-series data.
2. **Alert Manager**: Handles alerts sent by the Prometheus server, including deduplicating, grouping, and routing alerts to the correct receiver.
3. **Grafana**: A multi-platform open-source analytics and interactive visualization web application that provides charts, graphs, and alerts when connected to supported data sources.

## Monitored Metrics

The <code class="expression">space.vars.product\_name</code> monitoring system tracks metrics across various categories, focusing on hypervisor health and virtual machine performance.

### Hypervisor Metrics

Hypervisor metrics provide insight into the health and performance of the <code class="expression">space.vars.product\_name</code> hosts. Following metrics are tracked today:

* **Hypervisor CPU Total**: The total CPU resources allocated to the Hypervisor
* **Hypervisor Memory Total**: The total memory allocated to the Hypervisor
* **Hypervisor CPU Usage**: The actual CPU utilization of the Hypervisor, showing host resource consumption
* **Hypervisor Memory Usage**: The actual memory utilization of the Hypervisor, showing hosts memory consumption

### Virtual Machine Metrics

Virtual machine metrics provide visibility into individual VM performance. Following metrics are tracked today:

* **VM CPU Total**: The total CPU resources allocated to the virtual machine
* **VM Memory Total**: The total memory allocated to the virtual machine
* **VM CPU Usage**: The actual CPU utilization of the virtual machine, showing how much of the allocated resources are being consumed
* **VM Memory Usage**: The actual memory utilization of the virtual machine, showing how much of the allocated memory is being consumed

## Dashboards

The <code class="expression">space.vars.product\_name</code> monitoring system comes with pre-configured dashboards designed to provide immediate visibility into key performance indicators:

1. **Hypervisor Dashboard**: Provides comprehensive metrics and visualizations of hypervisor performance. This dashboard helps identify resource utilization patterns, potential bottlenecks, and capacity planning opportunities at the hypervisor level.
2. **VM Dashboard**: Displays detailed metrics about virtual machine performance. This dashboard helps monitor and troubleshoot individual VM resource utilization, enabling proactive management of VM resources.

You can access the built-in Grafana dashboard by following the Grafana link from the <code class="expression">space.vars.product\_acronym</code> UI home screen. Default login credentials are: Username: `admin`Password: `admin` Upon first login, you will be prompted to change the default password for security purposes.

## Custom Dashboard Creation

You can create custom Grafana dashboards tailored to your specific monitoring needs.

To create a custom dashboard:

1. Log in to the Grafana interface through the <code class="expression">space.vars.product\_name</code> UI
2. Navigate to the Dashboard section
3. Click "New Dashboard"
4. Add panels by selecting "Add Panel."
5. Choose visualization types and configure data sources
6. Save the dashboard with a descriptive name


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform9.com/private-cloud-director/2025.4/virtualized-clusters/monitoring.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.