oceanbase.DBA_OB_TENANT_EVENT_HISTORY

Purpose

The oceanbase.DBA_OB_TENANT_EVENT_HISTORY view displays the historical operation records of the current tenant.

Columns

Sample tenant events

The following sample tenant events mainly show TENANT ROLE CHANGE (tenant role switching), SERVICE NAME (service name), and DBMS_BALANCE.

When users perform different operations on different modules, the corresponding NAME and VALUE values are different.

TENANT ROLE CHANGE

The TENANT ROLE CHANGE module contains three operations: FAILOVER TO PRIMARY, SWITCHOVER TO PRIMARY, and SWITCHOVER TO STANDBY.

• FAILOVER TO PRIMARY operation

  When a user initiates a FAILOVER TO PRIMARY operation, the following important events are recorded in the tenant event log table.

  • FAILOVER TO PRIMARY START

    This event records the specific time when the ALTER SYSTEM ACTIVATE STANDBY command is executed, along with relevant tenant information.

    Attribute	Value
    NAME1: STMT_STR	VALUE1: The command text entered by the user.
    NAME2: TENANT_INFO	VALUE2: The status or information of the tenant at the time the command was initiated.

  • FAILOVER TO PRIMARY END

    This event records the exact time when the ALTER SYSTEM ACTIVATE STANDBY command is completed, including relevant tenant information, the final state of the log stream, and details of the time spent on key steps.

    Attribute	Value
    NAME1: STMT_STR	VALUE1: The command text entered by the user.
    NAME2: TENANT_INFO	VALUE2: The status or information of the tenant at the end of the command.
    NAME3: FAILOVER_SCN	VALUE3: The synchronization point after the tenant fails over.
    NAME4: COST_DETAIL	VALUE4: Statistics of time spent on each stage during command execution, in microseconds.
    NAME5: ALL_LS	VALUE5: The status of all log streams when the tenant modifies the ACCESS MODE.

• SWITCHOVER TO PRIMARY operation

  When a user initiates a SWITCHOVER TO PRIMARY operation, the following important events are recorded in the tenant event log table.

  • SWITCHOVER TO PRIMARY START

    This event records the specific time when the ALTER SYSTEM SWITCHOVER TO PRIMARY command is executed, along with relevant tenant information.

    Attribute	Value
    NAME1: STMT_STR	VALUE1: The command text entered by the user.
    NAME2: TENANT_INFO	VALUE2: The status or information of the tenant at the time the command was initiated.

  • WAIT LOG SYNC

    This event records information about log synchronization. When a user executes the ALTER SYSTEM SWITCHOVER TO PRIMARY command, the involved tenant must wait until all the latest log records are synchronized from the current primary tenant to ensure data consistency and integrity.

    Attribute	Value
    NAME1: IS_SYS_LS_SYNCED	VALUE1: Indicates whether the system log stream of the tenant is synchronized.
    NAME2: IS_ALL_LS_SYNCED	VALUE2: Indicates whether all log streams of the tenant are synchronized.
    NAME3: NON_SYNC_INFO	VALUE3: If any log streams are not synchronized, the system displays the number of such log streams and provides information about the five slowest-synchronizing log streams.

  • SWITCHOVER TO PRIMARY END

    This event records the exact time when the ALTER SYSTEM SWITCHOVER TO PRIMARY command is completed, including relevant tenant information, the final state of the log stream, and details of the time spent on key steps.

    Attribute	Value
    NAME1: STMT_STR	VALUE1: The command text entered by the user.
    NAME2: TENANT_INFO	VALUE2: The status or information of the tenant at the end of the command.
    NAME3: SWITCHOVER_SCN	VALUE3: The synchronization point after the tenant is switched over.
    NAME4: COST_DETAIL	VALUE4: Statistics of time spent on each stage during command execution, in microseconds.
    NAME5: ALL_LS	VALUE5: The status of all log streams when the tenant modifies the ACCESS MODE.

