Manage performance reports

This topic describes how to use a performance report. A performance report provides you with information about the cluster load, performance, and SQL statements within a specified period of time, and helps you learn the cluster running status and troubleshoot performance-related issues.

You can view and manage performance reports by using the following methods:

• Method 1: Log in to the OceanBase Cloud Platform (OCP) console. In the left-side navigation pane, click OceanBase Autonomy Service . On the page that appears, find the target cluster and click its name to go to the Report Center page.

• Method 2: Log in to the OCP console, go to the Overview page of the target cluster, and click Performance Report on the left side.

Introduction

OCP can generate cluster performance reports. On the Performance Report page, you can view report information in the following columns: Report Name , Snapshot Start Point , Snapshot End Point , Created By , Generation Status , and Generation Time . The Actions column provides the View Report and Download Report options.

• You can sort the reports by Snapshot Start Point , Snapshot End Point , and Generation Time .

• You can filter the reports by Generation Status .

Prerequisites

• To manage the performance reports of a cluster by using Method 1, make sure that you have the following permissions:

  • Resource Permissions : Cluster Read-only permission
  • Permission on the Report Center menu of OceanBase Autonomy Service

• To manage the performance reports of a cluster by using Method 2, make sure that you have the following permissions:

  • Resource Permissions : Cluster Read-only permission
  • Menu Permissions : Permission on the Performance Report menu of Clusters

Procedure

The procedure of Method 1 is described as follows:

1. Log in to the OCP console.

2. In the left-side navigation pane, click OceanBase Autonomy Service .

3. In the Cluster Details section, click the name of the cluster that you want to view. The Real-time Diagnostics page appears.

4. In the left-side navigation pane, click Report Center .

5. Go to the Performance Report tab.

6. Click Generate Performance Report .

7. In the dialog box that appears, set the following parameters.

   Parameter	Description
   Report Name	Required. The name of the report.
   Snapshot Start Point	You can select only a point in time in the past 30 days. The available points in time are fixed and cannot be customized.
   Snapshot End Point	You can select only a point in time within 24 hours after the time you specified for Snapshot Start Point . The available points in time are fixed and cannot be customized.

8. If the SQL monitoring data of a tenant is abnormal in the performance report, select the tenant from the View OceanBase Tenant ASH Report drop-down list to go to the ASH Report page of the tenant.

   

9. Click OK . A report is generated for the performance between the snapshot start point and the snapshot end point. OCP saves performance reports generated in the last 90 days. You can view and download a report in the report list.

   • To view a performance report, click View Report in the Actions column.

   • To download a performance report in the HTML format, click Download Report in the Actions column.

Report content

You can view the following information in a performance report:

• Basic information

  Parameter	Description
  Basic Cluster Information	The cluster version, cluster type, number of hosts, number of tenants, and start time and end time of the last major compaction. Note If the version of OceanBase Database is V4.0 or later, you cannot view information related to major compactions.
  Node Basic Information	The host IP address, zone, availability of RootServer, status, service start time, and last offline time.
  Node Resources	The host IP address, zone, total CPU cores, allocated CPU cores, allocated CPU resources in percentage, total memory in MB, allocated memory in MB, allocated memory in percentage, total disk space in GB, used disk space in GB, and disk usage in percentage.
  Node Partitions	The host IP address, zone, associated tenants, number of partitions, and number of leader partitions. Note that the number of partitions includes the number of leader partitions. Note If the version of OceanBase Database is V4.0 or later, you cannot view partition information about nodes.
  Tenant Resources	The tenant name, tenant ID, tenant type, resource unit configuration, zone priority, locality, and server list.
  Tenant Capacity	The associated tenants, tenant ID, associated hosts, and data capacity.

• Workload Statistics : The table includes the following columns: Metrics , Cumulative Value , Start Value , End Value , Maximum Value , Maximum Value Occurred At , Minimum Value , Minimum Value Occurred At , and Average Value . For more information about monitoring metrics, see Metrics.

• Wait Event Statistics : You can view the information about the top 10 wait events with the longest cumulative wait time of in the cluster and those in the tenant in the following columns: Event Name , Event Category , Total Latency (ms) , Total Delays , and Total Timeouts .

• Routing Statistics : You can view the routing statistics in the tenant in the following columns: Route Hit Rate (%) , Route Hits , and Route Misses .

