From 8dcc7b6b00ec5d953e98fb6767e9ad6520ad1a1a Mon Sep 17 00:00:00 2001 From: "luoli.wk" Date: Fri, 19 Apr 2024 16:15:35 +0800 Subject: [PATCH] update --- .menu_en.yml | 55 ++-- .../100.oceanbase-migration-assessment.md | 0 .../200.oceanbase-migration-service.md | 0 .../300.oceanbase-cloud-platform.md | 0 .../400.1.ocp-express/100.ocp-express.md | 0 .../200.ocp-express-cluster-overview.md | 0 .../300.ocp-express-tenants-management.md | 0 .../400.ocp-express-monitoring-center.md | 0 .../500.ocp-express-diagnosis-center.md | 0 .../600.ocp-express-log-service.md | 0 .../400.oceanbase-developer-center.md | 0 .../600.oceanbase-admin-tool.md | 0 .../100.obshell}/100.obshell-intro.md | 0 .../210.use-case/100.start-stop-obshell.md | 0 .../200.cluster-commands.md | 0 .../300.utilities-commands.md | 0 .../100.api-call-intro.md | 0 .../1000.agent-upgrade-check.md | 0 .../1100.oceanbase-upgrade-check.md | 0 .../1200.upgrade-agent.md | 0 .../1300.upgrade-oceanbase.md | 0 .../1400.scale-out.md | 0 .../1500.get-public-key.md | 0 .../1600.get-status.md | 0 .../1800.get-oceanbase-info.md | 0 .../1900.operate-dag.md | 0 ...00.public-key-encryption-authentication.md | 0 .../2000.get-dag-detail.md | 0 .../2100.get-node-detail.md | 0 .../2200.get-sub-task-detail.md | 0 .../2300.get-all-unfinish-task.md | 0 .../2400.get-agent-unfinish-task.md | 0 .../2500.get-oceanbase-unfinish-task.md | 0 .../2600.get-oceanbase-last-o-m-task.md | 0 .../2700.get-agent-last-o-m-task.md | 0 .../300.add-new-node.md | 0 .../400.delete-node.md | 0 .../410.set-cluster-level.md | 0 .../500.set-server-level.md | 0 .../600.init-cluster.md | 0 .../700.start-cluster.md | 0 .../800.stop-cluster.md | 0 .../900.upload-rpm.md | 0 .../200.ob-admin}/100.overview-of-ob-admin.md | 0 .../200.ob-admin}/300.clog/300.clog-tool.md | 0 .../300.clog/400.format-of-clogs.md | 0 .../500.transaction-information-of-clog.md | 0 .../200.ob-admin}/500.dumpsst.md | 0 .../200.ob-admin}/600.dump-backup.md | 0 .../300.ob-error.md} | 0 .../100.manage/600.oceanbase-deployer.md} | 0 .../700.overview-of-ob-operator.md} | 0 .../100.overview-of-obdiag.md} | 0 .../100.overview-of-sql_diagnoser.md | 0 .../100.install-and-deploy-sql_diagnoser.md | 0 .../200.sql_diagnoser-development-guide.md | 0 .../100.sql_diagnoser-diagnoser-items.md | 0 .../200.sql_diagnoser-expression.md | 0 .../300.sql_diagnoser-api.md | 0 .../400.sql_diagnoser-review-items.md | 0 .../300.dooba.md} | 0 .../100.oblogproxy-overview.md} | 0 .../200.oceanbase-loader-dumper.md} | 0 ...00.introduction-ob-partition-calculator.md | 0 .../200.use-of-the-ob-partition-calculator.md | 0 .../400.cdc}/100.overview-of-cdc.md | 0 .../100.install-and-deploy-obcdc.md | 0 .../200.obcdc-development-instructions.md | 0 .../300.obcdc-tailf.md | 0 .../100.general-obcdc-configuration-items.md | 0 .../200.obcdc-configuration-items.md | 0 .../400.cdc}/200.obcdc/300.faq-of-obcdc.md | 0 .../100.install-and-deploy-oblogmsg.md | 0 ...description-of-some-oblogmsg-interfaces.md | 0 .../100.install-of-mysqltest.md | 0 .../200.use-of-case/100.add-a-case.md | 0 .../200.notes-for-case-writing.md | 0 .../300.case-writing-common-commands.md | 0 .../100.about-obagent/100.what-is-obagent.md | 23 -- .../100.kv-configuration-file.md | 275 ------------------ .../150.mgragent-configuration-file.md | 29 -- .../200.monagent-configuration-file.md | 24 -- .../251.module_config.md | 21 -- .../300.prometheus-configuration-file.md | 72 ----- .../100.install-obagent.md | 82 ------ .../200.manually-deploy-obagent.md | 95 ------ .../300.use-obd-to-deploy-obagent.md | 142 --------- .../100.metrics-exposed-by-exporter.md | 78 ----- .../200.system-statistics.md | 11 - .../500.obagent-development-guide.md | 69 ----- ...nt-to-collect-mysql-performance-metrics.md | 56 ---- ...0.query-expressions-for-general-metrics.md | 82 ------ .../800.frequently-reported-alerts.md | 24 -- 93 files changed, 23 insertions(+), 1115 deletions(-) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/100.oceanbase-migration-assessment.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/200.oceanbase-migration-service.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/300.oceanbase-cloud-platform.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/400.1.ocp-express/100.ocp-express.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/400.1.ocp-express/200.ocp-express-cluster-overview.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/400.1.ocp-express/300.ocp-express-tenants-management.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/400.1.ocp-express/400.ocp-express-monitoring-center.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/400.1.ocp-express/500.ocp-express-diagnosis-center.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/400.1.ocp-express/600.ocp-express-log-service.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/400.oceanbase-developer-center.md (100%) rename en-US/700.reference/{1400.oceanbase-tools => 1400.platform-products}/600.oceanbase-admin-tool.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/100.obshell-intro.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/210.use-case/100.start-stop-obshell.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/300.obshell-clients/200.cluster-commands.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/300.obshell-clients/300.utilities-commands.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/100.api-call-intro.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1000.agent-upgrade-check.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1100.oceanbase-upgrade-check.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1200.upgrade-agent.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1300.upgrade-oceanbase.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1400.scale-out.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1500.get-public-key.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1600.get-status.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1800.get-oceanbase-info.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/1900.operate-dag.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/200.public-key-encryption-authentication.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2000.get-dag-detail.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2100.get-node-detail.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2200.get-sub-task-detail.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2300.get-all-unfinish-task.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2400.get-agent-unfinish-task.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2500.get-oceanbase-unfinish-task.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2600.get-oceanbase-last-o-m-task.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/2700.get-agent-last-o-m-task.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/300.add-new-node.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/400.delete-node.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/410.set-cluster-level.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/500.set-server-level.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/600.init-cluster.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/700.start-cluster.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/800.stop-cluster.md (100%) rename en-US/700.reference/1500.command-line-tools/{1800.obshell => 100.manage/100.obshell}/400.obshell-api-reference/900.upload-rpm.md (100%) rename en-US/700.reference/1500.command-line-tools/{800.ob-admin => 100.manage/200.ob-admin}/100.overview-of-ob-admin.md (100%) rename en-US/700.reference/1500.command-line-tools/{800.ob-admin => 100.manage/200.ob-admin}/300.clog/300.clog-tool.md (100%) rename en-US/700.reference/1500.command-line-tools/{800.ob-admin => 100.manage/200.ob-admin}/300.clog/400.format-of-clogs.md (100%) rename en-US/700.reference/1500.command-line-tools/{800.ob-admin => 100.manage/200.ob-admin}/300.clog/500.transaction-information-of-clog.md (100%) rename en-US/700.reference/1500.command-line-tools/{800.ob-admin => 100.manage/200.ob-admin}/500.dumpsst.md (100%) rename en-US/700.reference/1500.command-line-tools/{800.ob-admin => 100.manage/200.ob-admin}/600.dump-backup.md (100%) rename en-US/700.reference/1500.command-line-tools/{1000.ob-error.md => 100.manage/300.ob-error.md} (100%) rename en-US/700.reference/{1400.oceanbase-tools/700.oceanbase-deployer.md => 1500.command-line-tools/100.manage/600.oceanbase-deployer.md} (100%) rename en-US/700.reference/1500.command-line-tools/{1700.overview-of-ob-operator.md => 100.manage/700.overview-of-ob-operator.md} (100%) rename en-US/700.reference/1500.command-line-tools/{1600.overview-of-obdiag.md => 200.monitor-and-diagnos/100.overview-of-obdiag.md} (100%) rename en-US/700.reference/1500.command-line-tools/{1250.sql_diagnoser => 200.monitor-and-diagnos/200.sql_diagnoser}/100.overview-of-sql_diagnoser.md (100%) rename en-US/700.reference/1500.command-line-tools/{1250.sql_diagnoser => 200.monitor-and-diagnos/200.sql_diagnoser}/200.deploy-and-use-delsql_diagnoser/100.install-and-deploy-sql_diagnoser.md (100%) rename en-US/700.reference/1500.command-line-tools/{1250.sql_diagnoser => 200.monitor-and-diagnos/200.sql_diagnoser}/200.deploy-and-use-delsql_diagnoser/200.sql_diagnoser-development-guide.md (100%) rename en-US/700.reference/1500.command-line-tools/{1250.sql_diagnoser => 200.monitor-and-diagnos/200.sql_diagnoser}/300.sql_diagnoser-paramenters/100.sql_diagnoser-diagnoser-items.md (100%) rename en-US/700.reference/1500.command-line-tools/{1250.sql_diagnoser => 200.monitor-and-diagnos/200.sql_diagnoser}/300.sql_diagnoser-paramenters/200.sql_diagnoser-expression.md (100%) rename en-US/700.reference/1500.command-line-tools/{1250.sql_diagnoser => 200.monitor-and-diagnos/200.sql_diagnoser}/300.sql_diagnoser-paramenters/300.sql_diagnoser-api.md (100%) rename en-US/700.reference/1500.command-line-tools/{1250.sql_diagnoser => 200.monitor-and-diagnos/200.sql_diagnoser}/300.sql_diagnoser-paramenters/400.sql_diagnoser-review-items.md (100%) rename en-US/700.reference/1500.command-line-tools/{1200.dooba.md => 200.monitor-and-diagnos/300.dooba.md} (100%) rename en-US/700.reference/1500.command-line-tools/{1700.oblogproxy-overview.md => 300.data-integrate/100.oblogproxy-overview.md} (100%) rename en-US/700.reference/{1400.oceanbase-tools/500.oceanbase-loader-dumper.md => 1500.command-line-tools/300.data-integrate/200.oceanbase-loader-dumper.md} (100%) rename en-US/700.reference/1500.command-line-tools/{1500.ob-partition-calculator => 300.data-integrate/300.ob-partition-calculator}/100.introduction-ob-partition-calculator.md (100%) rename en-US/700.reference/1500.command-line-tools/{1500.ob-partition-calculator => 300.data-integrate/300.ob-partition-calculator}/200.use-of-the-ob-partition-calculator.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/100.overview-of-cdc.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/200.obcdc/100.deploy-and-use-obcdc/100.install-and-deploy-obcdc.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/200.obcdc/100.deploy-and-use-obcdc/200.obcdc-development-instructions.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/200.obcdc/100.deploy-and-use-obcdc/300.obcdc-tailf.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/200.obcdc/200.obcdc-parameters/100.general-obcdc-configuration-items.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/200.obcdc/300.faq-of-obcdc.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/400.oblogmsg/100.install-and-deploy-oblogmsg.md (100%) rename en-US/700.reference/1500.command-line-tools/{1100.cdc => 300.data-integrate/400.cdc}/400.oblogmsg/200.description-of-some-oblogmsg-interfaces.md (100%) rename en-US/700.reference/1500.command-line-tools/{1300.mysqltest => 400.stress-test-tools/100.mysqltest}/100.install-of-mysqltest.md (100%) rename en-US/700.reference/1500.command-line-tools/{1300.mysqltest => 400.stress-test-tools/100.mysqltest}/200.use-of-case/100.add-a-case.md (100%) rename en-US/700.reference/1500.command-line-tools/{1300.mysqltest => 400.stress-test-tools/100.mysqltest}/200.use-of-case/200.notes-for-case-writing.md (100%) rename en-US/700.reference/1500.command-line-tools/{1300.mysqltest => 400.stress-test-tools/100.mysqltest}/200.use-of-case/300.case-writing-common-commands.md (100%) delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/100.about-obagent/100.what-is-obagent.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/100.kv-configuration-file.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/150.mgragent-configuration-file.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/200.monagent-configuration-file.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/251.module_config.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/300.prometheus-configuration-file.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/100.install-obagent.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/200.manually-deploy-obagent.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/300.use-obd-to-deploy-obagent.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/100.metrics-exposed-by-exporter.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/200.system-statistics.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/500.obagent-development-guide.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/600.use-obagent-to-collect-mysql-performance-metrics.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/700.query-expressions-for-general-metrics.md delete mode 100644 en-US/700.reference/1500.command-line-tools/900.ob-agent/800.frequently-reported-alerts.md diff --git a/.menu_en.yml b/.menu_en.yml index b38148a3e9..53ceb75174 100644 --- a/.menu_en.yml +++ b/.menu_en.yml @@ -500,39 +500,30 @@ 700.route-management=Route management 400.odp-routing-policy=ODP routing policy 1300.drivers=Drivers - 1400.oceanbase-tools=Platform tools + 1400.platform-products=Platforms 400.1.ocp-express=OCP Express - 1500.command-line-tools=Command line tools - 800.ob-admin=ob_admin - 300.clog=clog - 900.ob-agent=OBAgent - 100.about-obagent=About OBAgent - 200.configuration-reference=Configuration reference - 300.install-and-deploy-obagent=Install and deploy OBAgent - 400.obagent-metrics=OBAgent metrics - 1100.cdc=CDC - 200.obcdc=obcdc - 100.deploy-and-use-obcdc=Deploy and use obcdc - 200.obcdc-parameters=obcdc parameters - 400.oblogmsg=oblogmsg - 1250.sql_diagnoser=SQL diagnoser - 200.deploy-and-use-delsql_diagnoser=Deploy and use SQL diagnoser - 300.sql_diagnoser-paramenters=SQL diagnoser remarks - 1300.mysqltest=mysqltest - 200.use-of-case=Use of cases - # 1400.ob-operator=ob-operator - # 500.ob-operator-user-guide=User guide - # 100.cluster-management-of-ob-operator=Manage clusters - # 200.cluster-scale-out-of-ob-operator=Scale out clusters - # 300.cluster-scale-in-of-ob-operator=Scale in clusters - # 200.tenant-management-of-ob-operator=Manage tenants - # 200.modify-tenant-of-ob-operator=Modify tenants - # 300.backup-recovery-of-ob-operator=Backup and restore - 1500.ob-partition-calculator=Partition calculator - 1800.obshell=OBShell - 210.use-case=Use OBShell - 300.obshell-clients=Command line - 400.obshell-api-reference=API references + 1500.components-and-tools=Components & tools + 100.manage=O & M + 100.obshell=OBShell + 210.use-case=Use OBShell + 300.obshell-clients=Command line + 400.obshell-api-reference=API references + 200.ob-admin=ob_admin + 300.clog=clog + 200.monitor-and-diagnos=Monitoring and diagnostics + 200.sql_diagnoser=SQL diagnoser + 200.deploy-and-use-delsql_diagnoser=Deploy and use SQL diagnoser + 300.sql_diagnoser-paramenters=SQL diagnoser remarks + 300.data-integrate=Data integration + 300.ob-partition-calculator=Partition calculator + 400.cdc=CDC + 200.obcdc=obcdc + 100.deploy-and-use-obcdc=Deploy and use obcdc + 200.obcdc-parameters=obcdc parameters + 400.oblogmsg=oblogmsg + 400.stress-test-tools=Stress testing tools + 100.mysqltest=mysqltest + 200.use-of-case=Use of cases 800.FAQ=FAQ 900.release-notes=Release Notes 10100.enterprise-edition-history-release=OceanBase Database Enterprise Edition diff --git a/en-US/700.reference/1400.oceanbase-tools/100.oceanbase-migration-assessment.md b/en-US/700.reference/1400.platform-products/100.oceanbase-migration-assessment.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/100.oceanbase-migration-assessment.md rename to en-US/700.reference/1400.platform-products/100.oceanbase-migration-assessment.md diff --git a/en-US/700.reference/1400.oceanbase-tools/200.oceanbase-migration-service.md b/en-US/700.reference/1400.platform-products/200.oceanbase-migration-service.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/200.oceanbase-migration-service.md rename to en-US/700.reference/1400.platform-products/200.oceanbase-migration-service.md diff --git a/en-US/700.reference/1400.oceanbase-tools/300.oceanbase-cloud-platform.md b/en-US/700.reference/1400.platform-products/300.oceanbase-cloud-platform.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/300.oceanbase-cloud-platform.md rename to en-US/700.reference/1400.platform-products/300.oceanbase-cloud-platform.md diff --git a/en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/100.ocp-express.md b/en-US/700.reference/1400.platform-products/400.1.ocp-express/100.ocp-express.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/100.ocp-express.md rename to en-US/700.reference/1400.platform-products/400.1.ocp-express/100.ocp-express.md diff --git a/en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/200.ocp-express-cluster-overview.md b/en-US/700.reference/1400.platform-products/400.1.ocp-express/200.ocp-express-cluster-overview.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/200.ocp-express-cluster-overview.md rename to en-US/700.reference/1400.platform-products/400.1.ocp-express/200.ocp-express-cluster-overview.md diff --git a/en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/300.ocp-express-tenants-management.md b/en-US/700.reference/1400.platform-products/400.1.ocp-express/300.ocp-express-tenants-management.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/300.ocp-express-tenants-management.md rename to en-US/700.reference/1400.platform-products/400.1.ocp-express/300.ocp-express-tenants-management.md diff --git a/en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/400.ocp-express-monitoring-center.md b/en-US/700.reference/1400.platform-products/400.1.ocp-express/400.ocp-express-monitoring-center.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/400.ocp-express-monitoring-center.md rename to en-US/700.reference/1400.platform-products/400.1.ocp-express/400.ocp-express-monitoring-center.md diff --git a/en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/500.ocp-express-diagnosis-center.md b/en-US/700.reference/1400.platform-products/400.1.ocp-express/500.ocp-express-diagnosis-center.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/500.ocp-express-diagnosis-center.md rename to en-US/700.reference/1400.platform-products/400.1.ocp-express/500.ocp-express-diagnosis-center.md diff --git a/en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/600.ocp-express-log-service.md b/en-US/700.reference/1400.platform-products/400.1.ocp-express/600.ocp-express-log-service.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/400.1.ocp-express/600.ocp-express-log-service.md rename to en-US/700.reference/1400.platform-products/400.1.ocp-express/600.ocp-express-log-service.md diff --git a/en-US/700.reference/1400.oceanbase-tools/400.oceanbase-developer-center.md b/en-US/700.reference/1400.platform-products/400.oceanbase-developer-center.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/400.oceanbase-developer-center.md rename to en-US/700.reference/1400.platform-products/400.oceanbase-developer-center.md diff --git a/en-US/700.reference/1400.oceanbase-tools/600.oceanbase-admin-tool.md b/en-US/700.reference/1400.platform-products/600.oceanbase-admin-tool.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/600.oceanbase-admin-tool.md rename to en-US/700.reference/1400.platform-products/600.oceanbase-admin-tool.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/100.obshell-intro.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/100.obshell-intro.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/100.obshell-intro.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/100.obshell-intro.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/210.use-case/100.start-stop-obshell.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/210.use-case/100.start-stop-obshell.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/210.use-case/100.start-stop-obshell.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/210.use-case/100.start-stop-obshell.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/300.obshell-clients/200.cluster-commands.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/200.cluster-commands.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/300.obshell-clients/200.cluster-commands.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/200.cluster-commands.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/300.obshell-clients/300.utilities-commands.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/300.utilities-commands.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/300.obshell-clients/300.utilities-commands.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/300.utilities-commands.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/100.api-call-intro.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/100.api-call-intro.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/100.api-call-intro.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/100.api-call-intro.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1000.agent-upgrade-check.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1000.agent-upgrade-check.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1000.agent-upgrade-check.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1000.agent-upgrade-check.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1100.oceanbase-upgrade-check.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1100.oceanbase-upgrade-check.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1100.oceanbase-upgrade-check.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1100.oceanbase-upgrade-check.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1200.upgrade-agent.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1200.upgrade-agent.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1200.upgrade-agent.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1200.upgrade-agent.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1300.upgrade-oceanbase.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1300.upgrade-oceanbase.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1300.upgrade-oceanbase.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1300.upgrade-oceanbase.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1400.scale-out.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1400.scale-out.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1400.scale-out.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1400.scale-out.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1500.get-public-key.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1500.get-public-key.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1500.get-public-key.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1500.get-public-key.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1600.get-status.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1600.get-status.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1600.get-status.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1600.get-status.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1800.get-oceanbase-info.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1800.get-oceanbase-info.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1800.get-oceanbase-info.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1800.get-oceanbase-info.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1900.operate-dag.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1900.operate-dag.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/1900.operate-dag.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/1900.operate-dag.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/200.public-key-encryption-authentication.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/200.public-key-encryption-authentication.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/200.public-key-encryption-authentication.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/200.public-key-encryption-authentication.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2000.get-dag-detail.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2000.get-dag-detail.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2000.get-dag-detail.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2000.get-dag-detail.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2100.get-node-detail.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2100.get-node-detail.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2100.get-node-detail.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2100.get-node-detail.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2200.get-sub-task-detail.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2200.get-sub-task-detail.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2200.get-sub-task-detail.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2200.get-sub-task-detail.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2300.get-all-unfinish-task.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2300.get-all-unfinish-task.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2300.get-all-unfinish-task.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2300.get-all-unfinish-task.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2400.get-agent-unfinish-task.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2400.get-agent-unfinish-task.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2400.get-agent-unfinish-task.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2400.get-agent-unfinish-task.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2500.get-oceanbase-unfinish-task.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2500.get-oceanbase-unfinish-task.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2500.get-oceanbase-unfinish-task.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2500.get-oceanbase-unfinish-task.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2600.get-oceanbase-last-o-m-task.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2600.get-oceanbase-last-o-m-task.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2600.get-oceanbase-last-o-m-task.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2600.get-oceanbase-last-o-m-task.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2700.get-agent-last-o-m-task.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2700.get-agent-last-o-m-task.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/2700.get-agent-last-o-m-task.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/2700.get-agent-last-o-m-task.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/300.add-new-node.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/300.add-new-node.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/300.add-new-node.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/300.add-new-node.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/400.delete-node.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/400.delete-node.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/400.delete-node.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/400.delete-node.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/410.set-cluster-level.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/410.set-cluster-level.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/410.set-cluster-level.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/410.set-cluster-level.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/500.set-server-level.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/500.set-server-level.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/500.set-server-level.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/500.set-server-level.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/600.init-cluster.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/600.init-cluster.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/600.init-cluster.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/600.init-cluster.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/700.start-cluster.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/700.start-cluster.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/700.start-cluster.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/700.start-cluster.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/800.stop-cluster.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/800.stop-cluster.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/800.stop-cluster.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/800.stop-cluster.md diff --git a/en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/900.upload-rpm.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/900.upload-rpm.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1800.obshell/400.obshell-api-reference/900.upload-rpm.md rename to en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/900.upload-rpm.md diff --git a/en-US/700.reference/1500.command-line-tools/800.ob-admin/100.overview-of-ob-admin.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/100.overview-of-ob-admin.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/800.ob-admin/100.overview-of-ob-admin.md rename to en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/100.overview-of-ob-admin.md diff --git a/en-US/700.reference/1500.command-line-tools/800.ob-admin/300.clog/300.clog-tool.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/300.clog-tool.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/800.ob-admin/300.clog/300.clog-tool.md rename to en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/300.clog-tool.md diff --git a/en-US/700.reference/1500.command-line-tools/800.ob-admin/300.clog/400.format-of-clogs.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/400.format-of-clogs.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/800.ob-admin/300.clog/400.format-of-clogs.md rename to en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/400.format-of-clogs.md diff --git a/en-US/700.reference/1500.command-line-tools/800.ob-admin/300.clog/500.transaction-information-of-clog.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/500.transaction-information-of-clog.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/800.ob-admin/300.clog/500.transaction-information-of-clog.md rename to en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/500.transaction-information-of-clog.md diff --git a/en-US/700.reference/1500.command-line-tools/800.ob-admin/500.dumpsst.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/500.dumpsst.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/800.ob-admin/500.dumpsst.md rename to en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/500.dumpsst.md diff --git a/en-US/700.reference/1500.command-line-tools/800.ob-admin/600.dump-backup.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/600.dump-backup.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/800.ob-admin/600.dump-backup.md rename to en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/600.dump-backup.md diff --git a/en-US/700.reference/1500.command-line-tools/1000.ob-error.md b/en-US/700.reference/1500.command-line-tools/100.manage/300.ob-error.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1000.ob-error.md rename to en-US/700.reference/1500.command-line-tools/100.manage/300.ob-error.md diff --git a/en-US/700.reference/1400.oceanbase-tools/700.oceanbase-deployer.md b/en-US/700.reference/1500.command-line-tools/100.manage/600.oceanbase-deployer.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/700.oceanbase-deployer.md rename to en-US/700.reference/1500.command-line-tools/100.manage/600.oceanbase-deployer.md diff --git a/en-US/700.reference/1500.command-line-tools/1700.overview-of-ob-operator.md b/en-US/700.reference/1500.command-line-tools/100.manage/700.overview-of-ob-operator.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1700.overview-of-ob-operator.md rename to en-US/700.reference/1500.command-line-tools/100.manage/700.overview-of-ob-operator.md diff --git a/en-US/700.reference/1500.command-line-tools/1600.overview-of-obdiag.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/100.overview-of-obdiag.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1600.overview-of-obdiag.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/100.overview-of-obdiag.md diff --git a/en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/100.overview-of-sql_diagnoser.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/100.overview-of-sql_diagnoser.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/100.overview-of-sql_diagnoser.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/100.overview-of-sql_diagnoser.md diff --git a/en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/100.install-and-deploy-sql_diagnoser.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/100.install-and-deploy-sql_diagnoser.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/100.install-and-deploy-sql_diagnoser.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/100.install-and-deploy-sql_diagnoser.md diff --git a/en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/200.sql_diagnoser-development-guide.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/200.sql_diagnoser-development-guide.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/200.sql_diagnoser-development-guide.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/200.deploy-and-use-delsql_diagnoser/200.sql_diagnoser-development-guide.md diff --git a/en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/100.sql_diagnoser-diagnoser-items.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/100.sql_diagnoser-diagnoser-items.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/100.sql_diagnoser-diagnoser-items.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/100.sql_diagnoser-diagnoser-items.md diff --git a/en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/200.sql_diagnoser-expression.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/200.sql_diagnoser-expression.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/200.sql_diagnoser-expression.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/200.sql_diagnoser-expression.md diff --git a/en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/300.sql_diagnoser-api.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/300.sql_diagnoser-api.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/300.sql_diagnoser-api.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/300.sql_diagnoser-api.md diff --git a/en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/400.sql_diagnoser-review-items.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/400.sql_diagnoser-review-items.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1250.sql_diagnoser/300.sql_diagnoser-paramenters/400.sql_diagnoser-review-items.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/200.sql_diagnoser/300.sql_diagnoser-paramenters/400.sql_diagnoser-review-items.md diff --git a/en-US/700.reference/1500.command-line-tools/1200.dooba.md b/en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/300.dooba.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1200.dooba.md rename to en-US/700.reference/1500.command-line-tools/200.monitor-and-diagnos/300.dooba.md diff --git a/en-US/700.reference/1500.command-line-tools/1700.oblogproxy-overview.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/100.oblogproxy-overview.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1700.oblogproxy-overview.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/100.oblogproxy-overview.md diff --git a/en-US/700.reference/1400.oceanbase-tools/500.oceanbase-loader-dumper.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/200.oceanbase-loader-dumper.md similarity index 100% rename from en-US/700.reference/1400.oceanbase-tools/500.oceanbase-loader-dumper.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/200.oceanbase-loader-dumper.md diff --git a/en-US/700.reference/1500.command-line-tools/1500.ob-partition-calculator/100.introduction-ob-partition-calculator.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/100.introduction-ob-partition-calculator.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1500.ob-partition-calculator/100.introduction-ob-partition-calculator.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/100.introduction-ob-partition-calculator.md diff --git a/en-US/700.reference/1500.command-line-tools/1500.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1500.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/100.overview-of-cdc.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/100.overview-of-cdc.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/100.overview-of-cdc.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/100.overview-of-cdc.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/100.deploy-and-use-obcdc/100.install-and-deploy-obcdc.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/100.deploy-and-use-obcdc/100.install-and-deploy-obcdc.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/100.deploy-and-use-obcdc/100.install-and-deploy-obcdc.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/100.deploy-and-use-obcdc/100.install-and-deploy-obcdc.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/100.deploy-and-use-obcdc/200.obcdc-development-instructions.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/100.deploy-and-use-obcdc/200.obcdc-development-instructions.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/100.deploy-and-use-obcdc/200.obcdc-development-instructions.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/100.deploy-and-use-obcdc/200.obcdc-development-instructions.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/100.deploy-and-use-obcdc/300.obcdc-tailf.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/100.deploy-and-use-obcdc/300.obcdc-tailf.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/100.deploy-and-use-obcdc/300.obcdc-tailf.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/100.deploy-and-use-obcdc/300.obcdc-tailf.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/200.obcdc-parameters/100.general-obcdc-configuration-items.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/100.general-obcdc-configuration-items.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/200.obcdc-parameters/100.general-obcdc-configuration-items.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/100.general-obcdc-configuration-items.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/300.faq-of-obcdc.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/300.faq-of-obcdc.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/200.obcdc/300.faq-of-obcdc.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/300.faq-of-obcdc.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/400.oblogmsg/100.install-and-deploy-oblogmsg.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/400.oblogmsg/100.install-and-deploy-oblogmsg.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/400.oblogmsg/100.install-and-deploy-oblogmsg.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/400.oblogmsg/100.install-and-deploy-oblogmsg.md diff --git a/en-US/700.reference/1500.command-line-tools/1100.cdc/400.oblogmsg/200.description-of-some-oblogmsg-interfaces.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/400.oblogmsg/200.description-of-some-oblogmsg-interfaces.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1100.cdc/400.oblogmsg/200.description-of-some-oblogmsg-interfaces.md rename to en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/400.oblogmsg/200.description-of-some-oblogmsg-interfaces.md diff --git a/en-US/700.reference/1500.command-line-tools/1300.mysqltest/100.install-of-mysqltest.md b/en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/100.install-of-mysqltest.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1300.mysqltest/100.install-of-mysqltest.md rename to en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/100.install-of-mysqltest.md diff --git a/en-US/700.reference/1500.command-line-tools/1300.mysqltest/200.use-of-case/100.add-a-case.md b/en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/200.use-of-case/100.add-a-case.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1300.mysqltest/200.use-of-case/100.add-a-case.md rename to en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/200.use-of-case/100.add-a-case.md diff --git a/en-US/700.reference/1500.command-line-tools/1300.mysqltest/200.use-of-case/200.notes-for-case-writing.md b/en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/200.use-of-case/200.notes-for-case-writing.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1300.mysqltest/200.use-of-case/200.notes-for-case-writing.md rename to en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/200.use-of-case/200.notes-for-case-writing.md diff --git a/en-US/700.reference/1500.command-line-tools/1300.mysqltest/200.use-of-case/300.case-writing-common-commands.md b/en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/200.use-of-case/300.case-writing-common-commands.md similarity index 100% rename from en-US/700.reference/1500.command-line-tools/1300.mysqltest/200.use-of-case/300.case-writing-common-commands.md rename to en-US/700.reference/1500.command-line-tools/400.stress-test-tools/100.mysqltest/200.use-of-case/300.case-writing-common-commands.md diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/100.about-obagent/100.what-is-obagent.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/100.about-obagent/100.what-is-obagent.md deleted file mode 100644 index 207351adfb..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/100.about-obagent/100.what-is-obagent.md +++ /dev/null @@ -1,23 +0,0 @@ -# What is OBAgent - -This topic describes OceanBase Agent (OBAgent) and its features. - -OBAgent is a framework for data monitoring and collection as well as O&M. In terms of monitoring, OBAgent supports data pushing and pulling for different scenarios. By default, OBAgent supports plug-ins for server data collection, database metrics collection, log collection, monitoring data label processing, and HTTP service of the Prometheus protocol. OBAgent allows you to push data to Pushgateway, vmagent, Elasticsearch, Simple Log Service (SLS), and Alertmanager. To enable data collection from other sources or customize the data processing flow, you only need to develop the corresponding plug-ins. In terms of O&M, OBAgent allows you to configure hot updates. It also provides APIs for OBAgent O&M, file operations, and RPM package operations. You can use these APIs as needed. - -## Features - -OBAgent has the following features: - -* Developed in the Go language, without the necessity for external dependencies -* Plug-in driven, which makes it easy to develop - -## Architecture - -OBAgent consists of four processes: agentd, mgragent, monagent, and agentctl. - -| Process | Description | -|----------|------| -| agentd | Serves as a daemon to start or stop the mgragent and monagent processes. If the mgragent or monagent process exits abnormally, the agentd process automatically restarts them to ensure service availability. The agentd process also runs tasks to limit the CPU utilization and memory usage of the mgragent and monagent processes. | -| mgragent | Provides O&M features, for example, restarts or reinstalls OBAgent, and manages files, installation packages, and configurations. | -| monagent | Monitors database performance parameters, application logs, server performance and resource parameters, tenant resource and performance parameters, and SQL statement and transaction parameters. You can obtain the data collected during monitoring in either pushing or pulling mode. | -| agentctl | Supports O&M on the command-line interface (CLI). The agentctl process does not contain business logic, but provides an operation portal in the form of CLI. It allows you to start or stop processes and change configurations on the CLI. | diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/100.kv-configuration-file.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/100.kv-configuration-file.md deleted file mode 100644 index 91e02daf92..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/100.kv-configuration-file.md +++ /dev/null @@ -1,275 +0,0 @@ -# KV configuration files - -This topic describes the parameters in KV configuration files and provides configuration file templates for your reference. - -```javascript -# Parameters with the encrypted field set to true must be encrypted. Currently, only AES encryption is supported. - -## Basic authentication-related configuration -# basic_auth.yaml -configVersion: "" -configs: - # Username of the agent http API - - key: agent.http.basic.auth.username - value: ocp_agent - valueType: string - # Password of the agent http API - - key: agent.http.basic.auth.password - value: - valueType: string - encrypted: true - # Whether to enable monitoring API authentication - - key: agent.http.basic.auth.metricAuthEnabled - value: true - valueType: string - encrypted: false - -## Metadata parameters -# common_meta.yaml -configVersion: "" -configs: - # Maximum number of backup versions - - key: config.version.maxbackups - value: 30 - valueType: int64 - # Whether to enable the socks proxy - - key: ocp.agent.http.socks.proxy.enabled - value: false - valueType: bool - # Address of the socks proxy - - key: ocp.agent.http.socks.proxy.address - value: "" - valueType: string - # Port of the mgragent process - - key: ocp.agent.manager.http.port - value: 8089 - valueType: int64 - # Port of the monagent process - - key: ocp.agent.monitor.http.port - value: 8088 - valueType: int64 - -## OBAgent log-related configuration -# log.yaml -configVersion: "" -configs: - # Log level of the monagent process - - key: monagent.log.level - value: info - valueType: string - # Size of a single log file for the monagent process - - key: monagent.log.maxsize.mb - value: 200 - valueType: int64 - # Maximum number of days for which logs of the monagent process are retained - - key: monagent.log.maxage.days - value: 30 - valueType: int64 - # Maximum number of log files for the monagent process - - key: monagent.log.maxbackups - value: 15 - valueType: int64 - # Whether to compress logs for the monagent process - - key: monagent.log.compress - value: true - valueType: bool - # Log level of the mgragent process - - key: mgragent.log.level - value: info - valueType: string - # Size of a single log file for the mgragent process - - key: mgragent.log.maxsize.mb - value: 200 - valueType: int64 - # Maximum number of days for which logs of the mgragent process are retained - - key: mgragent.log.maxage.days - value: 30 - valueType: int64 - # Maximum number of log files for the mgragent process - - key: mgragent.log.maxbackups - value: 15 - valueType: int64 - # Whether to compress logs for the mgragent process - - key: mgragent.log.compress - value: true - valueType: bool - -## observer log cleanup-related configuration -# ob_logcleaner.yaml -configVersion: "" -configs: - # Whether to clean up observer logs - - key: ob.logcleaner.enabled - value: false - valueType: bool - # Interval at which observer logs are to be cleaned up - - key: ob.logcleaner.run.internal - value: 5m - valueType: string - # The disk usage, in percentage, of observer logs that triggers cleanup - - key: ob.logcleaner.ob_log.disk.threshold - value: 80 - valueType: int64 - # Number of days for which observer logs are retained according to level 0 rule for cleanup - - key: ob.logcleaner.ob_log.rule0.retention.days - value: 8 - valueType: int64 - # Percentage of observer logs retained according to level 0 rule for cleanup - - key: ob.logcleaner.ob_log.rule0.keep.percentage - value: 60 - valueType: int64 - # Number of days for which observer logs are retained according to level 1 rule for cleanup - - key: ob.logcleaner.ob_log.rule1.retention.days - value: 30 - valueType: int64 - # Percentage of observer logs retained according to level 1 rule for cleanup - - key: ob.logcleaner.ob_log.rule1.keep.percentage - value: 80 - valueType: int64 - # The disk usage, in percentage, of core files that triggers cleanup - - key: ob.logcleaner.core_log.disk.threshold - value: 80 - valueType: int64 - # Number of days for which core files can be retained before they are cleaned up - - key: ob.logcleaner.core_log.rule0.retention.days - value: 8 - valueType: int64 - # Percentage of core files retained after cleanup - - key: ob.logcleaner.core_log.rule0.keep.percentage - value: 60 - valueType: int64 - -## Pipeline-related configuration -# monagent_pipeline.yaml -configVersion: "" -configs: - # Username of the observer monitoring user - - key: monagent.ob.monitor.user - value: ocp_monitor - valueType: string - # Password of the observer monitoring user - - key: monagent.ob.monitor.password - value: - valueType: string - encrypted: true - # observer SQL port - - key: monagent.ob.sql.port - value: 2881 - valueType: int64 - # observer RPC port - - key: monagent.ob.rpc.port - value: 2882 - valueType: int64 - # Host IP address - - key: monagent.host.ip - value: xxx.xxx.xxx.xxx - valueType: string - # observer cluster name - - key: monagent.ob.cluster.name - value: "" - valueType: string - # observer cluster ID - - key: monagent.ob.cluster.id - value: 0 - valueType: int64 - # observer zone name - - key: monagent.ob.zone.name - value: "" - valueType: string - # Status of the observer monitoring and collection pipeline - - key: monagent.pipeline.ob.status - value: inactive - valueType: string - # Status of the host monitoring and collection pipeline - - key: monagent.pipeline.node.status - value: active - valueType: string - # observer log path - - key: ob.log.path - value: /data/log1 - valueType: string - # observer data path - - key: ob.data.path - value: /data/1 - valueType: string - # observer installation path - - key: ob.install.path - value: /home/admin/oceanbase - valueType: string - # Read-only mount point of the host - - key: host.check.readonly.mountpoint - value: / - valueType: string - # Status of the observer log collection pipeline - - key: monagent.pipeline.ob.log.status - value: inactive - valueType: string - # Address of the es client - - key: es.client.addresses - value: "" - valueType: string - # Username of the Elasticsearch client - - key: es.client.auth.username - value: "" - valueType: string - # User password of the Elasticsearch client - - key: es.client.auth.password - value: - valueType: string - encrypted: true - # observer log path - - key: observer.log.path - value: /home/admin/oceanbase/log - valueType: string - # OBAgent log path - - key: agent.log.path - value: /home/admin/ocp_agent/log - valueType: string - # System log path - - key: os.log.path - value: /var/log - valueType: string - # Monitoring data collection interval, in seconds - - key: monagent.second.metric.cache.update.interval - value: 15s - valueType: string - # Username of the MySQL monitoring user - - key: monagent.mysql.monitor.user - value: mysql_monitor_user - valueType: string - # Password of the MySQL monitoring user - - key: monagent.mysql.monitor.password - value: - valueType: string - encrypted: true - # SQL port of MySQL - - key: monagent.mysql.sql.port - value: 3306 - valueType: int64 - # MySQL address - - key: monagent.mysql.host - value: xxx.xxx.xxx.xxx - valueType: string - # Alertmanager address - - key: monagent.alertmanager.address - value: - valueType: string - # Status of the Alertmanager push pipeline - - key: monagent.pipeline.ob.alertmanager.status - value: inactive - valueType: string - # Status of the MySQL pipeline - - key: monagent.pipeline.mysql.status - value: inactive - valueType: string -``` - -## Configuration templates - -The following KV configuration file templates are available: - -* `basic_auth.yaml`: KV parameters related to basic authentication. -* `common_meta.yaml`: KV parameters related to metadata. -* `log.yaml`: KV parameters related to OBAgent logs. -* `ob_logcleaner.yaml`: KV parameters related to observer log cleanup. -* `monagent_pipeline.yaml`: KV parameters related to the pipeline. diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/150.mgragent-configuration-file.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/150.mgragent-configuration-file.md deleted file mode 100644 index c5de382741..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/150.mgragent-configuration-file.md +++ /dev/null @@ -1,29 +0,0 @@ -# mgragent configuration file - -This topic describes the parameters in the `mgragent.yaml` file and provides a configuration file template for your reference. Most parameters are represented by `${config_key}`. `${config_key}` is associated with KV parameters in `config_properties` and is replaced when OBAgent is started. - -The following example describes a template of the `mgragent.yaml` file: - -```yaml - -## Installation-related configuration. Specify the home path of OBAgent. -install: - path: ${obagent.home.path} - -## Process-related configuration. Here, address specifies the default API for metrics pulling and management and pprof debugging. -server: - address: xxx.xxx.xxx.xxx:${ocp.agent.mgragent.http.port} - runDir: ${obagent.home.path}/run - -## SDK configuration. The parameters can be encrypted by using the AES algorithm or left in plain text. If you want to encrypt the parameters by using the AES algorithm, use the key file specified by `cryptoPath`. -## `moduleConfigDir` specifies the directory where the configuration template is stored, and `configPropertiesDir` specifies the directory where the KV variables are stored. -sdkConfig: - configPropertiesDir: ${obagent.home.path}/conf/config_properties - moduleConfigDir: ${obagent.home.path}/conf/module_config - cryptoPath: ${obagent.home.path}/conf/.config_secret.key - cryptoMethod: aes - -## Command template configuration. Specify the configuration template file for the mgragent process. -shellf: - template: ${obagent.home.path}/conf/shell_templates/shell_template.yaml -``` diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/200.monagent-configuration-file.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/200.monagent-configuration-file.md deleted file mode 100644 index d1af69d0f8..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/200.monagent-configuration-file.md +++ /dev/null @@ -1,24 +0,0 @@ -# monagent configuration file - -This topic describes the parameters in the `monagent.yaml` file and provides a configuration file template for your reference. Most parameters are represented by `${config_key}`. `${config_key}` is associated with KV parameters in `config_properties` and is replaced when OBAgent is started. - -The following example describes a template of the `monagent.yaml` file: - -```yaml -## Process-related configuration. Here, address specifies the default API for metrics pulling and management and pprof debugging. -server: - address: xxx.xxx.xxx.xxx:${ocp.agent.monitor.http.port} - runDir: ${obagent.home.path}/run - -## Parameters related to configuration. The parameters can be encrypted by using AES algorithm or left in plain text. If you want to encrypt the parameters by using the AES algorithm, use the key file specified by `cryptoPath`. -## `modulePath` specifies the directory where the configuration template is stored, and `propertiesPath` specifies the directory where the KV variables are stored. -cryptoMethod: aes -cryptoPath: ${obagent.home.path}/conf/.config_secret.key -modulePath: ${obagent.home.path}/conf/module_config -propertiesPath: ${obagent.home.path}/conf/config_properties -``` - -where - -`{ocp.agent.monitor.http.port}` indicates the port for the monagent process. This port is not dependent on OCP. -`{obagent.home.path}` indicates the installation directory of OBAgent. \ No newline at end of file diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/251.module_config.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/251.module_config.md deleted file mode 100644 index d404501d57..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/251.module_config.md +++ /dev/null @@ -1,21 +0,0 @@ -# Configuration template files - -The configuration template files define the configuration templates for modules and the monitoring pipelines. Most parameters are represented by `${config_key}`. `${config_key}` is associated with KV parameters in `config_properties` and is replaced when OBAgent is started. - -The following table describes the configuration template files. - -| Configuration file | Description | -| --- | --- -| common_module.yaml | Specifies the metadata configuration of the monagent and mgragent processes. | -| log_module.yaml | Specifies the log configuration of the mongagent and mgragent processes. | -| mgragent_logquerier_module.yaml | Specifies the log collection configuration of OceanBase Database and OBAgent. | -| mgragent_module.yaml | Specifies the configuration of mgragent authentication and configuration updates. | -| monagent_basic_auth.yaml | Specifies the configuration of monagent authentication. | -| monitor_host_log.yaml | Specifies the configuration of the Elasticsearch pipeline for host log collection and pushing. | -| monitor_mysql.yaml | Specifies the configuration of the MySQL monitoring and collection pipeline. | -| monitor_node_host.yaml | Specifies the configuration of the host monitoring and collection pipeline. | -| monitor_ob.yaml | Specifies the configuration of the OceanBase Database performance monitoring and collection pipeline. | -| monitor_ob_custom.yaml | Specifies the configuration of the OceanBase Database connection and process monitoring pipeline. | -| monitor_ob_log.yaml | Specifies the configuration of the OceanBase Database error log collection pipeline. | -| monitor_observer_log.yaml | Specifies the configuration of the Elasticsearch pipeline for OceanBase Database log collection and pushing. | -| ob_logcleaner_module.yaml | Specifies the configuration of OceanBase Database log cleanup. | diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/300.prometheus-configuration-file.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/300.prometheus-configuration-file.md deleted file mode 100644 index b3257f3845..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/200.configuration-reference/300.prometheus-configuration-file.md +++ /dev/null @@ -1,72 +0,0 @@ -# Prometheus configuration file - -This topic describes the parameters in the Prometheus configuration file and provides a configuration file template for your reference. - -## Prometheus configuration template - -The following example describes the template of the `prometheus.yaml` file: - -```yaml -# The Prometheus configuration template is included in the RPM Package of the OBAgent. You can modify the configuration as needed. -# To enable basic authentication, specify {http_basic_auth_user} and {http_basic_auth_password}. -# Replace {target} with the IP address and port number of the host to be monitored. If multiple hosts need to be monitored, configure multiple lines, with each line representing one host. -# The /rules/ directory includes two alert configuration templates, one for the default host and the other for OceanBase Database. You can customize the alert rules by using these two templates. - -# Global configuration. -global: - # The scrape interval. - scrape_interval: 1s - # The rule evaluation interval. - evaluation_interval: 10s - -# Configure the alert rules. -# Prometheus pushes alert information to Prometheus Alertmanager based on this information. -rule_files: - - "rules/*rules.yaml" - -# Scrape configuration -# Configure Prometheus for data collection. -scrape_configs: - - job_name: prometheus - metrics_path: /metrics - scheme: http - static_configs: - - targets: - - "localhost:9090" - - job_name: node - basic_auth: - username: { http_basic_auth_user } - password: { http_basic_auth_password } - metrics_path: /metrics/node/host - scheme: http - static_configs: - - targets: - - { target } - - job_name: ob_basic - basic_auth: - username: { http_basic_auth_user } - password: { http_basic_auth_password } - metrics_path: /metrics/ob/basic - scheme: http - static_configs: - - targets: - - { target } - - job_name: ob_extra - basic_auth: - username: { http_basic_auth_user } - password: { http_basic_auth_password } - metrics_path: /metrics/ob/extra - scheme: http - static_configs: - - targets: - - { target } - - job_name: agent - basic_auth: - username: { http_basic_auth_user } - password: { http_basic_auth_password } - metrics_path: /metrics/stat - scheme: http - static_configs: - - targets: - - { target } -``` diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/100.install-obagent.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/100.install-obagent.md deleted file mode 100644 index aa33f91742..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/100.install-obagent.md +++ /dev/null @@ -1,82 +0,0 @@ -# Install OBAgent - -This topic describes how to install OBAgent. You can install OBAgent by using an RPM package or source code. - -## Environment dependency - -Go 1.19 or later is required for OBAgent construction. - -## RPM package - -You can go to the [Release page](https://mirrors.aliyun.com/oceanbase/community/stable/el/7/x86_64/) to download the RPM package of OBAgent and install it by running the following command: - -```shell -rpm -ivh obagent-1.0.0-1.el7.x86_64.rpm -``` - -## Build OBAgent with source code - -### Debug mode - -```shell -make build // make build will be debug mode by default -make build-debug -``` - -### Release mode - -```shell -make build-release -``` - -## Structure of the OBAgent installation directory - -The OBAgent installation directory contains three subdirectories: `bin`, `conf`, and `run`. The following example shows the structure of an OBAgent installation directory: - -```shell -# Example directory structure -. -├── bin -│ ├── ob_monagent -│ ├── ob_mgragent -│ ├── ob_agentd -│ └── ob_agentctl -├── conf -│ ├── config_properties -│ │ ├── basic_auth.yaml -│ │ ├── common_meta.yaml -│ │ ├── log.yaml -│ │ ├── ob_logcleaner.yaml -│ │ └── monagent_pipeline.yaml -│ ├── module_config -│ │ ├── common_module.yaml -│ │ ├── log_module.yaml -│ │ ├── mgragent_logquerier_module.yaml -│ │ ├── mgragent_module.yaml -│ │ ├── monagent_basic_auth.yaml -│ │ ├── monitor_host_log.yaml -│ │ ├── monitor_mysql.yaml -│ │ ├── monitor_node_host.yaml -│ │ ├── monitor_ob.yaml -│ │ ├── monitor_ob_custom.yaml -│ │ ├── monitor_ob_log.yaml -│ │ ├── monitor_observer_log.yaml -│ │ └── ob_logcleaner_module.yaml -│ ├── scripts -│ │ └── obagent.service -│ ├── shell_templates -│ │ └── shell_template.yaml -│ ├── monagent.yaml -│ ├── mgragent.yaml -│ ├── agentd.yaml -│ ├── agentctl.yaml -│ ├── obd_agent_mapper.yaml -│ └── prometheus_config -│ ├── prometheus.yaml -│ └── rules -│ ├── host_rules.yaml -│ └── ob_rules.yaml -└── run -``` - -In the directory above, `bin` stores binary files, `conf` stores program startup configurations, module configuration templates, KV variable settings, and Prometheus configuration templates, `log` stores OBAgent logs, and `run` stores runtime files. For more information about the configuration files, see [monagent configuration file](../200.configuration-reference/200.monagent-configuration-file.md). diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/200.manually-deploy-obagent.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/200.manually-deploy-obagent.md deleted file mode 100644 index b548326efe..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/200.manually-deploy-obagent.md +++ /dev/null @@ -1,95 +0,0 @@ -# Manually deploy OBAgent - -You can deploy OBAgent manually or by using OceanBase Deployer (OBD). To manually deploy OBAgent, you must configure OBAgent and Prometheus. You can also configure Prometheus Alertmanager as needed. This topic describes how to manually deploy OBAgent. - -## Prerequisites - -To deploy OBAgent, ensure that the following requirements are met: - -* You have deployed and started OceanBase Database. -* The default ports 8088 and 8089 of OBAgent are not occupied. You can also define custom ports. - -## Procedure - -### Step 1: Deploy OBAgent - -1. Install OBAgent. - For more information, see [Install OBAgent](100.install-obagent.md). - -2. Modify the configuration files. - For more information, see [monagent configuration file](../200.configuration-reference/200.monagent-configuration-file.md) and [KV configuration files](../200.configuration-reference/100.kv-configuration-file.md). - -3. Start OBAgent. - - ```shell - # Switch to the directory where OBAgent is installed. - cd /home/admin/obagent/bin - # Start the monagent process. - ./ob_agentctl start - ``` - -### (Optional) Step 2: Deploy Prometheus - -
-

