Merge pull request #31 from actiontech/4.2511.1

4.2511.1

Author: LordofAvernus

docs/SUMMARY.md

@@ -2,58 +2,92 @@
 
 * [产品介绍](intro.md)
 * [在线体验](online-demo.md)
+* [用户指南](guide.md)
 * [产品支持](intro.md)
   * [企业版社区版功能对比](support/compare.md)
   * [社区支持](support/community-support.md)
   * [商业支持](support/commercial-support.md)
 * [快速开始](quick-usage.md)
 * [安装部署](deploy-manual/intro.md)
-    * [配置文件说明](deploy-manual/config.md)
-    * [源码安装](deploy-manual/source.md)
-    * [RPM 安装](deploy-manual/rpm.md)
-    * [Docker部署](deploy-manual/Docker.md)
-    * [Docker-Compose部署](deploy-manual/DockerCompose.md)
-    * [升级说明](deploy-manual/upgrade.md)
+  * [配置文件说明](deploy-manual/config.md)
+  * [源码安装](deploy-manual/source.md)
+  * [RPM 安装](deploy-manual/rpm.md)
+  * [Docker部署](deploy-manual/Docker.md)
+  * [Docker-Compose部署](deploy-manual/DockerCompose.md)
+  * [升级说明](deploy-manual/upgrade.md)
 * [用户手册](user-manual/intro.md)
