Overview|V4.3.6|OceanBase Cloud Platform|OCP docs|Distributed Database

Overview

Last Updated：2026-08-05 09:46:03 Updated

When the amount of diagnostic data collected is too large, the Agent may run out of memory and restart repeatedly. In this case, you can only modify the configuration file parameters and re-push the configuration through a CLI. However, this non-standard approach may lead to issues, such as Agent upgrade failures due to incompatible configurations or configurations being reset.

To address this, OCP provides a web-based parameter configuration management feature. You can refer to this section to view and manage OCP-related collection and operation parameters on the O&M Configuration page.

Parameter list

OCP supports five types of parameters for data collection and O&M: SQL Diagnostics Collection, Transaction Diagnostics Collection, ASH Collection, Performance Monitoring Parameters, and backup parameters. These parameters correspond to the SQL diagnostics, transaction diagnostics, active session history, performance monitoring, and backup features of OCP.

SQL diagnostics collection

SQL Diagnostics Collection provides basic data for the SQL diagnostics module in tenants and autonomous services.

Parameter	Parameter Type	Default Value	Value Range	Description
monagent.pipeline.sql.audit.status	String	active	-	The switch for sql_audit diagnostics collection. Valid values: active and inactive.
monagent.limit.memory.fuse.percent	Double	0.8	[0.1, 1.0]	The memory threshold for circuit breaking in diagnostics collection. The value is calculated as the current memory of the ocp_monagent process divided by the memory limit of the ocp_monagent process. If the threshold is exceeded, diagnostics data will no longer be collected. You can increase the threshold when the collection pressure is high.
monagent.ob.sql.audit.collect.batch.size	Int	4000	[500, 20000]	The number of internal views to be queried in one sql_audit collection. You can increase this value to improve efficiency when the collection pressure is high.
monagent.ob.slow.sql.threshold	String	100ms	-	The threshold for reporting slow SQL. SQL statements exceeding this threshold will be reported to MonitorDB as slow SQL. You can adjust the threshold to reduce the number of reports when there are too many slow SQL statements.
monagent.ob.sql.transaction.timeus.threshold	Int	500000	[10000, 300000000]	The time threshold for large transactions, in microseconds. Transactions with a duration below this threshold will not be reported. You can adjust the threshold to reduce the number of reports when there are too many large transactions.
monagent.ob.sql.transaction.log.size.byte	Int	524288	[1024, 1073741824]	The size threshold for large transactions, in bytes. Transactions with a size below this threshold will not be reported. You can adjust the threshold to reduce the number of reports when there are too many large transactions.
monagent.pipeline.plan.monitor.status	String	active	-	The switch for parallel SQL collection. Valid values: active and inactive.
monagent.pipeline.slow.sql.status	String	active	-	The switch for slow SQL collection. Valid values: active and inactive.
monagent.ob.sql.diagnose.collect.query.timeout	String	10s	-	The timeout period for querying SQL statements in diagnostics collection, including sql_audit, sql_plan, and sql_plan_monitor.
monagent.pipeline.sql.plan.status	String	active	-	The switch for execution plan collection. Valid values: active and inactive.
monagent.ob.sql.plan.collect.batch.size	Int	4000	[500, 20000]	The number of internal views to be queried in one execution plan collection. You can increase this value to improve efficiency when the collection pressure is high.
monagent.ob.sql.plan.monitor.collect.batch.size	Int	4000	[500, 20000]	The number of internal views to be queried in one parallel SQL collection. You can increase this value to improve efficiency when the collection pressure is high.
monagent.pipeline.monitor.user.collect	Bool	false	-	Specifies whether to collect SQL statements for querying the sys tenant by the agent itself. This parameter is disabled by default. You can enable it for troubleshooting.
monagent.pipeline.empty.query.sql.collect	Bool	false	-	Specifies whether to collect sql_audit records with empty query_sql. This parameter is disabled by default. You can enable it for troubleshooting.

Transaction diagnostics collection

Transaction Diagnostics Collection provides basic data for the transaction diagnostics module in tenants and autonomous services.

Parameter	Parameter Type	Default Value	Value Range	Description
monagent.pipeline.transaction.status	String	active	-	The switch for transaction collection. Valid values: active and inactive.
monagent.ob.sql.transaction.collect.batch.size	Int	4000	[500, 20000]	The number of internal views to be queried in one transaction collection. You can increase this value to improve efficiency when the collection pressure is high.
monagent.ob.sql.transaction.collect.join.global.transaction	Bool	true	-	Specifies whether to join the global transaction table when collecting transaction information. This parameter is enabled by default. You can disable it to avoid collecting information about XA transactions.
monagent.ob.sql.transaction.collect.query.timeout	String	5s	-	The timeout period for querying SQL statements in transaction collection.

Active session history collection

ASH Collection provides basic data for the session management module in tenants and autonomous services.

Parameter	Parameter Type	Default Value	Value Range	Description
monagent.pipeline.session.status	String	active	-	The switch for active session collection. Valid values: active and inactive.
monagent.ob.session.event.collect.batch.size	Int	4000	[500, 20000]	The number of internal views to be queried in one active session collection. You can increase this value to improve efficiency when the collection pressure is high.
monagent.ob.session.event.collect.query.timeout	String	10s	-	The timeout period for querying SQL statements in active session collection.

Performance monitoring

Performance monitoring collection provides basic data for the performance monitoring modules of the cluster, tenant, and OBProxy.

Parameter	Parameter type	Default value	Value range	Description
monagent.pipeline.ob.status	String	active	-	The performance monitoring collection switch. Valid values: active and inactive.
monagent.pipeline.tenant.disk.collect.disabled	Bool	false	-	Specifies whether to collect disk data for tenants and below. We recommend that you disable this parameter when SQL performance issues occur.
monagent.collector.ob.extra.interval	String	60s	-	The performance monitoring collection frequency at the minute level.
monagent.second.metric.cache.update.interval	String	5s	-	The performance monitoring collection frequency at the second level.

Backup

Backup collection provides basic data for the backup modules of the cluster and tenant.

Parameter	Parameter type	Default value	Value range	Description
backup.dump.physical.file.timeout	Int	30	[10, 300]	The physical backup file dump timeout, in seconds.
backup.storage.s3.use.path.style	Bool	true	-	Specifies whether to use the path-style access method for S3 storage.

Parameter management

On the O&M Configuration page, you can perform the following basic management operations on the cluster:

Manage parameters: You can enable or disable O&M configuration parameters, modify parameter values, search for parameters, and view modified parameters.
View parameter modification history: View the history of all O&M configuration parameter modifications initiated by the current cluster.
Configure OCP Agent resources: Configure resources for all OCP Agents in the cluster.

OceanBase

Customer Stories

Documentation