Note

-

To perform this operation, you must first install Prometheus.

-
- -1. Configure Prometheus. - For more information, see [Prometheus configuration file](../200.configuration-reference/300.prometheus-configuration-file.md). -2. Copy the configured Prometheus configuration file to the host where Prometheus is deployed and run the following command to start Prometheus: - - ```shell - ./prometheus --config.file=./prometheus.yaml - ``` - -### (Optional) Step 3: Deploy Prometheus Alertmanager - -1. Download and decompress the installation package of the Prometheus Alertmanager. -2. Start the Prometheus Alertmanager. -3. Configure Prometheus Alertmanager. - For more information, see [Prometheus documentation](https://www.prometheus.io/docs/alerting/latest/configuration/). - -OBAgent provides default alert rules. The configuration files are located in `conf/prometheus_config/rules`. The `host_rules.yaml` file stores alert rules for the server, and the `ob_rules.yaml` file stores alert rules for OceanBase Database. If the default alert rules cannot meet your needs, you can customize the rules by using the following method: - -```shell -# To add custom alert rules to the Prometheus configuration file, you must place the configuration file in the conf/prometheus_config/rules directory and name it in the *rule.yaml format. - -groups: -- name: node-alert - rules: - - alert: disk-full - expr: 100 - ((node_filesystem_avail_bytes{mountpoint="/",fstype=~"ext4|xfs"} * 100) / node_filesystem_size_bytes {mountpoint="/",fstype=~"ext4|xfs"}) > 80 - for: 1m - labels: - severity: page - annotations: - summary: "{{ $labels.instance }} disk full " - description: "{{ $labels.instance }} disk > {{ $value }} " -``` - -## (Optional) Step 4: Deploy and configure Grafana - -1. Download and decompress the installation package of Grafana. -2. Start Grafana. - - ```shell - ./bin/grafana-server - ``` - -3. Log on to Grafana and change the password. - The default account and password are both `admin` at initial logon. -4. Configure Prometheus as the data source. - For more information about how to add a data source, see the "[Add a data source](https://grafana.com/docs/grafana/v7.5/datasources/add-a-data-source/)" topic in Grafana documentation. -5. Import the dashboard. - The metric configurations for OceanBase Database and the server are published in Grafana, with the configuration IDs of `15215` and `15216`, respectively. For more information about how to import the dashboard, see the "[Export and import](https://grafana.com/docs/grafana/v7.5/dashboards/export-import/)" topic in Grafana documentation. - -## (Optional) Step 5: Update KV parameters - -OBAgent provides an API for updating configurations. You can update KV parameters by using the ob_agentctl tool: - -```shell -# You can update multiple KV parameters at a time by specifying multiple keys and values. - -./ob_agentctl config -u monagent.pipeline.ob.status=active,monagent.host.ip=127.0.0.1 -``` diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/300.use-obd-to-deploy-obagent.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/300.use-obd-to-deploy-obagent.md deleted file mode 100644 index efbbb0e216..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/300.install-and-deploy-obagent/300.use-obd-to-deploy-obagent.md +++ /dev/null @@ -1,142 +0,0 @@ -# Deploy OBAgent by using OBD - -You can deploy OBAgent manually or by using OceanBase Deployer (OBD). To manually deploy OBAgent, you must configure OBAgent and Prometheus. You can also configure Prometheus Alertmanager as needed. We recommend that you use OBD to deploy OBAgent. This topic describes how to use OBD to deploy OBAgent. - -## Prerequisites - -Before you deploy OBAgent, make sure that the default ports 8088 and 8089 are not occupied. You can also define custom ports. - -
-

