Skip to content

Commit 59159a7

Browse files
author
zhongming Fan
committed
oceanbase: v4.1.3
1 parent 4c20722 commit 59159a7

2 files changed

Lines changed: 715 additions & 0 deletions

File tree

‎weops/pipe-tools/bk_pkg/oceanbase/README.md‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
## 嘉为蓝鲸oceanbase插件使用说明
2+
3+
## 使用说明
4+
5+
### 插件功能
6+
7+
基于配置连接数据库并从中收集指标，其收集的指标及其采集、生成方式均由配置文件定义。
8+
9+
### 版本支持
10+
11+
操作系统支持: linux, windows
12+
13+
是否支持arm: 支持
14+
15+
**组件支持版本：**
16+
oceanbase: v4.x+
17+
18+
**是否支持远程采集:**
19+
20+
是
21+
22+
### 参数说明
23+
24+
25+
| **参数名** | **含义** | **是否必填** | **使用举例** |
26+
|-------------------------|-------------------------------------------------------------|----------|----------------|
27+
| SQL_EXPORTER_USER | 数据库用户名(环境变量)，特殊字符不需要编码转义 | 是 | root |
28+
| SQL_EXPORTER_PASS | 数据库密码(环境变量)，特殊字符不需要编码转义 | 是 | |
29+
| SQL_EXPORTER_DB_TYPE | 数据库类型(环境变量) | 是 | oceanbase |
30+
| SQL_EXPORTER_HOST | 数据库服务IP(环境变量) | 是 | 127.0.0.1 |
31+
| SQL_EXPORTER_PORT | 数据库服务端口(环境变量) | 是 | 1433 |
32+
| COLLECTOR_REFS | 采集指标配置名称，对应`collector_name`，一般使用模糊匹配 | 是 | oceanbase* |
33+
| SCRAPE_TIMEOUT | 采集超时时间 | 否 | 10s |
34+
| MAX_CONNECTION_LIFETIME | 最长连接时长 | 否 | 5m |
35+
| --collector.file | 采集指标配置文件路径(文件参数), *.collector.yml 采集指标配置文件, 包含指标名、维度、sql等内容 | 是 | |
36+
| --log.level | 日志级别 | 否 | info |
37+
| --web.listen-address | exporter监听id及端口地址 | 否 | 127.0.0.1:9601 |
38+
39+
40+
### 使用指引
41+
42+
> **注意：** 创建监控账户需要使用超级管理员权限（root@sys）连接数据库。
43+
44+
#### 1. 使用超管权限连接到 OceanBase 数据库
45+
46+
```bash
47+
obclient -h127.0.0.1 -P2881 -uroot@sys -p
48+
```
49+
50+
#### 2. 创建监控用户并授权（需超管权限）
51+
52+
```sql
53+
-- 创建监控用户
54+
CREATE USER 'weops' IDENTIFIED BY 'weops@123!';
55+
56+
-- 授予查询权限（用于采集监控指标）
57+
GRANT SELECT ON *.* TO 'weops';
58+
```
59+
60+
#### 3. 所需系统视图权限说明
61+
62+
监控采集需要访问以下系统视图，请确保监控用户具有这些视图的 SELECT 权限：
63+
64+
| **视图名称** | **用途说明** |
65+
|--------------------------|----------------------|
66+
| DBA_OB_SERVERS | 获取服务器状态信息 |
67+
| DBA_OB_TENANTS | 获取租户信息 |
68+
| GV$OB_SERVERS | 获取服务器资源信息 |
69+
| GV$OB_KVCACHE | 获取缓存信息 |
70+
| GV$OB_PROCESSLIST | 获取会话连接信息 |
71+
| GV$OB_MEMSTORE | 获取内存存储信息 |
72+
| GV$OB_MEMORY | 获取内存使用信息 |
73+
| V$OB_PLAN_CACHE_STAT | 获取计划缓存统计 |
74+
| v$sysstat | 获取系统统计信息（CPU/内存/IO等） |
75+
| v$system_event | 获取系统等待事件信息 |
76+
| gv$ob_units / v$ob_units | 获取资源单元信息 |
77+
| dba_ob_units | 获取资源单元配置 |
78+
| CDB_TABLES | 获取表数量统计 |
79+
| CDB_INDEXES | 获取索引状态信息 |
80+
81+
#### 4. 验证权限
82+
83+
```sql
84+
-- 使用监控用户登录验证
85+
obclient -h127.0.0.1 -P2881 -uweops -p'weops@123!'
86+
87+
-- 测试查询系统视图
88+
SELECT count(*) FROM DBA_OB_SERVERS;
89+
SELECT count(*) FROM v$sysstat;
90+
```
91+
92+
### 指标简介
93+
| **指标ID** | **指标中文名** | **维度ID** | **维度含义** | **单位** | **指标类型** |
94+
|-------------------------------------------|---------------------|------------------------|------------|---------|----------|
95+
| up | 插件运行状态 | - | - | - | gauge |
96+
| oceanbase_uptime | OceanBase服务器运行时间 | - | - | s | gauge |
97+
| oceanbase_version | OceanBase版本信息 | version | 版本号 | - | gauge |
98+
| oceanbase_server_status | OceanBase服务器状态 | servers, status | 服务名称, 状态 | - | gauge |
99+
| oceanbase_active_session | OceanBase当前活跃连接会话数量 | tenant_name, tenant_id | 租户名称, 租户ID | - | gauge |
100+
| oceanbase_all_session | OceanBase所有连接会话总数量 | tenant_name, tenant_id | 租户名称, 租户ID | - | gauge |
101+
| oceanbase_cache_size | OceanBase缓存大小 | cache_name, tenant_id | 缓存名称, 租户ID | bytes | gauge |
102+
| oceanbase_plan_cache_hit_percent | OceanBase计划缓存命中率 | tenant_id | 租户ID | percent | gauge |
103+
| oceanbase_disk_free | OceanBase磁盘剩余容量 | - | - | bytes | gauge |
104+
| oceanbase_disk_total | OceanBase磁盘总容量 | - | - | bytes | gauge |
105+
| oceanbase_disk_used_percent | OceanBase磁盘使用率 | - | - | percent | gauge |
106+
| oceanbase_memstore_active | OceanBase内存存储活跃空间 | tenant_id | 租户ID | bytes | gauge |
107+
| oceanbase_memstore_freeze_count | OceanBase内存存储冻结次数 | tenant_id | 租户ID | - | gauge |
108+
| oceanbase_memstore_freeze_trigger | OceanBase内存存储冻结触发阈值 | tenant_id | 租户ID | bytes | gauge |
109+
| oceanbase_memstore_total | OceanBase内存存储总空间 | tenant_id | 租户ID | bytes | gauge |
110+
| oceanbase_server_cpu_assigned | OceanBase服务器CPU已分配 | - | - | - | gauge |
111+
| oceanbase_server_cpu_total | OceanBase服务器CPU总量 | - | - | - | gauge |
112+
| oceanbase_server_disk_total | OceanBase服务器磁盘总量 | - | - | bytes | gauge |
113+
| oceanbase_server_memory_assigned | OceanBase服务器内存已分配 | - | - | bytes | gauge |
114+
| oceanbase_server_memory_total | OceanBase服务器内存总量 | - | - | bytes | gauge |
115+
| oceanbase_sysstat_active_memstore_used | 活跃Memstore使用量 | tenant_id | 租户ID | bytes | gauge |
116+
| oceanbase_sysstat_block_cache_hit_percent | 块缓存命中率 | tenant_id | 租户ID | percent | gauge |
117+
| oceanbase_sysstat_cpu_usage | CPU使用率 | tenant_id | 租户ID | percent | gauge |
118+
| oceanbase_sysstat_io_read | IO读取次数 | tenant_id | 租户ID | - | counter |
119+
| oceanbase_sysstat_io_read_bytes | IO读取字节数 | tenant_id | 租户ID | bytes | counter |
120+
| oceanbase_sysstat_io_write | IO写入次数 | tenant_id | 租户ID | - | counter |
121+
| oceanbase_sysstat_io_write_bytes | IO写入字节数 | tenant_id | 租户ID | bytes | counter |
122+
| oceanbase_sysstat_max_memory | 最大内存 | tenant_id | 租户ID | bytes | gauge |
123+
| oceanbase_sysstat_memory_usage | 内存使用量 | tenant_id | 租户ID | bytes | gauge |
124+
| oceanbase_sysstat_memory_usage_percent | 内存使用率 | tenant_id | 租户ID | percent | gauge |
125+
| oceanbase_sysstat_memstore_limit | MEMStore的最大使用限制 | tenant_id | 租户ID | bytes | gauge |
126+
| oceanbase_sysstat_sql_delete_rt | SQL DELETE平均响应时间 | tenant_id | 租户ID | µs | gauge |
127+
| oceanbase_sysstat_sql_insert_rt | SQL INSERT平均响应时间 | tenant_id | 租户ID | µs | gauge |
128+
| oceanbase_sysstat_sql_select_rt | SQL SELECT平均响应时间 | tenant_id | 租户ID | µs | gauge |
129+
| oceanbase_sysstat_sql_update_rt | SQL UPDATE平均响应时间 | tenant_id | 租户ID | µs | gauge |
130+
| oceanbase_sysstat_total_memstore_used | Memstore总使用量 | tenant_id | 租户ID | bytes | gauge |
131+
| oceanbase_sysstat_trans_commit | 事务提交数量 | tenant_id | 租户ID | - | counter |
132+
| oceanbase_sysstat_trans_rollback | 事务回滚数量 | tenant_id | 租户ID | - | counter |
133+
| oceanbase_sysstat_trans_timeout | 事务超时数量 | tenant_id | 租户ID | - | counter |
134+
| oceanbase_waitevent_avg_time | OceanBase等待事件平均耗时 | tenant_id | 租户ID | µs | gauge |
135+
| oceanbase_system_event_avg_time | OceanBase系统事件平均耗时 | event_group, tenant_id | 事件, 租户ID | µs | gauge |
136+
| oceanbase_table_count | OceanBase表数量统计 | tenant_id | 租户ID | - | gauge |
137+
| oceanbase_tenant500_memory_hold | OceanBase系统租户内存持有量 | - | - | bytes | gauge |
138+
| oceanbase_tenant500_memory_used | OceanBase系统租户内存使用量 | - | - | bytes | gauge |
139+
| oceanbase_tenant500_memory_used_percent | OceanBase系统租户内存使用率 | - | - | percent | gauge |
140+
| oceanbase_index_error | OceanBase索引错误数量 | - | - | - | gauge |
141+
| oceanbase_is_rootservice | OceanBase根服务状态 | svr_port, svr_ip | 服务端口, 服务IP | - | gauge |
142+
| oceanbase_tenant_cpu_assigned | OceanBase租户CPU已分配 | tenant_name, tenant_id | 租户名称, 租户ID | - | gauge |
143+
| oceanbase_tenant_cpu_total | OceanBase租户CPU总量 | tenant_name, tenant_id | 租户名称, 租户ID | - | gauge |
144+
| oceanbase_tenant_data_disk | OceanBase租户数据磁盘使用量 | tenant_name, tenant_id | 租户名称, 租户ID | bytes | gauge |
145+
| oceanbase_tenant_log_disk | OceanBase租户日志磁盘使用量 | tenant_name, tenant_id | 租户名称, 租户ID | bytes | gauge |
146+
| oceanbase_tenant_memory_assigned | OceanBase租户内存已分配 | tenant_name, tenant_id | 租户名称, 租户ID | bytes | gauge |
147+
| oceanbase_tenant_memory_total | OceanBase租户内存总量 | tenant_name, tenant_id | 租户名称, 租户ID | bytes | gauge |
148+
| scrape_duration_seconds | 监控探针最近一次抓取时长 | - | - | s | - |
149+
150+
### 版本日志
151+
152+
#### weops_oceanbase_exporter v4.1.3
153+
154+
- weops调整

0 commit comments

Comments
 (0)