From 6cbd96ba11ca77104c85f800f47a1e18e221329b Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Tue, 18 Nov 2025 17:08:58 +0800 Subject: [PATCH 1/8] Update 02_ecological-tools.md Divide these tools by different users and scenarios, delete some low use tools. --- .../02_ecological-tools.md | 92 +++++++------------ 1 file changed, 34 insertions(+), 58 deletions(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md b/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md index 93204bf40..47fdd0a5e 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md +++ b/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md @@ -21,25 +21,15 @@ For more information, see [OceanBase Database Proxy](https://en.oceanbase.com/do ## Installation and deployment tools +### For Enterprise Users + ### OCP OceanBase Cloud Platform (OCP) is an enterprise-level management platform tailored for OceanBase clusters. It is compatible with all major OceanBase Database versions. It provides GUI-based management capabilities, including lifecycle management of database components and resources (such as hosts, networks, and software packages), fault recovery, performance diagnostics, as well as monitoring and alerting. OCP aims to help enterprises manage OceanBase clusters more efficiently at lower IT O&M costs and shorten the user learning curve. For more information about the system architecture and features of OCP, see [OceanBase Cloud Platform](https://en.oceanbase.com/docs/common-ocp-10000000001553919). -### OCP Express - -OCP Express is a web-based management tool for OceanBase Database V4.x. Integrated with OceanBase clusters, OCP Express allows you to view key performance metrics and perform basic database management operations on OceanBase clusters. - -OCP Express is derived from OCP. It retains the core capabilities of OCP and adjusts the overall layout of features to provide a brand-new user experience. Feature configurations are also rearranged in OCP Express so that OCP Express can be deployed on any database node with the minimum resource consumption. OCP Express allows you to gain extensive control over OceanBase Database V4.x at minimum costs. - -OCP Express is intended for lightweight O&M management and is integrated with the managed OceanBase cluster for dedicated management. It minimizes resource consumption while meeting basic O&M requirements. OCP is intended for the O&M of large-scale complex clusters, and you can manage multiple OceanBase clusters in OCP. It provides more management capabilities than OCP Express. An additional OceanBase cluster is needed to store the data of OCP, and higher resource configurations are needed to implement the capabilities of OCP. - -> **Note** -> -> OCP Express applies to the O&M of an OceanBase cluster in a development and testing environment with no more than 20 servers and 3 to 5 tenants. We recommend that you use OCP in a production environment. - -For more information about the system architecture and features of OCP Express, see [OCP Express](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375615). +### For Individual Users or Enterprises with Limited Resources ### OBD @@ -51,6 +41,8 @@ Besides cluster deployment, OBD also provides general O&M capabilities such as t For more information, see [OceanBase Deployer](https://en.oceanbase.com/docs/obd-en). +### For K8s Users + ### ob-operator ob-operator is a tool built based on the Kubernetes Operator framework for managing OceanBase clusters on Kubernetes. It provides a simple and reliable way to implement containerized deployment of OceanBase clusters and simplifies the O&M of OceanBase clusters. ob-operator defines various resources for OceanBase Database and implements the corresponding coordination logic. It allows you to manage OceanBase clusters in a declarative manner, just as you would manage native Kubernetes resources. @@ -63,12 +55,6 @@ For more information about the features and usage instructions of ob-operator, s OCP and OCP Express not only allow you to create and manage clusters and tenants, but also provide features such as performance diagnostics, and monitoring and alerting. For more information, see the description of OCP and OCP Express in 'Installation and deployment tools'. -### DOOBA - -DOOBA is an internal O&M script of OceanBase Database that is developed in Python for performance monitoring. After you connect to the sys tenant of OceanBase Database by running a MySQL command, you can run DOOBA to display the queries per second (QPS) and the average response time (RT) of the SQL statements executed in the tenant in real time. The supported SQL types include `SELECT`, `UPDATE`, `INSERT`, `DELETE`, and `COMMIT`. You can also view the QPS and RT of SQL statements executed on each OBServer node. - -For more information, see [DOOBA](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375726). - ### OBAgent OceanBase Agent (OBAgent) is a framework for monitoring data collection and O&M. @@ -83,6 +69,34 @@ OceanBase Agent (OBAgent) is a framework for monitoring data collection and O&M. For more information, see the [obagent repository](https://github.com/oceanbase/obagent) on GitHub. +## O&M tools + +### For Enterprise Users + +### OCP + +In addition to creating and managing clusters and tenants, OCP also supports fault recovery, performance diagnostics, and monitoring and alerting. + +For more information, see the description of OCP in 'Installation and deployment tools'. + +### For Operations and Development Users + +### OBShell + +OceanBase Shell (OBShell) is an out-of-the-box command-line tool provided by OceanBase Database Community Edition for O&M engineers and developers to manage local OceanBase clusters. OBShell supports cluster O&M and provides O&M and management APIs based on OceanBase Database. This allows products from different ecosystems to manage the same OceanBase cluster in a unified manner, reducing the difficulty in and costs of OceanBase cluster management. + +You do not need to separately install OBShell. As long as OceanBase Database Community Edition is installed, you can find the OBShell executable file in the `bin` directory under the working directory of each OBServer node. + +For more information, see [OBShell](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001378072). + +### obdiag + +obdiag is a CLI diagnostic tool designed for OceanBase Database. At present, it can scan, collect, and analyze diagnostic information such as the logs, SQL audit records, and the process stack information of OceanBase Database. You can use obdiag easily, no matter whether your OceanBase cluster is deployed manually or by using OCP or OBD. + +obdiag allows you to use command lines to: (a) inspect OceanBase clusters for existing or possible exceptions, analyze their causes, and provide O&M suggestions; (b) collect diagnostic information dispersed across nodes and return the information to the obdiag server in a package; (c) analyze OceanBase Database logs to identify errors that have occurred; and (d) perform end-to-end diagnostics based on the `trace.log` file. + +For more information, see [OceanBase Diagnostic Tool](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375725). + ## Migration and synchronization tools ### OMS @@ -115,44 +129,6 @@ You can use OBDUMPER to export table data from OceanBase Database to files in th For more information, see [OceanBase Loader and Dumper](https://en.oceanbase.com/docs/obloader-obdumper-en). -## O&M tools - -### OCP / OCP Express - -In addition to creating and managing clusters and tenants, OCP also supports fault recovery, performance diagnostics, and monitoring and alerting. - -Unlike OCP, OCP Express does not support advanced O&M capabilities, such as backup and restore, version upgrade, and cluster scaling, aiming to reduce resource usage. OCP Express is more lightweight than OCP and is designed to meet the basic O&M and monitoring requirements of a single cluster. We recommend that you use OCP in a production environment. - -For more information, see the description of OCP and OCP Express in 'Installation and deployment tools'. - -### OBShell - -OceanBase Shell (OBShell) is an out-of-the-box command-line tool provided by OceanBase Database Community Edition for O&M engineers and developers to manage local OceanBase clusters. OBShell supports cluster O&M and provides O&M and management APIs based on OceanBase Database. This allows products from different ecosystems to manage the same OceanBase cluster in a unified manner, reducing the difficulty in and costs of OceanBase cluster management. - -You do not need to separately install OBShell. As long as OceanBase Database Community Edition is installed, you can find the OBShell executable file in the `bin` directory under the working directory of each OBServer node. - -For more information, see [OBShell](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001378072). - -### obdiag - -obdiag is a CLI diagnostic tool designed for OceanBase Database. At present, it can scan, collect, and analyze diagnostic information such as the logs, SQL audit records, and the process stack information of OceanBase Database. You can use obdiag easily, no matter whether your OceanBase cluster is deployed manually or by using OCP or OBD. - -obdiag allows you to use command lines to: (a) inspect OceanBase clusters for existing or possible exceptions, analyze their causes, and provide O&M suggestions; (b) collect diagnostic information dispersed across nodes and return the information to the obdiag server in a package; (c) analyze OceanBase Database logs to identify errors that have occurred; and (d) perform end-to-end diagnostics based on the `trace.log` file. - -For more information, see [OceanBase Diagnostic Tool](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375725). - -### ob_error - -ob_error is an error code parsing tool of OceanBase Database. ob_error returns the corresponding causes and solutions for each error code you entered. With ob_error, you can get basic error information without looking up the documentation. - -For more information, see [ob_error](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375718). - -### ob_admin - -ob_admin is an O&M tool for OceanBase Database. It provides the slog_tool, log_tool, dumpsst, and dump_backup features to troubleshoot issues such as data inconsistency, data loss, and data errors. - -For more information, see [ob_admin](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001378074). - ## GUI-based development tools ### ODC @@ -189,4 +165,4 @@ For more information, see [OceanBase Connector/C](https://en.oceanbase.com/docs/ ODBC stands for Open Database Connectivity. OceanBase Connector/ODBC is designed for data sharing between heterogeneous databases. It has become a major part of the Windows Open System Architecture (WOSA) and a database access API standard in Windows-based environments. -For more information, see [OceanBase Connector/ODBC](https://en.oceanbase.com/docs/obodbc-en). \ No newline at end of file +For more information, see [OceanBase Connector/ODBC](https://en.oceanbase.com/docs/obodbc-en). From 9c4fb4d8ab95354bcffb0eb2f4ada8965f6525a8 Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Thu, 20 Nov 2025 11:11:49 +0800 Subject: [PATCH 2/8] Update 03_sysbench_test.md add note to clarify the permission of scripts in case of error. --- .../chapter_03_test_oceanbase_database/03_sysbench_test.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md index b8445f748..4055c109f 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md +++ b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md @@ -138,6 +138,10 @@ CREATE TENANT sysbench_tenant resource_pool_list=('sysbench_pool'), zone_list(' 3. Run the benchmark. +> **Note** +> +> Ensure the script has the correct permissions before running it. + ```shell ./ob_sysbench.sh ``` From cb47a1626c46a30cedaa7e3809b779e1471a8413 Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Thu, 20 Nov 2025 11:17:14 +0800 Subject: [PATCH 3/8] Update 03_sysbench_test.md Unify structure between different topics. --- .../03_sysbench_test.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md index 4055c109f..b03ae5e68 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md +++ b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md @@ -5,13 +5,15 @@ weight: 4 # 3.3 Run the Sysbench benchmark -Sysbench is a LuaJIT-based multi-thread benchmark tool that allows you to write scripts to test the CPU, memory, thread, I/O, and database performance. It is often used to evaluate and test the database workload under various system parameter configurations. You can run the Sysbench benchmark to test a variety of database businesses by customizing Lua scripts without modifying the source code. - This topic describes two methods to run the Sysbench benchmark on OceanBase Database in a CentOS Linux 7.9 environment based on the x86 architecture. * Use OceanBase Deployer (OBD) to run the benchmark. -* Use the official Sysbench tool to manually run the Sysbench benchmark step by step. +* Use the official Sysbench tool to manually run the Sysbench benchmark step by step. + +## Sysbench overview + +Sysbench is a LuaJIT-based multi-thread benchmark tool that allows you to write scripts to test the CPU, memory, thread, I/O, and database performance. It is often used to evaluate and test the database workload under various system parameter configurations. You can run the Sysbench benchmark to test a variety of database businesses by customizing Lua scripts without modifying the source code. ## Use obdiag to inspect the cluster before running the benchmark From 233a2c69dec79f61a7d47065b2ce26cb9ec6bc53 Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Thu, 20 Nov 2025 11:23:15 +0800 Subject: [PATCH 4/8] Update 04_tpcc_test.md Unify all notes --- .../en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md index d8abd58d7..4d434880b 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md +++ b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md @@ -568,7 +568,7 @@ Before you run the TPC-C benchmark, you need to tune related parameters. To tune parameters of ODP, run the `obclient -h -P -uroot@sys -A -p` command to connect to the sys tenant. -> **Description** +> **Note** > > To modify ODP parameters, you must log on to the sys tenant of the OceanBase cluster by using the IP address and port of ODP. From bfe2bfcbe434e06fc4b28d896386338ec9f9d075 Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Thu, 20 Nov 2025 11:25:26 +0800 Subject: [PATCH 5/8] Update 04_tpcc_test.md Unify all notes. --- .../en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md index 4d434880b..1782063f1 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md +++ b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/04_tpcc_test.md @@ -71,7 +71,7 @@ OceanBase Database is a native distributed database system. Root cause analysis The TPC-C benchmark requires five servers, one for deploying Benchmark SQL and OBD, one for deploying OceanBase Database Proxy (ODP) separately, and three for deploying an OceanBase cluster that has three zones, with each containing one OBServer node. -> **Notice** +> **Note** > > * We recommend that you deploy ODP on a separate server to avoid resource contention with OceanBase Database. > From ac7731bfee2e3e478c44d3f8b05427f292d9f312 Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Thu, 20 Nov 2025 11:27:50 +0800 Subject: [PATCH 6/8] Update 05_tpch_test.md Unify all notes. --- .../en-US/chapter_03_test_oceanbase_database/05_tpch_test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/05_tpch_test.md b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/05_tpch_test.md index 57f2a5dee..fb5192ec1 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/05_tpch_test.md +++ b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/05_tpch_test.md @@ -77,7 +77,7 @@ OceanBase Database is a native distributed database system. Root cause analysis The TPC-H benchmark requires four servers, one for deploying the TPC-H tool, ODP, and OBD, and three for deploying an OceanBase cluster that has three zones, with each containing one OBServer node. -> **Notice** +> **Note** > > * We recommend that you set input/output operations per second (IOPS) to a value greater than 10000, and configure three disks for system logs, transaction logs, and data files respectively. > From 460072930294ccd990c19284d8781ee3096f7bbf Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Thu, 20 Nov 2025 11:39:31 +0800 Subject: [PATCH 7/8] Update 06_jmeter_test.md Add Jmeter model overview and unify structure between different topics. --- .../chapter_03_test_oceanbase_database/06_jmeter_test.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md index 94a360668..009167b43 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md +++ b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md @@ -5,7 +5,11 @@ weight: 7 # 3.6 Use JMeter to test OceanBase Database in simulated business scenarios -JMeter is an open-source performance test tool developed by the Apache Software Foundation. It is built based on the Java platform and intended for load and stress tests on software applications. JMeter was designed for testing Web applications at the beginning and supports other test features later. You can use JMeter to simulate business SQL scenarios and analyze the performance of a database server under different loads. +This topic introduces the procedure for executing JMeter tests on the OceanBase Database. + +## Jmeter Overview + +JMeter is an open-source load testing tool designed to measure and validate the performance of software applications, APIs, and databases. It supports simulating high user loads, generating realistic traffic, and providing detailed metrics on response times, throughput, and error rates—making it ideal for assessing the scalability and stability of target systems under test. ## Prepare the environment @@ -159,4 +163,4 @@ Click **Thread-Group** and choose **Add** > **Listener** > **View Results Tree** Click **Thread Group** and choose **Add** > **Listener** > **Aggregate Report** to create an aggregated report that aggregates the results. -![View the report](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/015.png) \ No newline at end of file +![View the report](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/015.png) From 2b3c5000aa0dbeb790584e6b93eb516f4823f647 Mon Sep 17 00:00:00 2001 From: echo77-nan <741548989@qq.com> Date: Thu, 20 Nov 2025 11:41:01 +0800 Subject: [PATCH 8/8] Update 06_jmeter_test.md Modify a second title. --- .../en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md index 009167b43..3e9bb75f6 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md +++ b/docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test.md @@ -7,7 +7,7 @@ weight: 7 This topic introduces the procedure for executing JMeter tests on the OceanBase Database. -## Jmeter Overview +## JMeter Overview JMeter is an open-source load testing tool designed to measure and validate the performance of software applications, APIs, and databases. It supports simulating high user loads, generating realistic traffic, and providing detailed metrics on response times, throughput, and error rates—making it ideal for assessing the scalability and stability of target systems under test.