Note

-

If your server has access to the Internet, run the obd cluster deploy command. Then, OBD checks the server for the OBAgent installation package. If the package does not exist, OBD automatically obtains the package from the YUM repository.

-
- -## Deploy the OceanBase cluster and OBAgent - -If you want to deploy the OceanBase cluster and OBAgent at the same time, add the following OBAgent configuration to the OceanBase Database configuration file: - -```unknow -obagent: - servers: - - xxx.xxx.xxx.xxx - depends: - - oceanbase-ce - global: - home_path: /root/observer -``` - -
-

Notice

-

The servers field must match the servers field in oceanbase-ce.

-
- -For more information, see [Configuration file](https://github.com/oceanbase/obdeploy/blob/master/example/obagent/distributed-with-obproxy-and-obagent-example.yaml). - -## Deploy OBAgent separately - -OBD does not support adding new components to a deployed cluster. If you want to deploy OBAgent for an existing cluster, deploy OBAgent separately. - -To deploy OBAgent separately, prepare the configuration file of OBAgent. Make sure that the following fields in the configuration file are the same as those in the OceanBase Database configuration file: - -```unknow -obagent: - global: - # The username for HTTP authentication. Default value: admin. - http_basic_auth_user: admin - # Password for HTTP authentication. - http_basic_auth_password: **** - # The username for the debug service. Default value: admin. - pprof_basic_auth_user: admin - # Password for debug service. - pprof_basic_auth_password: **** - - # The following configurations must be consistent with those in the OceanBase cluster configuration file. - # The monitor username for OceanBase Database. The user must have read access to OceanBase Database as a system tenant. Default value: root. - monitor_user: root - # The monitor password for OceanBase Database. By default, this field is empty. When a dependent component exists, OBD gets this value from the oceanbase-ce of the component. The value is the same as the root_password in oceanbase-ce. - monitor_password: - # The SQL port for observer. The default value is 2881. When a depends exists, OBD gets this value from the oceanbase-ce of the depends. The value is the same as the mysql_port in oceanbase-ce. - sql_port: 2881 - # The RPC port for observer. The default value is 2882. When a depends exists, OBD gets this value from the oceanbase-ce of the depends. The value is the same as the rpc_port in oceanbase-ce. - rpc_port: 2882 - # Cluster name for OceanBase Database. When a depends exists, OBD gets this value from the oceanbase-ce of the depends. The value is the same as the appname in oceanbase-ce. - cluster_name: obcluster - # Cluster ID for OceanBase Database. When a depends exists, OBD gets this value from the oceanbase-ce of the depends. The value is the same as the cluster_id in oceanbase-ce. - cluster_id: 1 - # Zone name for your observer. The default value is zone1. When a depends exists, OBD gets this value from the oceanbase-ce of the depends. The value is the same as the zone name in oceanbase-ce. - zone_name: zone1 - # Monitor status for OceanBase Database. Active is to enable. Inactive is to disable. The default value is active. When you deploy a cluster automatically, OBD decides whether to enable this parameter based on depends. -``` - -For more information, see [OBAgent configuration file](https://github.com/oceanbase/obdeploy/blob/master/example/obagent/obagent-only-example.yaml). - -## Start OBAgent - -Run the following commands to start OBAgent: - -```unknow -# Pass in the configuration information. -obd cluster deploy [-c ] [-f] [-U] [-A] -# Start OBAgent. -obd cluster start [flags] -``` - -For more information, see [Cluster commands](https://en.oceanbase.com/docs/community-obd-en-10000000000904961). - -## (Optional) Start Prometheus - -
-

Note

-

You must first install Prometheus.

-
- -OBD will replace the variables in the configuration file template of OBAgent. You can copy this configuration file (`prometheus.yaml`) to the host where Prometheus is deployed, and then run the following command to use the `prometheus.yaml` file to start Prometheus: - -```unknow -./prometheus --config.file=./prometheus.yaml -``` - -## (Optional) Deploy Prometheus Alertmanager - -1. Download and decompress the installation package of the Prometheus Alertmanager. -2. Start the Prometheus Alertmanager. -3. Configure Prometheus Alertmanager. - For more information, see [Prometheus documentation](https://www.prometheus.io/docs/alerting/latest/configuration/). - -OBAgent provides default alert rules. The configuration files are located in `conf/prometheus_config/rules`. The `host_rules.yaml` file stores alert rules for the server, and the `ob_rules.yaml` file stores alert rules for OceanBase Database. If the default alert rules cannot meet your needs, you can customize the rules by using the following method: - -```unknow -# To add custom alert rules to the Prometheus configuration file, you must place the configuration file in the conf/prometheus_config/rules directory and name it in the *rule.yaml format. - -groups: -- name: node-alert - rules: - - alert: disk-full - expr: 100 - ((node_filesystem_avail_bytes{mountpoint="/",fstype=~"ext4|xfs"} * 100) / node_filesystem_size_bytes {mountpoint="/",fstype=~"ext4|xfs"}) > 80 - for: 1m - labels: - severity: page - annotations: - summary: "{{ $labels.instance }} disk full " - description: "{{ $labels.instance }} disk > {{ $value }} " -``` - -## (Optional) Deploy and configure Grafana - -1. Download and decompress the installation package of Grafana. -2. Start Grafana. - - ```unknow - ./bin/grafana-server - ``` - -3. Log on to Grafana and change the password. - The default account and password are both `admin` at initial logon. -4. Set Prometheus as the data source. - For more information about how to add a data source, see the [Add a data source](https://grafana.com/docs/grafana/v7.5/datasources/add-a-data-source/) topic in Grafana documentation. -5. Import the dashboard. - The metric configurations for OceanBase Database and the server are published in Grafana, with the configuration IDs of `15215` and `15216`, respectively. For more information about how to import the dashboard, see the [Export and import](https://grafana.com/docs/grafana/v7.5/dashboards/export-import/) topic in Grafana documentation. - -## (Optional) Update KV parameters - -To update the KV configuration, use `obd cluster edit-config`. For more information, see the `obd cluster edit-config` section in [Cluster commands](https://en.oceanbase.com/docs/community-obd-en-10000000000904961). diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/100.metrics-exposed-by-exporter.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/100.metrics-exposed-by-exporter.md deleted file mode 100644 index 36e4750113..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/100.metrics-exposed-by-exporter.md +++ /dev/null @@ -1,78 +0,0 @@ -# Metrics exposed by the exporter plug-in (Sink) - -The following table describes the metrics exposed by the exporter plug-in (Sink). - -## Host metrics - -| **Metric** | **Label** | **Description** | **Type** | -| --- |--------------------------------| --- | --- | -| node_cpu_seconds_total | cpu, mode, svr_ip | The CPU time. | Counter | -| node_disk_read_bytes_total | device, svr_ip | The total bytes read from the disk. | Counter | -| node_disk_read_time_seconds_total | device, svr_ip | The total time spent on disk read. | Counter | -| node_disk_reads_completed_total | device, svr_ip | The total number of completed disk reads. | Counter | -| node_disk_written_bytes_total | device, svr_ip | The total bytes written to the disk. | Counter | -| node_disk_write_time_seconds_total | device, svr_ip | The total time spent on disk write. | Counter | -| node_disk_writes_completed_total | device, svr_ip | The total number of completed disk writes. | Counter | -| node_disk_io_time_weighted_seconds_total | device, svr_ip | The disk I/O time. | Counter | -| node_filesystem_avail_bytes | device, fstype, mountpoint, svr_ip | The available space of the file system. | Gauge | -| node_filesystem_size_bytes | device, fstype, mountpoint, svr_ip | The total size of the file system. | Gauge | -| node_load1 | svr_ip | The average load per minute. | Gauge | -| node_load5 | svr_ip | The average load in every 5 minutes. | Gauge | -| node_load15 | svr_ip | The average load in every 15 minutes. | Gauge | -| node_memory_Buffers_bytes | svr_ip | The size of the memory buffer. | Gauge | -| node_memory_Cached_bytes | svr_ip | The size of the memory cache. | Gauge | -| node_memory_MemFree_bytes | svr_ip | The size of free memory space. | Gauge | -| node_memory_SReclaimable_bytes | svr_ip | The size of the reclaimable slab memory. | Gauge | -| node_memory_MemTotal_bytes | svr_ip | The total memory size. | Gauge | -| node_network_receive_bytes_total | device, svr_ip | The total bytes received over the network. | Counter | -| node_network_transmit_bytes_total | device, svr_ip | The total bytes sent over the network. | Counter | -| node_ntp_offset_seconds | svr_ip | The NTP clock offset. | Gauge | -| cpu_count | svr_ip | The number of CPU cores. | Gauge | -| node_net_bandwidth_bps | device, svr_ip | The NIC rate. | Gauge | -| io_util | device, svr_ip | The I/O load. | Gauge | -| io_await | device, svr_ip | The I/O time. | Gauge | - -## OceanBase Database metrics - -| **Metric** | **Label** | **Description** | **Type** | -|--------------------------------------------|---------------------------------------------------------------------------------|--------------------| --- | -| ob_active_session_num | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The number of active connections. | Gauge | -| ob_all_session_num | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The total number of connections. | Gauge | -| ob_cache_size_bytes | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name,cache_name | The size of KVCache. | Gauge | -| ob_server_num | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The number of OBServer nodes. | Gauge | -| ob_partition_num | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The number of partitions. | Gauge | -| ob_plan_cache_access_total | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The number of visits to the execution plan. | Counter | -| ob_plan_cache_hit_total | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The number of execution plan hits. | Counter | -| ob_plan_cache_memory_bytes | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The size of the plan cache. | Gauge | -| ob_table_num | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The number of tables. | Gauge | -| ob_waitevent_wait_seconds_total | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The total time spent on waiting for events. | Counter | -| ob_waitevent_wait_total | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The total number of waits for events. | Counter | -| ob_system_event_total_waits | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name,event_group | The total number of waits for system events. | Counter | -| ob_system_event_time_waited | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name,event_group | The total time spent on waiting for system events. | Counter | -| ob_disk_free_bytes | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The remaining disk size of OceanBase Database. | Gauge | -| ob_disk_total_bytes | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The total disk size of OceanBase Database. | Gauge | -| ob_memstore_active_bytes | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The size of active MemStores. | Gauge | -| ob_memstore_freeze_times | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The number of MemStore freezes. | Counter | -| ob_memstore_freeze_trigger_bytes | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The threshold that triggers a MemStore freeze. | Gauge | -| ob_memstore_total_bytes | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The total size of MemStores. | Gauge | -| ob_server_resource_cpu | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The number of CPU cores available for the OBServer node. | Gauge | -| ob_server_resource_cpu_assigned | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The number of CPU cores allocated to the OBServer node. | Gauge | -| ob_server_resource_memory_bytes | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The memory size available for the OBServer node. | Gauge | -| ob_server_resource_memory_assigned_bytes | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The size of memory allocated to the OBServer node. | Gauge | -| ob_server_resource_disk_bytes | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The disk size available for the OBServer node. | Gauge | -| ob_server_resource_cpu_assigned_percent | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The CPU utilization of the OBServer node. | Gauge | -| ob_server_resource_memory_assigned_percent | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The memory usage of the OBServer node. | Gauge | -| ob_tenant_resource_max_cpu | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The maximum number of CPU cores available for the tenant. | Gauge | -| ob_tenant_resource_min_cpu | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The minimum number of CPU cores available for the tenant. | Gauge | -| ob_tenant_resource_max_memory | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The maximum memory size available for the tenant. | Gauge | -| ob_tenant_resource_min_memory | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The minimum memory size available for the tenant. | Gauge | -| ob_tenant_assigned_cpu_total | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The total number of CPU cores for the OBServer node. | Gauge | -| ob_tenant_assigned_cpu_assigned | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The number of CPU cores allocated to the OBServer node. | Gauge | -| ob_tenant_assigned_mem_total | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The total memory size for the OBServer node. | Gauge | -| ob_tenant_assigned_mem_assigned | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The size of memory allocated to the OBServer node. | Gauge | -| ob_tenant_disk_data_size | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The data disk usage of the OBServer node. | Gauge | -| ob_tenant_disk_log_size | ob_cluster_id,ob_cluster_name,obzone,svr_ip,ob_tenant_id,tenant_name | The log disk usage of the OBServer node. | Gauge | -| ob_disk_total_bytes | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The total disk size of the OBServer node. | Gauge | -| ob_disk_free_bytes | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The idle disk size of the OBServer node. | Gauge | -| ob_unit_num | ob_cluster_id, ob_cluster_name, obzone, svr_ip | The number of resource units of the OBServer node. | Gauge | -| ob_sysstat | ob_cluster_id, ob_cluster_name, obzone, svr_ip, tenant_name, stat_id | The internal statistics of OceanBase Database. | `ob_sysstat` varies with `stat_id`. For more information, see the corresponding explanation. | \ No newline at end of file diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/200.system-statistics.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/200.system-statistics.md deleted file mode 100644 index 52cc522a41..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/400.obagent-metrics/200.system-statistics.md +++ /dev/null @@ -1,11 +0,0 @@ -# System statistics - -This topic describes the general statistical events. - -You can use an SQL statement to display all statistical events and their types in alphabetical order in the sys tenant. Here is an example: - -```sql -obclient> SELECT name,class FROM v$statname ORDER BY name; -``` - -For more information about the v$statname view, see [v\$statname](../../../700.system-views/400.system-view-of-mysql-mode/300.performance-view-of-mysql-mode/5600.v-statname-of-mysql-mode.md). diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/500.obagent-development-guide.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/500.obagent-development-guide.md deleted file mode 100644 index 29049f07c1..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/500.obagent-development-guide.md +++ /dev/null @@ -1,69 +0,0 @@ -# OBAgent development guide - -OBAgent is a plug-in driven framework that monitors OceanBase Database and collects its metrics. To extend the features of OBAgent or customize the data processing flow, you can develop corresponding plug-ins as needed. To develop a plug-in, you only need to implement the basic interfaces of the plug-in and the interfaces of the corresponding plug-in type. - -## OBAgent data processing flow - -![OBAgent data processing flowchart](https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/doc/img/observer-enterprise/V4.2.1/700.reference/1500.command-line-tools/900.ob-agent/OBAgent.jpg) - -The data processing flow of OBAgent involves data collection, processing, and reporting. The required plug-ins include the input plug-in (Source), the processing plug-in (Processor), and the output plug-in (Sink). For more information about the plug-ins, see the "External plug-ins" section in this topic. - -## External plug-ins - -The following table lists the types of plug-ins supported by OBAgent. - -| Plug-in | Description | -|----------------|-------------------------------------------| -| Source | A plug-in that collects various time-series metrics, including system information and application information. | -| Processor | A plug-in that processes data in serial mode. | -| Sink | A plug-in that outputs data in pushing or pulling mode. | - -### Definition of the Source plug-in interface - -```javascript -type Source interface { - Start(out chan<- []*message.Message) (err error) - Stop() -} -``` - -The Source plug-in starts to collect data in `Start` and writes the data to `out`. ​ - -### Definition of the Processor plug-in interface - -```javascript -type Processor interface { - Start(in <-chan []*message.Message, out chan<- []*message.Message) (err error) - Stop() -} -``` - -The Processor plug-in reads data from `in`, processes the data, and then writes the processed data to `out`. ​ - -### Definition of the Sink plug-in interface - -```javascript -type Sink interface { - Start(in <-chan []*message.Message) error - Stop() -} -``` - -The Sink plug-in reads data from `in`, and places the data into the cache for pulling in pulling mode, or directly pushes the data to the destination in pushing mode. - -## Data structure of a message - -Data is forwarded as a message in the data processing flow of OBAgent. The data structure of a message is as follows: - -```javascript -type Message struct { - name string - fields []FieldEntry - tags []TagEntry - timestamp time.Time - msgType Type - tagSorted bool - fieldSorted bool - id string -} -``` diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/600.use-obagent-to-collect-mysql-performance-metrics.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/600.use-obagent-to-collect-mysql-performance-metrics.md deleted file mode 100644 index 547eff9d1c..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/600.use-obagent-to-collect-mysql-performance-metrics.md +++ /dev/null @@ -1,56 +0,0 @@ -# Use OBAgent to collect MySQL performance metrics - -OBAgent integrates the mysqld exporter provided by Prometheus. You can use OBAgent to collect MySQL performance metrics. This topic describes how to use OBAgent to collect MySQL performance metrics. - -## Configuration method - -OBAgent packages the pipeline configuration for collecting MySQL performance metrics, which is disabled by default. You can modify the following parameters to enable the collection feature. - -```javascript -# MySQL user for collecting monitoring data. For enabled collection metrics, you must have the read privilege on the corresponding tables. -- key: monagent.mysql.monitor.user - value: mysql_monitor_user - valueType: string -# Password of the monitoring user -- key: monagent.mysql.monitor.password - value: mysql_monitor_password - valueType: string - encrypted: true -# SQL port of MySQL -- key: monagent.mysql.sql.port - value: 3306 - valueType: int64 -# Connection address of MySQL -- key: monagent.mysql.host - value: xxx.xxx.xxx.xxx - valueType: string -# Specifies whether to enable MySQL performance metric collection. The default value is inactive, which indicates that MySQL performance metric collection is disabled. You can change the value to active to enable the collection feature. -- key: monagent.pipeline.mysql.status - value: inactive - valueType: string -``` - -The following example shows the configuration of a MySQL pipeline. - -```javascript -# The current configuration file monitor_mysql.yaml is included in the RPM package of OBAgent. Only the collection plug-in configuration is shown here. - -mysqldInput: &mysqldInput - plugin: mysqldInput - config: - timeout: 10s - pluginConfig: - dsn: ${monagent.mysql.monitor.user}:${monagent.mysql.monitor.password}@(${monagent.mysql.host}:${monagent.mysql.sql.port})/ - scraperFlags: - # Enable the collection of the binlog_size metric. - binlog_size: true - # Disable the collection of the slave_status metric. - slave_status: false -``` - -For metrics to be collected, the default settings of the mysqld exporter are used and do not need to be modified. To modify the setting for a specific metric, you must modify the value of the `scraperFlags` parameter for the `mysqldInput` plug-in. - -
-

Notice

-

The MySQL-related collection configuration is not integrated with OceanBase Deployer (OBD) and must be manually enabled.

-
diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/700.query-expressions-for-general-metrics.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/700.query-expressions-for-general-metrics.md deleted file mode 100644 index 2a8bd218b6..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/700.query-expressions-for-general-metrics.md +++ /dev/null @@ -1,82 +0,0 @@ -# Query expressions for general metrics - -This topic describes the query expressions for general metrics of OBAgent. -When you query general metrics, replace the variables with the specific information to be queried. The variables to be replaced are: - -* @LABELS: Replace it with the filter condition of the specific label. -* @INTERVAL: Replace it with the statistical period. -* @GBLABELS: Replace it with the aggregate label name. - -| **Metric** | **Expression** | **Unit** | -|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| -| Size of active MemStores | `sum(ob_sysstat{stat_id="130000",@LABELS}) by (@GBLABELS) / 1048576` | MB | -| Number of active sessions | `sum(ob_active_session_num{@LABELS}) by ([@GBLABELS)` | - | -| Hit rate of the block cache | `100 * 1 / (1 + sum(rate(ob_sysstat{stat_id="50009",@LABELS}[@INTERVAL])) by ([@GBLABELS) ](/GBLABELS)) / sum(rate(ob_sysstat{stat_id="50008",@LABELS}[@INTERVAL])) by (@GBLABELS))` | % | -| Size of the block cache | `sum(ob_cache_size_bytes{cache_name="user_block_cache",@LABELS}) by ([@GBLABELS) ](/GBLABELS)) / 1048576` | MB | -| Total size of transaction logs committed per second | `sum(rate(ob_sysstat{stat_id="80057",@LABELS}[@INTERVAL])) by ([@GBLABELS) ](/GBLABELS))` | Byte | -| Average time spent on writing transaction logs to the disk each time | `sum(rate(ob_sysstat{stat_id="80041",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="80040",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| CPU utilization | `100 * (1 - sum(rate(node_cpu_seconds_total{mode="idle", @LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(node_cpu_seconds_total{@LABELS}[@INTERVAL])) by (@GBLABELS))` | % | -| Size of used space in the disk partition | `sum(node_filesystem_size_bytes{@LABELS} - node_filesystem_avail_bytes{@LABELS}) by (@GBLABELS) / 1073741824` | GB | -| Number of reads per second | `avg(rate(node_disk_reads_completed_total{@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Amount of data read each time | `avg(rate(node_disk_read_bytes_total{@LABELS}[@INTERVAL])) by (@GBLABELS) / 1048576` | MB | -| Number of reads from the SSStore per second | `sum(rate(ob_sysstat{stat_id="60000",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average time spent on each SSStore read | `sum(rate(ob_sysstat{stat_id="60001",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="60000",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Amount of data read from the SSStore per second | `sum(rate(ob_sysstat{stat_id="60002",@LABELS}[@INTERVAL])) by (@GBLABELS)` | Byte | -| Average read time per second | `1000000 * (avg(rate(node_disk_read_time_seconds_total{@LABELS}[@INTERVAL])) by (@GBLABELS)) / (avg(rate(node_disk_reads_completed_total{@LABELS}[@INTERVAL])) by (@GBLABELS))` | μs | -| Average time spent on each I/O read | `1000000 * (avg(rate(node_disk_read_time_seconds_total{@LABELS}[@INTERVAL])) by (@GBLABELS)) / (avg(rate(node_disk_reads_completed_total{@LABELS}[@INTERVAL])) by (@GBLABELS))` | μs | -| Number of writes per second | `avg(rate(node_disk_writes_completed_total{@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Amount of data written each time | `avg(rate(node_disk_written_bytes_total{@LABELS}[@INTERVAL])) by (@GBLABELS) / 1048576` | MB | -| Number of writes to the SSStore per second | `sum(rate(ob_sysstat{stat_id="60003",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average time spent on each SSStore write | `sum(rate(ob_sysstat{stat_id="60004",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="60003",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Amount of data written to the SSStore per second | `sum(rate(ob_sysstat{stat_id="60005",@LABELS}[@INTERVAL])) by (@GBLABELS)` | Byte | -| Average write time per second | `1000000 * (avg(rate(node_disk_write_time_seconds_total{@LABELS}[@INTERVAL])) by (@GBLABELS)) / (avg(rate(node_disk_writes_completed_total{@LABELS}[@INTERVAL])) by (@GBLABELS))` | μs | -| Average time spent on each I/O write | `1000000 * (avg(rate(node_disk_write_time_seconds_total{@LABELS}[@INTERVAL])) by (@GBLABELS)) / (avg(rate(node_disk_writes_completed_total{@LABELS}[@INTERVAL])) by (@GBLABELS))` | μs | -| Average system load in the last minute | `avg(node_load1{@LABELS}) by (@GBLABELS)` | - | -| Average system load in the last 15 minutes | `avg(node_load15{@LABELS}) by (@GBLABELS)` | - | -| Average system load in the last 5 minutes | `avg(node_load5{@LABELS}) by (@GBLABELS)` | - | -| Threshold for triggering a major compaction | `sum(ob_sysstat{stat_id="130002",@LABELS}) by (@GBLABELS) / 1048576` | MB | -| Size of the kernel buffer cache | `avg(node_memory_Buffers_bytes{@LABELS}) by (@GBLABELS) / 1073741824` | GB | -| Size of the available physical memory | `avg(node_memory_MemFree_bytes{@LABELS}) by (@GBLABELS) / 1073741824` | GB | -| Size of the physical memory used | `(avg(node_memory_MemTotal_bytes{@LABELS}) by (@GBLABELS)` `avg(node_memory_MemFree_bytes{@LABELS}) by (@GBLABELS)` `avg(node_memory_Cached_bytes{@LABELS}) by (@GBLABELS)` `avg(node_memory_Buffers_bytes{@LABELS}) by (@GBLABELS)) / 1073741824` | GB | -| Maximum size of MemStores | `sum(ob_sysstat{stat_id="130004",@LABELS}) by (@GBLABELS) / 1048576` | MB | -| Percentage of used MemStores | `100 * sum(ob_sysstat{stat_id="130001",@LABELS}) by (@GBLABELS) / sum(ob_sysstat{stat_id="130004",@LABELS}) by (@GBLABELS)` | % | -| Number of write lock wait failures | `sum(rate(ob_sysstat{stat_id="60022",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Number of write lock wait successes | `sum(rate(ob_sysstat{stat_id="60021",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average wait time of each write lock | `sum(rate(ob_sysstat{stat_id="60023",@LABELS}[@INTERVAL])) by (@GBLABELS) / (sum(rate(ob_sysstat{stat_id="60021",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="60022",@LABELS}[@INTERVAL])) by (@GBLABELS))` | μs | -| Amount of data received per second | `avg(rate(node_network_receive_bytes_total{@LABELS}[@INTERVAL])) by (@GBLABELS) / 1048576` | MB | -| Amount of data sent per second | `avg(rate(node_network_transmit_bytes_total{@LABELS}[@INTERVAL])) by (@GBLABELS) / 1048576` | MB | -| CPU utilization | `100 * sum(ob_sysstat{stat_id="140006",@LABELS}) by (@GBLABELS) / sum(ob_sysstat{stat_id="140005",@LABELS}) by (@GBLABELS)` | % | -| Number of partitions | `sum(ob_partition_num{@LABELS}) by (@GBLABELS)` | - | -| Hit rate of the plan cache | `100 * sum(rate(ob_plan_cache_hit_total{@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_plan_cache_access_total{@LABELS}[@INTERVAL])) by (@GBLABELS)` | % | -| Size of the plan cache | `sum(ob_plan_cache_memory_bytes{@LABELS}) by (@GBLABELS) / 1048576` | MB | -| Average number of SQL statements queued up per second | `sum(rate(ob_sysstat{stat_id="20001",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average waiting time of an SQL statement in a queue | `sum(rate(ob_sysstat{stat_id="20002",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="20001",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Hit rate of the row cache | `100 * 1 / (1 + sum(rate(ob_sysstat{stat_id="50001",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="50000",@LABELS}[@INTERVAL])) by (@GBLABELS))` | % | -| Cache size | `sum(ob_cache_size_bytes{@LABELS}) by (@GBLABELS) / 1048576` | MB | -| RPC packet receiving throughput | `sum(rate(ob_sysstat{stat_id="10001",@LABELS}[@INTERVAL])) by (@GBLABELS)` | Byte | -| Average time spent in receiving RPC packets | `(sum(rate(ob_sysstat{stat_id="10005",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="10006",@LABELS}[@INTERVAL])) by (@GBLABELS)) / sum(rate(ob_sysstat{stat_id="10000",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| RPC packet sending throughput | `sum(rate(ob_sysstat{stat_id="10003",@LABELS}[@INTERVAL])) by (@GBLABELS)` | Byte | -| Average time spent in sending RPC packets | `(sum(rate(ob_sysstat{stat_id="10005",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="10006",@LABELS}[@INTERVAL])) by (@GBLABELS)) / sum(rate(ob_sysstat{stat_id="10002",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Number of SQL statements processed per second | `sum(rate(ob_sysstat{stat_id="40002",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40004",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40006",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40008",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40000",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average processing time of an SQL statement on the server | `(sum(rate(ob_sysstat{stat_id="40003",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40005",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40007",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40009",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40001",@LABELS}[@INTERVAL])) by (@GBLABELS)) /(sum(rate(ob_sysstat{stat_id="40002",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40004",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40006",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40008",@LABELS}[@INTERVAL])) by (@GBLABELS) + sum(rate(ob_sysstat{stat_id="40000",@LABELS}[@INTERVAL])) by (@GBLABELS))` | μs | -| Number of DELETE statements processed per second | `sum(rate(ob_sysstat{stat_id="40008",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Average processing time of a DELETE statement on the server | `sum(rate(ob_sysstat{stat_id="40009",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="40008",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Number of distributed execution plans processed per second | `sum(rate(ob_sysstat{stat_id="40012",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Number of INSERT statements processed per second | `sum(rate(ob_sysstat{stat_id="40002",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average processing time of an INSERT statement on the server | `sum(rate(ob_sysstat{stat_id="40003",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="40002",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Number of local execution plans processed per second | `sum(rate(ob_sysstat{stat_id="40010",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Number of remote execution plans processed per second | `sum(rate(ob_sysstat{stat_id="40011",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Number of REPLACE statements processed per second | `sum(rate(ob_sysstat{stat_id="40004",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average processing time of a REPLACE statement on the server | `sum(rate(ob_sysstat{stat_id="40005",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="40004",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Number of SELECT statements processed per second | `sum(rate(ob_sysstat{stat_id="40000",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average processing time of a SELECT statement on the server | `sum(rate(ob_sysstat{stat_id="40001",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="40000",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Number of UPDATE statements processed per second | `sum(rate(ob_sysstat{stat_id="40006",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average processing time of an UPDATE statement on the server | `sum(rate(ob_sysstat{stat_id="40007",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="40006",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Number of tables | `max(ob_table_num{@LABELS}) by (@GBLABELS)` | - | -| Total size of MemStores | `sum(ob_sysstat{stat_id="130001",@LABELS}) by (@GBLABELS) / 1048576` | MB | -| Number of transactions processed per second | `sum(rate(ob_sysstat{stat_id="30005",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average processing time of a transaction on the server | `sum(rate(ob_sysstat{stat_id="30006",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="30005",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Transaction logs committed per second | `sum(rate(ob_sysstat{stat_id="30002",@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average time spent on each synchronization of transaction logs over the network | `sum(rate(ob_sysstat{stat_id="30000",@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_sysstat{stat_id="30001",@LABELS}[@INTERVAL])) by (@GBLABELS)` | μs | -| Average number of wait events per second | `sum(rate(ob_waitevent_wait_total{@LABELS}[@INTERVAL])) by (@GBLABELS)` | N/A | -| Average wait time of a wait event | `sum(rate(ob_waitevent_wait_seconds_total{@LABELS}[@INTERVAL])) by (@GBLABELS) / sum(rate(ob_waitevent_wait_total{@LABELS}[@INTERVAL])) by (@GBLABELS)` | s | diff --git a/en-US/700.reference/1500.command-line-tools/900.ob-agent/800.frequently-reported-alerts.md b/en-US/700.reference/1500.command-line-tools/900.ob-agent/800.frequently-reported-alerts.md deleted file mode 100644 index 44737e705c..0000000000 --- a/en-US/700.reference/1500.command-line-tools/900.ob-agent/800.frequently-reported-alerts.md +++ /dev/null @@ -1,24 +0,0 @@ -# Frequently reported alerts - -This topic describes the general alerts of OBAgent. - -| Alert | Metric | Threshold | -|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| -| ob_host_connection_percent_over_threshold | 100 \* max(ob_active_session_num{@LABELS} / 262144) by (@GBLABELS) | 80 | -| ob_host_cpu_percent | 100 \* (1 - sum(rate(node_cpu_seconds_total{mode="idle", @LABELS}\[@INTERVAL\])) by (@GBLABELS) / sum(rate(node_cpu_seconds_total{@LABELS}\[@INTERVAL\])) by (@GBLABELS)) | 100 | -| ob_cpu_percent_over_threshold | 100 \* sum(ob_sysstat{stat_id="140006",@LABELS}) by (@GBLABELS) / sum(ob_sysstat{stat_id="140005",@LABELS}) by (@GBLABELS) | 90 | -| ob_host_disk_percent_over_threshold | 100 \* (1 - avg(node_filesystem_avail_bytes{@LABELS}) by (@GBLABELS) / avg(node_filesystem_size_bytes{@LABELS}) by (@GBLABELS)) | 97 | -| ob_cluster_frozen_version_delta_over_threshold | max(ob_zone_stat{name="frozen_version",@LABELS}) by (@GBLABELS) - min(ob_zone_stat{name="last_merged_version",@LABELS}) by (@GBLABELS) | 1 | -| ob_host_net_recv_percent_over_threshold | 100 \* max(sum(rate(node_network_receive_bytes_total{@LABELS}\[@INTERVAL\])) by (device,@GBLABELS) / sum(bandwidth{@LABELS})) by (@GBLABELS) | 80 | -| ob_host_net_send_percent_over_threshold | 100 \* max(sum(rate(node_network_transmit_bytes_total{@LABELS}\[@INTERVAL\])) by (device,@GBLABELS) / sum(bandwidth{@LABELS})) by (@GBLABELS) | 80 | -| ob_cluster_exists_inactive_server | max(ob_server_num{status="inactive",@LABELS}) by (@GBLABELS) | 0 | -| ob_cluster_exists_index_fail_table | sum(ob_index_error_num{@LABELS}) by (@GBLABELS) | 0 | -| ob_host_load1_per_cpu_over_threshold | sum(node_load1{@LABELS}) by (@GBLABELS) / sum(cpu_count{@LABELS}) by (@GBLABELS) | 2 | -| ob_host_mem_percent_over_threshold | (1 - (avg(node_memory_MemFree_bytes{@LABELS}) by (@GBLABELS) + avg(node_memory_Cached_bytes{@LABELS}) by (@GBLABELS) + avg(node_memory_Buffers_bytes{@LABELS}) by (@GBLABELS)) / avg(node_memory_MemTotal_bytes{@LABELS}) by (@GBLABELS)) \* 100 | 90 | -| ob_cluster_merge_timeout | max(ob_zone_stat{name="is_merge_timeout",@LABELS}) by (@GBLABELS) | 1 | -| ob_cluster_merge_error | max(ob_zone_stat{name="is_merge_error",@LABELS}) by (@GBLABELS) | 1 | -| ob_host_partition_count_over_threshold | sum(ob_partition_num{@LABELS}) by (@GBLABELS) | 30000 | -| ob_host_disk_readonly | max(node_filesystem_readonly{@LABELS}) by (@GBLABELS) | 1 | -| ob_server_sstable_percent_over_threshold | 100 \* (sum(ob_disk_total_bytes{@LABELS}) by (@GBLABELS) - sum(ob_disk_free_bytes{@LABELS}) by (@GBLABELS)) / sum(ob_disk_total_bytes{@LABELS}) by (@GBLABELS) | 85 | -| tenant_active_memstore_percent_over_threshold | 100 \* sum(ob_sysstat{stat_id="130000",@LABELS}) by (@GBLABELS) / sum(ob_sysstat{stat_id="130002",@LABELS}) by (@GBLABELS) | 110 | -| tenant_memstore_percent_over_threshold | 100 \* sum(ob_sysstat{stat_id="130001",@LABELS}) by (@GBLABELS) / sum(ob_sysstat{stat_id="130004",@LABELS}) by (@GBLABELS) | 85 |