#Perses Monitoring Dashboards

#Function Overview

Perses monitoring dashboards are introduced in Alauda Container Platform 4.4 as a new dashboard capability based on the open source Perses rendering engine. You can view built-in dashboards, create custom dashboards, import dashboard JSON, and manage metric panels for clusters.

Perses monitoring dashboards coexist with the existing Monitoring Dashboards capability. The existing MonitorDashboard entry and resources remain available. You can migrate existing MonitorDashboard resources to PersesDashboard resources when you want to render them in the Perses dashboard entry. For more information, see Migrate MonitorDashboard to Perses.

The first phase focuses on metric dashboards:

• Common metric chart types are supported.
• The platform metric data source is fixed and is not exposed in the UI.
• Logs, traces, and profiling visualizations are not supported in this phase.

#Prerequisites

Before using Perses monitoring dashboards, install the following components:

For installation instructions, see Installation. If the selected cluster has not installed Alauda Container Platform Dashboard for Perses, the Perses dashboard page shows an installation guide instead of a dashboard list.

#Access Perses Dashboards

1. Log in to the container platform management view.
2. In the left navigation bar, go to Operations Center > Monitor > Dashboards (Perses).
3. Use the Cluster selector at the top of the page to select the cluster whose dashboards you want to view.

#View Dashboards

#Dashboard List

The dashboard list shows the Perses dashboards that you can access in the selected cluster.

#Dashboard View

Click a dashboard name to open the dashboard view.

In the dashboard view, you can:

• View panels organized by panel groups.
• Use dashboard variables to filter panel data.
• Select a time range and refresh interval.
• Download dashboard data when the dashboard supports it.
• Click {} to open Dashboard JSON in read-only mode.
• Open Query Viewer from a panel to view the PromQL query, legend, and minimum step in read-only mode.

The query viewer does not display data source information because the platform metric data source is fixed.

For built-in dashboards, Edit and Settings are disabled in the dashboard view.

#Create and Edit Dashboards

#Create a Dashboard

1. On the Perses dashboard list page, click Create.

2. Configure the dashboard information.

   Field	Required	Description
   Name	Yes	Dashboard display name.
   Description	No	Dashboard description.
   Folder	Yes	Folder used to organize dashboards.
   Tags	No	Tags used to organize and search dashboards.

3. Confirm the creation. The platform opens the dashboard editor.

The resource name is generated by the backend. You only need to provide the dashboard display name in the UI.

#Use the Dashboard Editor

The dashboard editor provides the following main actions:

#Add a Panel

1. In the dashboard editor, click Add Panel.

2. In the Add Panel drawer, configure the panel name, group, description, and chart type.

3. Configure queries on the Query tab.

   Field	Description
   Query language	Use native PromQL. Metric names and labels support auto-completion.
   Query Type	Use ACP Courier Query for range queries and ACP Courier Instant Query for instant queries. Instant queries are commonly used by Bar, Gauge, and Stat panels for current-value views.
   Add Query	Add multiple queries to one panel.

4. Configure other tabs as needed, such as General Settings, Query Settings, Links, and JSON.

5. Check the preview and save the panel.

The query area uses the platform metric data source automatically and does not show a data source selector.

#Add Variables

Use Variables in the editor to add dashboard variables.

#Edit Dashboard JSON

In edit mode, click {} to open Edit Dashboard JSON. You can edit the dashboard definition directly.

#Chart Types

Perses monitoring dashboards support the following metric chart types in this phase:

Logs, traces, and profiling charts are not supported in this phase.

#Import Dashboards

1. On the dashboard list page, open the Create drop-down menu and select Import dashboard.

2. Configure the import information.

   Field	Required	Description
   Name	Yes	Dashboard display name.
   Description	No	Dashboard description.
   Folder	Yes	Folder used to organize the dashboard.
   Dashboard JSON	Yes	Perses or Grafana dashboard JSON. You can upload a file or paste JSON content.

3. Confirm the import.

Perses JSON can be imported directly. Grafana JSON is converted to the Perses model during import. This conversion is lossy and preserves only the chart types and functions supported by the current version.

#Manage Dashboards

#Troubleshooting

#The page shows an installation guide instead of dashboards

The selected cluster has not installed Alauda Container Platform Dashboard for Perses. Install the component in that cluster and open Dashboards (Perses) again.

#A dashboard has no data

Check the following items:

• Alauda Container Platform Dashboard Essentials is installed and running in the global cluster.
• Monitoring data collection and storage are working in the selected cluster.
• The current user has permission to query metrics for the target cluster, namespace, or project.

#Some built-in dashboards show resource names such as xxx-pd

Some migrated built-in dashboards may show the Kubernetes resource name instead of the display name when the source dashboard does not contain the cpaas.io/display-name annotation. This does not affect dashboard rendering or metric queries.

#Related Operations

• Migrate MonitorDashboard to Perses
• Installation
• Monitoring Dashboards