• SWITCHOVER TO STANDBY operation

  When a user initiates a SWITCHOVER TO STANDBY operation, the following important events are recorded in the tenant event log table.

  • SWITCHOVER TO STANDBY START

    This event records the specific time when the ALTER SYSTEM SWITCHOVER TO STANDBY command is executed, along with relevant tenant information.

    Attribute	Value
    NAME1: STMT_STR	VALUE1: The command text entered by the user.
    NAME2: TENANT_INFO	VALUE2: The status or information of the tenant at the time the command was initiated.

  • SWITCHOVER TO STANDBY END

    This event records the exact time when the ALTER SYSTEM SWITCHOVER TO STANDBY command is completed, including relevant tenant information, the final state of the log stream, and details of the time spent on key steps.

    Attribute	Value
    NAME1: STMT_STR	VALUE1: The command text entered by the user.
    NAME2: TENANT_INFO	VALUE2: The status or information of the tenant at the end of the command.
    NAME3: SWITCHOVER_SCN	VALUE3: The synchronization point after the tenant is switched over.
    NAME4: COST_DETAIL	VALUE4: Statistics of time spent on each stage during command execution, in microseconds.
    NAME5: ALL_LS	VALUE5: The status of all log streams when the tenant modifies the ACCESS MODE.

SERVICE NAME

The SERVICE NAME module contains the CREATE SERVICE, DELETE SERVICE, START SERVICE, and STOP SERVICE operations.

You can use the TRACE_ID to query these four operations. For example, you can find the event of creating a service and use the TRACE_ID of the event to trace the broadcast triggered by the creation of the service.

• CREATE SERVICE

  When a user initiates a service creation operation for a user tenant, the following event is recorded.

  • BROADCAST SERVICE NAME

    This event records the content of the broadcast, the list of target OBServer nodes, and the list of OBServer nodes that successfully received the broadcast. When a user executes the ALTER SYSTEM CREATE SERVICE command, the OBServer node that initiates the command broadcasts the current service name information of the tenant to all OBServer nodes where the units of the tenant are located.

    Column	Description
    NAME1: EPOCH	VALUE1: The version of the current service name information of the tenant for the broadcast.
    NAME2: TARGET_SERVICE_NAME_ID	VALUE2: The service_name_id of the event that triggers the broadcast.
    NAME3: SERVICE_NAME_LIST	VALUE3: The current service name information of the tenant.
    NAME4: SERVICE_NAME_COMMAND_TYPE	VALUE4: The type of the operation that triggers the broadcast.
    NAME5: TARGET_SERVERS_LIST	VALUE5: The list of target OBServer nodes. These nodes are all non-permanently offline nodes where the units of the tenant are located.
    NAME6: SUCCESS_SERVERS_LIST	VALUE6: The list of OBServer nodes that successfully received the broadcast.

  • CREATE SERVICE

    This event records the name of the service to be created and the detailed information of the service after it is created. This event is generated after the execution of the ALTER SYSTEM CREATE SERVICE command initiated by the user.

    Column	Description
    NAME1: SERVICE_NAME_STRING	VALUE1: The name of the new service to be created.
    NAME2: CREATED_SERVICE_NAME	VALUE2: The service name information after the service is created.

• DELETE SERVICE

  When a user initiates a service deletion operation for a user tenant, the following event is recorded.

  • DELETE SERVICE

    This event records the information at the time the command is initiated. This event is generated after the execution of the ALTER SYSTEM DELETE SERVICE command initiated by the user.

    Column	Description
    NAME1: DELETED_SERVICE_NAME	VALUE1: The service name information of the service to be deleted.