-    * [项目](user-manual/project/intro.md)
-        * [创建项目【企业版】](user-manual/project/project_create.md)
-        * [数据源管理](user-manual/project/instance-manager.md)
-        * [外部数据源同步【企业版】](user-manual/project/instance_syn.md)
-        * [成员/成员组管理](user-manual/project/group_member.md)
-        * [审核规则模板](user-manual/project/rule-template-manager.md)
-        * [审核流程模板](user-manual/project/workflow-template-manager.md)
-        * [白名单管理【企业版】](user-manual/project/whitelist-manager.md)
-        * [SQL管控【企业版】](user-manual/project/audit_task/sqlmanage.md)
-        * [数据导出【企业版】](/docs/user-manual/project/dataexport.md)
-        * [SQL审核](user-manual/project/quick_audit.md)
-        * [工单](user-manual/project/workflow/intro.md)
-            * [创建工单](user-manual/project/workflow/create-workflow.md)
-            * [审核工单](user-manual/project/workflow/audit-workflow.md)
-            * [上线工单](user-manual/project/workflow/exec-workflow.md)
-        * [扫描任务](user-manual/project/audit_task/intro.md)
-            * [库表元数据](user-manual/project/audit_task/metadata_audit.md)
-            * [慢日志](user-manual/project/audit_task/slowlog_audit.md)
-            * [会话SQL扫描任务](user-manual/project/audit_task/processlist_audit.md)
-            * [百度云RDS慢日志](/docs/user-manual/project/audit_task/baiduyunrds.md)
-            * [华为云RDS慢日志](/docs/user-manual/project/audit_task/huaweiyunrds.md)
-            * [应用程序SQL抓取·企业版](/docs/user-manual/project/audit_task/java_application_audit.md)
-            * [Java探针版应用程序SQL抓取·企业版](/docs/user-manual/project/audit_task/java_agent_audit.md)
-            * [SQL文件扫描](/docs/user-manual/project/audit_task/SQLfile_audit.md)
-            * [MyBatis扫描](/docs/user-manual/project/audit_task/mybatis.md)
-    * [系统设置](user-manual/sys-configuration/intro.md)
-        * [登录对接](user-manual/sys-configuration/login_syn.md)
-        * [消息推送](user-manual/sys-configuration/message_syn.md)
-        * [流程对接](user-manual/sys-configuration/process_syn.md)
-        * [webhook配置](user-manual/sys-configuration/webhook.md)
-        * [个性化配置](user-manual/sys-configuration/customize.md)
-        * [全局配置](/docs/user-manual/sys-configuration/configuration.md)
-    * [工作台](user-manual/sql-workbench/introduction.md)
-        * [配置方法](user-manual/sql-workbench/how-to-configure.md)
-        * [使用定制包快速搭建环境](user-manual/sql-workbench/how-to-use.md)
-    * [用户管理](user-manual/user-manager/intro.md)
-        * [用户管理](user-manual/user-manager/user.md)
-        * [角色管理](user-manual/user-manager/role.md)
-    * [自定义审核规则](user-manual/customrule.md)
-    * [规则知识库【企业版】](user-manual/knowledgebase.md)
-* [FAQ](/docs/FAQ/intro.md)
-    * [支持的数据库及版本](/docs/FAQ/whichdatabase.md)
+  * [全局数据源管理](user-manual/allinstance.md)
+  * [项目](user-manual/project/intro.md)
+    * [创建项目【企业版】](user-manual/project/project_create.md)
+    * [数据源管理](user-manual/project/instance-manager.md)
+    * [外部数据源同步【企业版】](user-manual/project/instance_syn.md)
+    * [成员/成员组管理](user-manual/project/group_member.md)
+    * [审核规则模板](user-manual/project/rule-template-manager.md)
+    * [审核流程模板](user-manual/project/workflow-template-manager.md)
+    * [白名单管理【企业版】](user-manual/project/whitelist-manager.md)
+    * [管控SQL例外管理【企业版】](user-manual/project/blacklist-manager.md)
+    * [推送规则配置](user-manual/project/push-rule.md)
+    * [SQL管控【企业版】](user-manual/project/audit_task/sqlmanage.md)
+    * [数据导出【企业版】](user-manual/project/dataexport.md)
+    * [SQL审核](user-manual/project/quick_audit.md)
+    * [SQL分析](user-manual/project/analysis.md)
+    * [IDE审核](user-manual/project/IDEaudit.md)
+    * [CI/CD集成](user-manual/project/CICDintegration.md)
+    * [结构对比](user-manual/project/Structure-Comparison.md)
+    * [操作记录](user-manual/project/operation_records.md)
+    * [工单](user-manual/project/workflow/intro.md)
+      * [创建工单](user-manual/project/workflow/create-workflow.md)
+      * [审核工单](user-manual/project/workflow/audit-workflow.md)
+      * [上线工单](user-manual/project/workflow/exec-workflow.md)
+      * [回滚工单](user-manual/project/workflow/rollback.md)
+      * [版本管理](user-manual/project/workflow/version-management.md)
+    * [扫描任务](user-manual/project/audit_task/intro.md)
+      * [性能洞察](user-manual/project/audit_task/performance-insight.md)
+      * [库表元数据](user-manual/project/audit_task/metadata_audit.md)
+      * [慢日志](user-manual/project/audit_task/slowlog_audit.md)
+      * [会话SQL扫描任务](user-manual/project/audit_task/processlist_audit.md)
+      * [百度云RDS慢日志](user-manual/project/audit_task/baiduyunrds.md)
+      * [华为云RDS慢日志](user-manual/project/audit_task/huaweiyunrds.md)
+      * [应用程序SQL抓取【企业版】](user-manual/project/audit_task/java_application_audit.md)
+      * [Java探针版应用程序SQL抓取【企业版】](user-manual/project/audit_task/java_agent_audit.md)
+      * [SQL文件扫描](user-manual/project/audit_task/SQLfile_audit.md)
+      * [MyBatis扫描](user-manual/project/audit_task/mybatis.md)
+      * [TopSQL](user-manual/project/audit_task/topsql.md)
+      * [SQL下钻分析](user-manual/project/audit_task/SQLdrilldown.md)
+      * [TDSQL锁监控](user-manual/project/audit_task/lockinfo.md)
+    * [数据权限管控【企业版】](user-manual/project/data_access_control/intro.md)
+      * [权限模板](user-manual/project/data_access_control/permission_template.md)
+      * [授权清单](user-manual/project/data_access_control/authorization_list.md)
+    * [SQL优化](user-manual/project/sql-improve/introduction.md)
+      * [SQL合规重写](user-manual/project/sql-improve/sqlrewrite.md)
+  * [系统设置](user-manual/sys-configuration/intro.md)
+    * [登录对接](user-manual/sys-configuration/login_syn.md)
+    * [双因素认证(2FA)](user-manual/sys-configuration/MFA.md)
+    * [消息推送](user-manual/sys-configuration/message_syn.md)
+    * [流程对接](user-manual/sys-configuration/process_syn.md)
+    * [webhook配置](user-manual/sys-configuration/webhook.md)
+    * [个性化配置](user-manual/sys-configuration/customize.md)
+    * [全局配置](user-manual/sys-configuration/configuration.md)
+    * [可用区管理](user-manual/sys-configuration/zone.md)
+  * [SQL工作台](user-manual/sql-workbench/introduction.md)
+    * [CloudBeaver](user-manual/sql-workbench/cloudbeaver/intro.md)
+      * [定制包使用](user-manual/sql-workbench/cloudbeaver/customize.md)
+    * [新版工作台](user-manual/sql-workbench/odc/deploy.md)
+  * [用户管理](user-manual/user-manager/intro.md)
+    * [用户管理](user-manual/user-manager/user.md)
+    * [角色管理](user-manual/user-manager/role.md)
+    * [个人中心](user-manual/user-manager/account.md)
+  * [自定义审核规则](user-manual/customrule.md)
+  * [规则知识库【企业版】](user-manual/knowledgebase.md)
+* [开发者手册](dev-manual/introduction.md)
+  * [IDE审核插件](dev-manual/auditplugins/introduction.md)
+    * [IDEA审核插件](dev-manual/auditplugins/jetbrains.md)
+    * [Eclipse插件](dev-manual/auditplugins/eclipse.md)
+  * [OpenAPI对接](dev-manual/OpenAPI/dmstoken.md)
+  * [审核插件](dev-manual/plugins/intro.md)
+    * [插件使用指南](dev-manual/plugins/howtouse.md)
+    * [插件开发指南](dev-manual/plugins/howtodev.md)
+* [FAQ](FAQ/intro.md)
+  * [支持的数据库及版本](FAQ/whichdatabase.md)
+  * [镜像仓库推荐](FAQ/mirror.md)
+  * [SQL回滚支持程度](FAQ/rollback.md)

