Alibaba Cloud OceanBase

Collect Alibaba Cloud OceanBase metrics and slow query log data

Configuration¶

Install Func¶

It is recommended to activate the TrueWatch integration - extension - DataFlux Func (Automata)

If you deploy Func yourself, refer to Deploy Func Yourself

Activate Script¶

Note: Please prepare the Alibaba Cloud AK that meets the requirements in advance (for simplicity, you can directly grant the global read-only permission ReadOnlyAccess)

Automata Activation Script¶

1. Log in to the TrueWatch console
2. Click the 【Integration】 menu and select 【Cloud Account Management】
3. Click 【Add Cloud Account】, select 【Alibaba Cloud】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
4. Click 【Test】, and if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
5. Click 【Cloud Account Management】, and you can see the added cloud account in the list. Click the corresponding cloud account to enter the details page
6. Click the 【Integration】 button on the cloud account details page, find Alibaba Cloud OceanBase under the Not Installed list, and click the 【Install】 button to pop up the installation interface for installation.

Manual Activation Script¶

Note: Please prepare the required Alibaba Cloud AK in advance (for simplicity, you can directly grant global read-only permissions ReadOnlyAccess)

Metrics¶

1. Log in to the Func console, click [Script Market], enter the TrueWatch script market, and search for: integration_alibabacloud_oceanbase_metric

2. Click [Install], then enter the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.

3. Click [Deploy Startup Script], the system will automatically create the Startup script set and configure the corresponding startup script.

4. After enabling, you can see the corresponding automatic trigger configuration in "Manage / Automatic Trigger Configuration". Click [Execute] to immediately execute it once without waiting for the scheduled time. After a while, you can check the execution task records and corresponding logs.

Slow Query Logs¶

1. Log in to the Func console, click [Script Market], enter the TrueWatch script market, and search for: integration_alibabacloud_oceanbase_slowlog

2. Click [Install], then enter the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.

3. Click [Deploy Startup Script], the system will automatically create the Startup script set and configure the corresponding startup script.

4. After enabling, you can see the corresponding automatic trigger configuration in "Manage / Automatic Trigger Configuration". Click [Execute] to immediately execute it once without waiting for the scheduled time. After a while, you can check the execution task records and corresponding logs.

Verification¶

1. In "Manage / Automatic Trigger Configuration", confirm whether the corresponding task has the automatic trigger configuration, and check the task records and logs for any exceptions
2. In TrueWatch, check if the asset information exists in "Infrastructure / Custom"
3. In TrueWatch, check if the corresponding monitoring data exists in "Metrics"

Metrics¶

Alibaba Cloud OceanBase metrics are under the aliyun_oceanbase_metric Measurement. Below are the metric details

Objects¶

The collected Alibaba Cloud OceanBase object data structure can be seen in "Infrastructure - Custom". Currently, there are mainly two types of object data:

• aliyun_oceanbase: Alibaba Cloud OceanBase instance object
• aliyun_oceanbase_tenant: Tenant object under the Alibaba Cloud OceanBase instance

aliyun_oceanbase¶

  {
    "fields": {
      "Cpu": 4,
      "CpuArchitecture": "X86",
      "CreateTime": "2025-09-26T02:33:47Z",
      "DataDiskAutoScaleConfig": "{\"AutoScale\": false, \"MaxDiskSize\": 64000.0}",
      "DeployMode": "1-1-1",
      "DeployType": "single",
      "DiskSize": 50,
      "ExpireTime": "2125-09-26T16:00:00Z",
      "InstanceClass": "4C16G",
      "InstanceId": "ob73ypcm3mtr28",
      "InstanceName": "ob_0926",
      "InstanceRole": "NORMAL",
      "InstanceType": "K8s_DEDICATED",
      "Mem": 16,
      "PayType": "POSTPAY",
      "message": "...."
      ...
    },
    "measurement": "aliyun_oceanbase",
    "tags": {
      "ClusterId": "ob73ypcm3mtr28",
      "ClusterName": "ob_0926",
      "ClusterRole": "NORMAL",
      "ClusterType": "K8s_DEDICATED",
      "ProxyClusterId": "proxy-73yrq8mzxxx",
      "RegionId": "cn-shenzhen",
      "ResourceGroupId": "rg-aekzsli74qdxxxx",
      "name": "ob73ypcm3mtr28"
    }
  }

aliyun_oceanbase_tenant¶

  {
    "fields": {
      "Cpu": 1,
      "CreateTime": "2025-09-26T03:34:31Z",
      "Mem": 4,
      "Status": "ONLINE",
      "TenantMode": "MySQL",
      "message": "...."
    },
    "measurement": "aliyun_oceanbase_tenant",
    "tags": {
      "ClusterId": "ob73ypcm3mtr28",
      "ClusterName": "ob_0926",
      "ClusterRole": "NORMAL",
      "ClusterType": "K8s_DEDICATED",
      "PrimaryZone": "cn-shenzhen-d",
      "ProxyClusterId": "proxy-73yrq8mzwddd",
      "RegionId": "cn-shenzhen",
      "ResourceGroupId": "rg-aekzsli74qdxxxx",
      "TenantId": "t73yursgglxeo",
      "TenantName": "mall",
      "name": "t73yursgglxeo"
    }
  }