• START SERVICE

  When a user initiates a service start operation for a user tenant, the following event is recorded.

  • BROADCAST SERVICE NAME

    This event records the content of the broadcast, the list of target OBServer nodes, and the list of OBServer nodes that successfully received the broadcast. When a user executes the ALTER SYSTEM SERVICE NAME command, the OBServer node that initiates the command broadcasts the current service name information of the tenant to all OBServer nodes where the units of the tenant are located.

    Column	Description
    NAME1: EPOCH	VALUE1: The version of the current service name information of the tenant for the broadcast.
    NAME2: TARGET_SERVICE_NAME_ID	VALUE2: The service _name _id of the event that triggers the broadcast.
    NAME3: SERVICE_NAME_LIST	VALUE3: The current service_name of the tenant.
    NAME4: SERVICE_NAME_COMMAND_TYPE	VALUE4: The type of the operation that triggers the broadcast.
    NAME5: TARGET_SERVERS_LIST	VALUE5: The list of target OBServer nodes. These nodes are all non-permanently offline nodes where the units of the tenant are located.
    NAME6: SUCCESS_SERVERS_LIST	VALUE6: The list of OBServer nodes that successfully received the broadcast.

  • START SERVICE

    This event records the information at the time the command is initiated and the information at the time the command is completed. This event is generated after the execution of the ALTER SYSTEM START SERVICE command initiated by the user.

    Column	Description
    NAME1: SERVICE_NAME_BEFORE	VALUE1: The service name information before the service is started.
    NAME2: SERVICE_NAME_AFTER	VALUE2: The service name information after the service is started.

• STOP SERVICE

  When a user initiates a service stop operation for a user tenant, the following event is recorded.

  • KILL CONNECTIONS OF SERVICE NAME

    Each OBServer node terminates the connections established through the service name of the service that is to be stopped and generates a record in the tenant event view. If no connections are established through the service name of the service that is to be stopped on an OBServer node, this event is not recorded in the table.

    Column	Description
    NAME1: SERVICE_NAME	VALUE1: The service name information of the service to be stopped.
    NAME2: KILLED_CONNECTIONS_COUNT	VALUE2: The number of terminated connections.
    NAME3: KILLED_CONNECTIONS_LIST	VALUE3: The IDs of the terminated connections.

  • BROADCAST SERVICE NAME

    This event records the content of the broadcast, the list of target OBServer nodes, and the list of OBServer nodes that successfully received the broadcast. When a user executes the ALTER SYSTEM STOP SERVICE command, the OBServer node that initiates the command broadcasts the current service name information of the tenant to all OBServer nodes where the units of the tenant are located.

    Column	Description
    NAME1: EPOCH	VALUE1: The version of the current service name information of the tenant for the broadcast.
    NAME2: TARGET_SERVICE_NAME _ID	VALUE2: The service _name _id of the event that triggers the broadcast.
    NAME3: SERVICE_NAME_LIST	VALUE3: The current service_name of the tenant.
    NAME4: SERVICE_NAME_COMMAND_TYPE	VALUE4: The type of the operation that triggers the broadcast.
    NAME5: TARGET_SERVERS_LIST	VALUE5: The list of target OBServer nodes. These nodes are all non-permanently offline nodes where the units of the tenant are located.
    NAME6: SUCCESS_SERVERS_LIST	VALUE6: The list of OBServer nodes that successfully received the broadcast.

  • STOP SERVICE

    This event records the information at the time the command is initiated and the information at the time the command is completed. This event is generated after the execution of the ALTER SYSTEM STOP SERVICE command initiated by the user.

    Property	Value
    NAME1: SERVICE_NAME_BEFORE	VALUE1: Information about the service name before the service is stopped.
    NAME2: SERVICE_NAME_AFTER	VALUE2: Information about the service name after the service is stopped.

DBMS_BALANCE

The DBMS_BALANCE module provides four operations: TRIGGER PARTITION BALANCE, SET BALANCE WEIGHT, CLEAR BALANCE WEIGHT, and CLEAR EXPIRED BALANCE WEIGHT.

• TRIGGER PARTITION BALANCE

  When you execute the DBMS_BALANCE.TRIGGER_PARTITION_BALANCE operation, the tenant event record table records a TRIGGER PARTITION BALANCE event.

  The TRIGGER PARTITION BALANCE event records the specific time when the DBMS_BALANCE.TRIGGER_PARTITION_BALANCE command is executed and the related parameters.

  Column	Description
  NAME1: BALANCE_TIMEOUT_S	VALUE1: The timeout parameter for triggering balance, in seconds.

