A tenant is a logical concept that represents a resource allocation unit in OceanBase Database. It is the basis for the management of database objects and resources. It is critical for system O&M, especially for the O&M of cloud databases. After you log on to the OceanBase Cloud Platform (OCP) console, click Tenants in the left-side navigation pane. The Tenant Overview page appears. By default, the page displays a list of tenants that you have the permission to view, and displays performance monitoring charts of top 5 tenants.
On the Tenants page, you can see a Tenants list and charts of Top 5 Tenants . You can also perform many tenant management operations on this page. For more information, see Unit specification management, Create a tenant, Lock a tenant, and Copy a tenant.
Tenants
The Tenants list contains the following columns: Tenant Name, Cluster, Replica Distribution, Primary Zone, Tenant Mode, Read-only, Locked, Status, Created At , and Actions .
You can click the name of a tenant to go to the tenant details page. For more information, see Tenant summary.
You can click the cluster name to go to the Cluster Details page. For more information, see Overview of the Cluster Details page.
| Parameter | Description |
|---|---|
| Replica Locality | Indicates the replica type of the tenant in each zone, which may be Full-featured Replica, Read-only Replica, or Log Replica. |
| Zone Priority | Indicates the priority of the partition leader in the tenant. |
| Tenant Mode | Indicates the mode of the tenant, which may be Oracle or MySQL . You can filter tenants by mode. |
| Status | Indicates the status of the cluster, which can be Running , Creating , Maintaining , or Deleting . |
| Created At | You can sort the tenants by creation time. |
| Actions | You can Lock or Copy the tenant. If you lock a tenant, the tenant cannot be accessed. If you copy a tenant, a new tenant with the same settings will be created in the same cluster. |
Top 5 Tenants
In this section, you can view the monitoring data of top 5 tenants sorted by the following metrics in the last hour, 24 hours, or 7 days: QPS, TPS, SQL response rime, Transaction response time, Number of active sessions, Event waiting_number of times, Event waiting_time , Capacity_Number of tables , and Capacity_Number of Partitions .
You can click the zoom-in icon in the upper-right corner to zoom in the chart, or select a monitoring time range.
| Metric | Description |
|---|---|
| QPS | The average number of SQL queries processed per second. |
| TPS | The average number of transactions processed per second. |
| SQL response time | The SQL response time in the unit of µs. |
| Transaction response time | The average time in microseconds taken by the server to process a transaction. |
| Active sessions | The number of active sessions. Data source: __all_virtual_processlist |
| Event waiting_number of times | The average number of wait events per second. |
| Event waiting_time | The average wait time of each wait event in the unit of μs. |
| Capacity_Number of tables | The number of tables. |
| Capacity_Number of partitions | The number of partitions. |
Tenant management actions
The following table describes the supported tenant management operations.
| Operation | Description |
|---|---|
| Create Tenant | You can perform this operation to create a tenant. |
| Unit specification management | You can perform this operation to add, modify, and delete unit specifications. |
| Lock a tenant | You can perform this operation to lock a tenant so that it cannot be accessed by users. |
| Copy a tenant | You can perform this operation to quickly create a tenant by copying an existing tenant. |
| Delete a tenant | You can perform this operation to delete a tenant that is no longer required. |
| Create a replica | You can perform this operation to create a replica for a tenant. |
| Change the password of the sys tenant | You can perform this operation to change the password of the sys tenant. |
| Edit a tenant replica of a zone | You can perform this operation to modify the tenant replica information, including the replica type, unit specification, unit quantity, and zone priority. |
| Delete a tenant replica from a zone | You can perform this operation to delete a tenant replica from a zone |
| Modify zone priorities | You can perform this operation to modify the priority of a zone. |
| Modify the whitelist | You can perform this operation to enable other clients to access a tenant by modifying the whitelist of the tenant. |
| View the topology of a tenant | The tenant topology provides the following information: the distribution of the tenant replicas in the cluster, the cluster where the replicas and tenant are located, and the status of the hosts on which the replicas depend. |
| Database management | You can perform this operation to view, create, delete, and modify databases in a tenant. |
| User management in a MySQL tenant | You can perform this operation to view users, create and delete a user, and grant and revoke user permissions in the current MySQL tenant. |
| Performance monitoring | You can perform this operation to view the performance statistics of a tenant. |
| Tenant resource management | You can perform this operation to view the resource usage tendency and the information about databases and table groups of a tenant. |
| Suspected SQL diagnosis | You can perform this operation to view the SQL statements that meet the diagnostic conditions and the suggested solutions. |
| TopSQL diagnosis | You can perform this operation to view the SQL statements of the maximum execution time in a tenant and other execution-related information. |
| SlowSQL diagnosis | You can perform this operation to identify SQL statements whose execution time exceeds the slow-query threshold. You can use the SlowSQL diagnosis feature to identify risky statements and avoid risks. |
| View tenant sessions | You can perform this operation to view all sessions and active sessions of the current tenant and retrieve the sessions. |
| View session statistics | You can perform this operation to view session statistics of the currently logged-on user with different metrics. |
| View parameters | You can perform this operation to view all parameters of the current tenant or parameters that meet the specified search conditions. |
| Modify parameters | You can perform this operation to modify the parameter values of the current tenant. |
| View the parameter modification history | You can perform this operation to view the historical records of parameter modifications of the current tenant. |