docs/user-manual/project/audit_task/img/performance-insight-config.png

@@ -0,0 +1,76 @@
+---
+title: 性能洞察
+---
+
+# 性能洞察
+
+## 功能概述
+
+### 功能用途
+
+性能洞察是数据库的专属"听诊器"和"CT扫描仪"，通过数据库性能的全景视图，帮助用户直观地发现并定位数据库性能问题的根源。
+
+### 应用场景
+
+- 收到数据库 QPS（每秒查询率）下降的告警，却不知从何查起。
+- 看到应用连接池持续走高，想知道是哪些操作占用了宝贵的数据库连接。
+- 常规的监控只能告诉你"出事了"，但要找到"为什么"，依然需要登录服务器、翻阅日志，过程繁琐又低效。
+
+### 主要特点
+
+- **一屏尽览**：实时掌握数据库 QPS 和连接数等核心性能指标。
+- **关联透视**：将 SQL 追踪、TopSQL 分析与性能指标在同一时间轴上精确对齐。
+- **时空回溯**：通过图表拖动选择时间区间，快速筛选关联 SQL。
+
+### 预期效果
+
+不再让数据库性能问题成为难以捉摸的"黑盒"，通过数据驱动的精准定位，实现全新的运维方式。
+
+## 核心功能
+
+### 一屏尽览：实时掌握数据库性能脉搏
+
+性能洞察页面提供了每个数据源最核心的"生命体征"指标：**QPS（每秒查询率）** 和 **连接数**。无需进行任何复杂配置，就能在这块"主心电图"上，随时掌握数据库的整体负载和健康脉搏，第一时间发现异常波动。
+
+### 关联透视：从性能波动到深层定位
+
+借助 SQL 追踪、TopSQL 分析或 Processlist 快照等深度扫描任务与核心性能指标在同一时间轴上进行了精确对齐和关联呈现，你不再需要在多个页面之间来回切换、费力地人工比对时间戳。这种强大的视觉关联，能瞬间将查询思路从"猜测"升级为"定位"，直接锁定问题范围。
+
+### 时空回溯：精准锁定问题SQL
+
+看到图表上的任何可疑迹象？只需用鼠标在图表上轻轻拖动，选中那个时间区间，下方就会立刻筛选出在该时段内，由扫描任务捕获到的所有相关 SQL 列表。从发现现象到锁定元凶，只需一次拖动！
+
+## 前置条件
+
+- 已在「SQL管控配置」中为数据源开启相应的扫描任务（如慢SQL、TopSQL等）。
+- 已开启数据源性能指标监控开关。
+
+## 操作指南
+
+### 配置数据源性能监控
+
+1. 进入「SQL管控配置」页面。
+2. 为需要深入分析的数据源开启扫描任务。
+3. 选择扫描类型，如"慢SQL"、"TopSQL"、"processlist列表"等。
+4. 开启「数据源性能指标」开关，并设置采集周期。
+
+![性能监控配置](img/performance-insight-config.png)
+
+### 使用性能洞察分析
+
+1. 打开「性能洞察」页面，所有图表已为你聚合呈现。
+2. 通过时间范围选择器（24小时、7天、30天、自定义）查看不同时间跨度的性能趋势。
+3. 查看慢SQL趋势图，识别性能异常时间段。
+4. 查看活跃会话数趋势，了解连接池使用情况。
+5. 在图表上拖动鼠标选定问题区间，下方自动筛选出该时段相关的 SQL 列表。
+6. 点击具体 SQL 进行进一步分析和优化。
+
+![性能洞察页面](img/performance-insight-overview.png)
+
+
+## 注意事项
+
+- 性能指标采集会产生较大性能开销，请谨慎开启。
+- 开启后，系统将持续采集该数据源的性能数据（如 QPS、连接数等），并生成性能趋势图表，体现在性能洞察页面。
+- 采集周期默认为 10 分钟，可根据实际需求调整。
+

