Files
apache--hertzbeat/home/docs/help/oceanbase.md
T
wehub-resource-sync c8cebdfeee
MCP Bash Server CI / Test MCP Bash Server (dev) (push) Has been cancelled
MCP Bash Server CI / Test MCP Bash Server (release) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:11:39 +08:00

70 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
id: oceanbase
title: MonitoringOceanBase database monitoring
sidebar_label: OceanBase database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring oceanbase database metrics]
---
> Collect and monitor the general performance Metrics of OceanBase database. Support OceanBase 4.0+.
## Driver selection
OceanBase now follows the same automatic routing as the MySQL-compatible query path:
- If `mysql-connector-j` is present in `ext-lib`, the JVM collector or built-in server collector automatically prefers JDBC.
- If `mysql-connector-j` is absent, HertzBeat automatically uses the built-in MySQL-compatible query engine. No extra JAR is required.
- Restart HertzBeat or the standalone JVM collector after adding or removing a JAR in `ext-lib`.
:::important Collector package selection
OceanBase monitoring now supports both JVM and native deployment.
- Built-in server collector or JVM collector package: automatically prefers JDBC when `mysql-connector-j` exists in `ext-lib`
- Native collector package: supported when you do not rely on `ext-lib` and want the built-in MySQL-compatible query engine
- If you explicitly need runtime `ext-lib` JDBC loading, choose the JVM collector package
:::
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 2881 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 6000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URLoptionalIf configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric setbasic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|------------------------------------|
| version | none | Database version |
| port | none | Database exposure service port |
| datadir | none | Database storage data disk address |
| max_connections | none | Database maximum connections |
#### Metric setstatus
| Metric name | Metric unit | Metric help description |
|-------------------|-------------|----------------------------------|
| threads_created | none | OceanBase created total connections |
| threads_connected | none | OceanBase connected connections |
| threads_cached | none | OceanBase current cached connections |
| threads_running | none | OceanBase current active connections |
#### Metric setinnodb
| Metric name | Metric unit | Metric help description |
|---------------------|-------------|------------------------------------------------------|
| innodb_data_reads | none | innodb average number of reads from files per second |
| innodb_data_writes | none | innodb average number of writes from file per second |
| innodb_data_read | KB | innodb average amount of data read per second |
| innodb_data_written | KB | innodb average amount of data written per second |