• SET BALANCE WEIGHT

  When you execute the DBMS_BALANCE.SET_BALANCE_WEIGHT operation, the tenant event record table records a SET BALANCE WEIGHT event.

  The SET BALANCE WEIGHT event records the specific time when the DBMS_BALANCE.SET_BALANCE_WEIGHT command is executed and the related parameters.

  Column	Description
  NAME1: WEIGHT	VALUE1: The weight of the partition.
  NAME2: DATABASE_NAME	VALUE2: The name of the database to which the partition belongs.
  NAME3: TABLE_NAME	VALUE3: The name of the table to which the partition belongs.
  NAME4: PARTITION_NAME	VALUE4: The name of the partition.
  NAME5: SUBPARTITION_NAME	VALUE5: The name of the subpartition.

• CLEAR BALANCE WEIGHT

  When you execute the DBMS_BALANCE.CLEAR_BALANCE_WEIGHT operation, the tenant event record table records a CLEAR BALANCE WEIGHT event.

  The CLEAR BALANCE WEIGHT event records the specific time when the DBMS_BALANCE.CLEAR_BALANCE_WEIGHT command is executed and the related parameters.

  Column	Description
  NAME1: DATABASE_NAME	VALUE1: The name of the database to which the partition belongs.
  NAME2: TABLE_NAME	VALUE2: The name of the table to which the partition belongs.
  NAME3: PARTITION_NAME	VALUE3: The name of the partition.
  NAME4: SUBPARTITION_NAME	VALUE4: The name of the subpartition.

• CLEAR EXPIRED BALANCE WEIGHT

  When the background thread clears the weights of expired partitions, the tenant event record table records a CLEAR EXPIRED BALANCE WEIGHT event.

  The CLEAR EXPIRED BALANCE WEIGHT event records the specific time when the background thread clears the weights of expired partitions and the related parameters.

  Column	Description
  NAME1: TABLE_NAME	VALUE1: The name of the table to which the partition belongs.
  NAME2: PARTITION_NAME	VALUE2: The name of the partition.
  NAME3: SUBPARTITION_NAME	VALUE3: The name of the subpartition.

Sample query

Query the history of operations in the current tenant and display the first record.

obclient [oceanbase]> SELECT * FROM oceanbase.DBA_OB_TENANT_EVENT_HISTORY LIMIT 1\G

The query result is as follows:

*************************** 1. row ***************************
 TIMESTAMP: 2023-12-14 14:33:20.321725
    MODULE: TENANT ROLE CHANGE
     EVENT: SWITCHOVER TO STANDBY END
     NAME1: STMT_STR
    VALUE1: ALTER SYSTEM SWITCHOVER TO STANDBY TENANT backup_mysql_tenant
     NAME2: TENANT_INFO
    VALUE2: {tenant_id:1002, tenant_role:"STANDBY", switchover_status:"NORMAL", switchover_epoch:1702535600271677, sync_scn:1702535620070597000, replayable_scn:1702535620070597000, readable_scn:1702535620070597000, recovery_until_scn:4611686018427387903, log_mode:"ARCHIVELOG", max_ls_id:1003}
     NAME3: SWITCHOVER_SCN
    VALUE3: 1702535620070597000
     NAME4: COST_DETAIL
    VALUE4: WAIT_LOG_END: 100190, CHANGE_ACCESS_MODE: 47261, OTHERS: 136839
     NAME5: ALL_LS
    VALUE5: NORMAL: 1, 1001, 1002, 1003
     NAME6: NULL
    VALUE6:
EXTRA_INFO: NULL
    SVR_IP: 100.xx.xx.xx
  SVR_PORT: 13324
  TRACE_ID: Y340C64586BD4-00060C724AEB962B-0-0
 COST_TIME: 284290
  RET_CODE: 0
 ERROR_MSG: NULL
1 row in set

References

• Create a service
• View the service status
• Start a service
• Pause a service
• Delete a service