docs/user-manual/project/audit_task/img/performance-insight-overview.png

@@ -31,33 +31,53 @@ title: 数据源管理
 #### 操作步骤
 点击左侧导航栏的`数据源`菜单，进入数据源管理页面后，点击`添加数据源`，填写数据源相关信息
 
-##### 基本信息配置
+![编辑数据源](./img/edit-instance.png)
+
+##### 基础配置
 
 | 配置项 | 说明 | 是否必填 | 示例 |
 |--------|------|----------|------|
 | 数据源名称 | 具有识别性的唯一名称 | 是 | prod-mysql-01 |
 | 数据源描述 | 补充说明信息 | 否 | 生产环境主库 |
-| 数据库类型 | 选择对应的数据库类型 | 是 | MySQL |
-| 数据库地址 | IP地址或域名 | 是 | 127.0.0.1 |
-| 数据库端口 | 默认将根据数据库类型自动填充 | 是 | 3306 |
+| 数据源类型 | 选择对应的数据库类型 | 是 | MySQL |
+| 数据源地址 | IP地址或域名 | 是 | 127.0.0.1 |
+| 数据源端口 | 默认将根据数据源类型自动填充 | 是 | 3306 |
 | 连接用户 | 具有所需操作权限的用户 | 是 | sqle_user |
