Skip to content

Commit b2e9779

Browse files
authored
4.2503 (#27)
* oauth2更新 * TDSQL锁采集 * 结构对比支持oracle * 快捷审核的时候,支持指定代码分支 * 更新功能对比 * Update lockinfo.md
1 parent 9b009ac commit b2e9779

8 files changed

Lines changed: 80 additions & 5 deletions

File tree

docs/support/compare.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ title: 功能对比
263263
<td>✅</td>
264264
</tr>
265265
<tr>
266-
<td rowspan="14">智能扫描</td>
266+
<td rowspan="15">智能扫描</td>
267267
<td>库表元数据</td>
268268
<td>✅</td>
269269
<td>✅</td>
@@ -347,6 +347,12 @@ title: 功能对比
347347
<td></td>
348348
<td>✅</td>
349349
</tr>
350+
<tr>
351+
<td>TDSQL锁监控</td>
352+
<td></td>
353+
<td></td>
354+
<td>✅</td>
355+
</tr>
350356
<tr>
351357
<td rowspan="2">SQL优化</td>
352358
<td>SQL合规重写</td>

docs/user-manual/project/Structure-Comparison.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ title: 结构对比
2020

2121
### 支持的数据源类型
2222
* MySQL
23+
* Oracle
2324

2425
### 操作步骤
2526

175 KB
Loading
301 KB
Loading
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# TDSQL锁监控
2+
3+
4+
## 功能概述
5+
6+
### 功能用途
7+
TDSQL 锁监控是一个实时监控和分析数据库锁状态的功能,能够帮助用户快速发现并解决数据库锁冲突问题,提升系统性能和稳定性。
8+
9+
### 适用场景
10+
| 场景 | 描述 |
11+
|------|------|
12+
| 性能问题排查 | 系统性能突然下降时的快速定位 |
13+
| 高峰期监控 | 业务高峰期的系统响应监控 |
14+
| 交易问题分析 | 支付交易超时等异常情况分析 |
15+
| 性能优化 | 数据库访问效率优化和调优 |
16+
17+
### 主要特点
18+
- **实时监控**:秒级发现并定位锁冲突问题
19+
- **可视化展示**:直观呈现锁信息和趋势
20+
- **智能预警**:自动识别异常锁等待情况
21+
- **性能分析**:提供锁相关的性能诊断报告
22+
23+
24+
### 预期效果
25+
- 减少系统性能问题排查时间
26+
- 提前发现潜在性能风险
27+
- 优化数据库访问效率
28+
29+
## 前置条件
30+
31+
### 环境依赖
32+
- 已完成 TDSQL 数据源配置
33+
34+
## 操作指南
35+
36+
### 功能入口
37+
SQL管控配置页面
38+
39+
### 操作步骤
40+
1. 进入SQL管控配置页面
41+
2. 选择目标 TDSQL 数据源
42+
3. 开启锁扫描功能
43+
44+
![lock-edit](img/lock-edit.png)
45+
46+
### 操作结果展示
47+
用户可以在监控看板中查看:
48+
- 锁冲突情况
49+
- 锁等待时间
50+
- 受影响的表/行信息
51+
- 锁类型分布
52+
53+
![lock-info](img/lock-info.png)
54+
55+
## 最佳实践
56+
57+
### 使用建议
58+
- 调整采样周期,避免高频采集带来的性能影响
59+
- 定期分析锁监控数据,识别潜在问题
60+
- 对频繁出现的锁冲突进行优化处理
61+
62+
### 性能优化建议
63+
- 优化事务处理逻辑,减少长事务
64+
- 合理设计索引,避免表级锁
65+
- 适当调整事务隔离级别

docs/user-manual/project/quick_audit.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ title: SQL审核
6969
5. 配置GIT仓库
7070
* 支持公开及私有仓库
7171
* 需配置正确的访问凭证
72+
* 支持指定代码分支
7273
* 适合与版本控制系统集成
7374

7475

docs/user-manual/sys-configuration/login_syn.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,17 @@ SQLE中支持通过配置的方式接入OAuth 2.0系统, 如同其他系统一
5151
* **应用ID**:应用的唯一标识, 从要对接的平台申请 , 在OAuth2.0认证过程中,appid的值即为oauth_consumer_key的值
5252
* **应用密钥**:与应用ID对应的密钥,用于验证应用访问用户资源的合法性。在 OAuth2.0 认证过程中,此密钥用作 oauth_consumer_secret 的值。
5353
* **外部访问SQLE的地址**:用户通过第三方平台登录后,将被重定向到此地址。格式为 http(s)://ip:port
54-
* **oauth2.0登录授权页面地址**:用户在此页面授权应用访问其账户信息。格式为 http(s)://ip:port/xxx
55-
* **oauth2.0 access_token 获取地址**:用于获取访问令牌的地址,该令牌允许用户的应用访问用户资源。格式为 http(s)://ip:port/xxx
56-
* **oauth2 user id 获取地址**:用于获取用户ID的地址,该ID用于识别用户。格式为 http(s)://ip:port/xxx
54+
* **OAuth2.0登录授权页面地址**:用户在此页面授权应用访问其账户信息。格式为 http(s)://ip:port/xxx
55+
* **OAuth2.0 access_token 获取地址**:用于获取访问令牌的地址,该令牌允许用户的应用访问用户资源。格式为 http(s)://ip:port/xxx
56+
* **OAuth2 user id 获取地址**:用于获取用户ID的地址,该ID用于识别用户。格式为 http(s)://ip:port/xxx
5757
* **注销跳转地址**:用户登出时,系统自动将浏览器重定向至此地址进行注销操作,以关闭第三方平台的会话信息。格式为 http://localhost:8080/logout?id_token_hint=$[id_token]&post_logout_redirect_url=$[sqle_url]
5858
* **请求资源范围**:定义应用可以访问的资源范围,由验证服务器定义。
5959
* **access_token Key名称**:指定在获取用户ID时,access_token 存储的键名。此参数会作为 GET 请求的参数发送给用户ID获取地址。
6060
* **用户UID的JSON路径**:指定从第三方平台响应中解析用户ID的 JSON 路径。用户ID应当为唯一ID。
6161
* **用户邮箱的JSON路径**:指定从第三方平台响应中解析用户邮箱的 JSON 路径。
6262
* **用户微信ID的JSON路径**:指定从第三方平台响应中解析用户微信ID的 JSON 路径。
63-
* **登录按钮文字**:自定义登录页面上 OAuth2.0 登录按钮的显示文字。
63+
* **OAuth2.0 跳转按钮文字**:自定义登录页面上 OAuth2.0 登录按钮的显示文字。
64+
* **登录权限查询GJSON表达式**:通过该表达式查询AccessToken载荷json,存在查询结果即有登录权限,不填默认有登录权限
6465
* **自动创建并绑定用户**:若开启,在通过OAuth2登陆时,若该用户未绑定SQLE用户,SQLE则会根据从OAuth2服务端获取的用户id创建SQLE账户,并且不会跳转到绑定界面,而是进入SQLE主界面
6566
* **默认登录密码**:系统自动创建的新用户将使用此密码作为初始登录密码,请妥善保存,平台将不会明文展示。此外,为保证账户安全,建议用户首次登录后及时修改密码。如果之前配置过该项,更新时不填写该项代表不更新密钥。
6667
* **跳过请求来源验证**:跳过对请求发送来源的验证,可能增加安全风险。建议仅在可信环境下启用此选项。启用后,SQLE 将不再验证回调中的 state 参数。

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ const sidebars = {
9999
"user-manual/project/audit_task/huaweiyunrds",
100100
"user-manual/project/audit_task/java_application_audit",
101101
"user-manual/project/audit_task/java_agent_audit",
102+
"user-manual/project/audit_task/lockinfo",
102103
],
103104
},
104105
{

0 commit comments

Comments
 (0)