• SQL Statistics

  Parameter	Description
  SQL Sorted by Total Response Time	Top 30 SQL statements with the longest response time in the cluster. Top 30 SQL statements with the longest response time in the tenant.
  SQL Sorted by CPU Time	Top 30 SQL statements with the longest CPU time in the cluster. Top 30 SQL statements with the longest CPU time in the tenant.
  SQL Sorted by I/O Latency	Top 30 SQL statements with the longest I/O wait time in the cluster. Top 30 SQL statements with the longest I/O wait time in the tenant.
  SQL Sorted by Network Latency	Top 30 SQL statements with the longest network latency in the cluster. Top 30 SQL statements with the longest network latency in the tenant.
  SQL Sorted by Logical Reads	Top 30 SQL statements with the most logical reads in the cluster. Top 30 SQL statements with the most logical reads in the tenant.
  SQL Sorted by Physical Reads	Top 30 SQL statements with the most physical reads in the cluster. Top 30 SQL statements with the most physical reads in the tenant.
  SQL Sorted by Executions	Top 30 SQL statements with the most executions in the cluster. Top 30 SQL statements with the most executions in the tenant.
  SQL Sorted by Number of Remote Plan Executions	Top 30 SQL statements with the most executions in the cluster. Top 30 SQL statements with the most executions in the tenant.
  SQL Sorted by Distributed Plan Executions	Top 30 SQL statements with the most executions in the cluster. Top 30 SQL statements with the most executions in the tenant.
  SQL Sorted by Affected Rows	Top 30 SQL statements with the most affected rows in the cluster. Top 30 SQL statements with the most affected rows in the tenant.
  SQL Texts	The information of all the preceding SQL statements.

• Memory Statistics : You can view the memory statistics of tenants in the cluster in the following columns: Context ID , Memory Usage (Bytes) , Average Memory Size Per Object (Bytes), Maximum Memory Usage (Bytes), Period with Maximum Memory Usage, Minimum Memory Usage (Bytes), and Period with Minimum Memory Usage.

• Cache Statistics

  This module provides the average KV cache hit rate of tenants. The statistics are sourced from the OceanBase Database view gv$systat. The hit rate is accurate to two decimal places.

  You can view the statistics of the following 7 types of caches: block cache, block index cache, clog cache, clog index cache, Bloom filter cache, location cache, and row cache. The following statistics are displayed: cache hit rate, cache requests, and cache size.

  Note

  In the statistic report, you can hover the pointer over a parameter in the table header to view the parameter description.

  Parameter	Description
  Cache Hit Rate	The hit rates of different types of caches in different tenants during the snapshot period. For more information about the cache types, see Caching.
  Cache Request	Information about caches and cache requests in different tenants during the snapshot period, such as the number of cache requests, cache hits, and cache mishits.
  Cache Size	The size of different types of caches in different tenants during the snapshot period. The start and end positions are displayed.

• RPC Statistics

  Note

  In the statistic report, you can hover the pointer over a parameter in the table header to view the data source of the parameter.

  Parameter	Description
  Total RPCs	The number and size of remote procedure calls (RPCs), RPC latency, and number of failed RPCs measured by tenant and host. The RPCs are sorted by RPC size, with the top 10 results displayed.
  Package Code RPC	Sorts RPCs by package code and displays the top 10 results.
  Clog RPC	Information about clog RPCs measured by tenant and host, such as the total number of clog RPCs, number of successful clog RPCs, and total time consumed by successful clog RPCs.
  GTS RPC	The number of Global Trade Services (GTS) RPCs measured by tenant and host.
  Location Cache RPC	Information about location cache RPCs measured by tenant and host, such as the total number of cache refreshes, number of cache refreshes by RPCs, and number of failed cache refreshes by RPCs.

• Lock Statistics

  Parameter	Description
  Row Lock Statistics	The number of row lock applications, waits, and timeouts, as well as the wait time, in a tenant.
  Latch Statistics	You can view the following statistics on latches in a tenant: Get: indicates the number of successful willing-to-wait latch requests. Miss: indicates the number of failed willing-to-wait latch requests. Sleep: indicates the number of failed willing-to-wait latch requests that result in process sleeps. Spin Get: indicates the total number of spins in the tenant. Immediate Get: indicates the number of successful immediate latch requests. Immediate Miss: indicates the number of failed immediate latch requests.

• Parameter Changes

  This module provides information about parameter value changes collected in dimensions of cluster, zone, server, and tenant during the snapshot period.