-| 密码 | 连接用户的密码 | 是 | - |
-| 环境属性 | 用于标记数据源的环境信息 | 是 | 生产 |
-| 运维时间 | 允许执行工单的时间段 | 否 | 23:00-06:00 |
+| 连接密码 | 连接用户的密码 | 是 | - |
+| 环境属性 | 用于标记数据源的环境信息 | 是 | DEV |
+| 运维时间 | 设置运维时间后，仅能在此运维时段内上线工单 | 否 | 23:00-06:00 |
+
+##### SQL审核配置
 
-##### 高级配置
+管理不同业务场景下SQL执行所需遵循的审核规则，实现精细化管控。
 
 | 配置项 | 说明 | 是否必填 | 示例 |
-|--------|------|--------|------|
-| 审核规则模板 | 用于SQL审核的规则集合 |是| Default_MySQL |
-| SQL查询审核 | 是否开启查询语句审核 | 否 | 开启 |
-| SQL工作台运行查询的最高审核等级 | 允许执行的最高风险等级 | 否 | error |
-| 开启数据源上的SQL备份能力 | 数据源是否需要备份 | 否 | 开启 |
-| 回滚行数限制 |当预计影响行数超过指定值则不回滚  | 是 | 10000 |
- 
+|--------|------|----------|------|
+| 是否开启SQL审核业务 | 关闭后将禁用所有场景的SQL审核 | 否 | 开启 |
+| SQL上线审核规则模板 | 此功能强制开启审核，请为上线流程选择规则模板 | 是 | default_MySQL_V1Rules |
+| 数据导出审核规则模板 | 此功能强制开启审核，请为数据导出选择规则模板 | 是 | default_MySQL_V1Rules |
+| 工作台查询审核 | 用于SQL工作台实时查询，可按需启用 | 否 | 开启 |
+| 工作台查询审核规则模板 | 开启工作台查询审核后，需选择审核规则模板 | 是（开启工作台查询审核时） | default_MySQL_V1Rules |
+| 自动放行的最高审核等级 | 低于或等于此等级的审核结果将自动放行 | 是（开启工作台查询审核时） | notice |
+| 通过工单上线执行工作台非DQL类型SQL | 开启后，允许通过工单上线执行工作台非DQL类型的SQL语句 | 否 | 开启 |
+
+:::tip
+* 是否开启SQL审核业务：默认开启，关闭后将禁用所有场景的SQL审核功能；
+* 工作台查询审核：默认关闭。开启该功能后，用户在SQL工作台中提交的SQL语句，将匹配所选审核规则模板进行实时审核；
+* 自动放行的最高审核等级：支持四种审核等级：normal、notice、warn、error。低于或等于此等级的审核结果将自动放行，超过此等级的SQL语句将报错，不予执行；
+* 通过工单上线执行工作台非DQL类型SQL：开启后，用户可在SQL工作台中通过创建工单的方式执行INSERT、UPDATE、DELETE等非DQL类型的SQL语句。
+:::
+
+##### SQL备份配置
+
+| 配置项 | 说明 | 是否必填 | 示例 |
+|--------|------|----------|------|
+| 是否开启数据源上的SQL备份能力 | 开启后，数据源上创建的工单将默认开启备份能力 | 否 | 开启 |
+| 回滚行数限制 | 当预计影响行数超过指定值则不回滚 | 是 | 1000 |
+
 :::tip
-* SQL查询是否需要审核：默认不审核；如用户选择开启该功能，则用户在SQL工作台中提交的SQL语句，将匹配审核规则模板进行SQL审核操作；
-* 运行查询的最高审核等级：只有开启 SQL查询的审核功能才生效；支持四种审核等级：normal、notice、warn、error，如设置运行查询的最高审核等级为warn，则触发了warn等级规则以上的SQL语句将报错，并不予执行；未触发warn等级规则以上的SQL语句将被执行；
+* SQL备份能力：开启后，针对该数据源创建的工单将默认启用备份功能，便于在执行出错时进行回滚操作；
+* 回滚行数限制：为防止大批量数据操作导致的性能问题，当预计影响行数超过指定阈值时，系统将不执行回滚操作。
 :::
 
 #### 执行结果