Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1534 commits
Select commit Hold shift + click to select a range
adeade1
fix: 调整执行阶段
mayinrain Mar 11, 2025
06f0d29
Merge pull request #769 from mayinrain/dev-1.12.0-webank
mayinrain Mar 11, 2025
a701cfa
code optimization (#770)
kinsanities Mar 11, 2025
3a25381
update python version
kinsanities Mar 11, 2025
9d7dccf
update ldap expire time to 20m
kinsanities Mar 12, 2025
c6a252d
update conf
kinsanities Mar 12, 2025
ba3f275
code optimization
kinsanities Mar 13, 2025
df91ac5
update progress
kinsanities Mar 13, 2025
e8b62ce
update code
kinsanities Mar 13, 2025
323920c
update progress
kinsanities Mar 13, 2025
2c33baa
code optimization
kinsanities Mar 13, 2025
e957b7a
code optimization
kinsanities Mar 14, 2025
0bc7f7b
Code optimization (#771)
v-kkhuang Mar 14, 2025
0032dec
print dynamic param
kinsanities Mar 14, 2025
e667ddd
Merge branch 'dev-1.12.0-webank' of https://github.com/WeDataSphere/l…
kinsanities Mar 14, 2025
ebe21ec
code review fix
kinsanities Mar 14, 2025
d55988f
code optimization
kinsanities Mar 17, 2025
c39bc26
code optimization
kinsanities Mar 17, 2025
7fa2a9f
code optimization
kinsanities Mar 18, 2025
012ee23
Security work order repair (#772)
v-kkhuang Mar 18, 2025
a087ade
code optimization
kinsanities Mar 19, 2025
315e76d
code optimization
kinsanities Mar 19, 2025
25c8e19
update max executors
kinsanities Mar 20, 2025
727aab3
Add Spark 3 default (#774)
v-kkhuang Mar 20, 2025
1819803
bug fix (#775)
v-kkhuang Mar 20, 2025
9464038
revent spring-webflux (#776)
v-kkhuang Mar 20, 2025
6d42456
Security work order repair (#777)
v-kkhuang Mar 20, 2025
e1503cb
add spark conf dir (#778)
v-kkhuang Mar 21, 2025
cc274cc
Dev 1.12.0 code review fix (#779)
v-kkhuang Mar 21, 2025
519819e
velocity exclusion (#780)
v-kkhuang Mar 25, 2025
ebba22a
update thymeleaf version (#781)
v-kkhuang Mar 26, 2025
cd3d634
update version to 1.13.0
kinsanities Apr 2, 2025
0e89a8b
Code optimization (#786)
v-kkhuang Apr 14, 2025
fb0b98f
优化 Hive 和 Spark 配置重置逻辑 (#785)
v-kkhuang Apr 14, 2025
f754dc5
HDFS file system request to add retry mechanism (#783)
v-kkhuang Apr 14, 2025
5acad6b
Spark supports forced conversion: user configuration, department conf…
v-kkhuang Apr 14, 2025
bedcfc6
[1.13.0]Python code adds exception command check (#784)
v-kkhuang Apr 15, 2025
a4f972e
[1.13.0]add datasource rpc GetInfoPublishedByUserIpPortAction (#787)
v-kkhuang Apr 15, 2025
9daf20c
[1.13.0]Spark supports forced conversion: user configuration, departm…
v-kkhuang Apr 15, 2025
f96b60a
Dev 1.13.0 webank temp (#789)
kinsanities Apr 15, 2025
d87ed6e
code optimization
kinsanities Apr 16, 2025
c81ff1e
code format
kinsanities Apr 16, 2025
86ce276
support conn param execute task (#792)
kinsanities Apr 16, 2025
eb993f5
[1.13.0]Data source supports automated publishing (#791)
v-kkhuang Apr 16, 2025
0260d55
fix compile error
kinsanities Apr 16, 2025
24226da
Merge branch 'dev-1.13.0-webank' of https://github.com/WeDataSphere/l…
kinsanities Apr 16, 2025
f9b8f7c
code optimization
kinsanities Apr 16, 2025
d102160
some code retry optimization
kinsanities Apr 17, 2025
2c0a0a3
upd: 样式优化
mayinrain Apr 17, 2025
8e6b43e
upd: 样式优化 (#794)
mayinrain Apr 17, 2025
c1fbe63
Dev 1.13.0 bug fix (#793)
v-kkhuang Apr 17, 2025
a2c0319
code optimization
kinsanities Apr 18, 2025
8e55a58
[1.13.0]code opmitization (#795)
v-kkhuang Apr 18, 2025
4cbcd6b
update jdbc
kinsanities Apr 18, 2025
538823d
upd: 依赖升级
mayinrain Apr 18, 2025
e6afbce
upd: 高度计算逻辑修改
mayinrain Apr 18, 2025
488df91
fix: handle conflict
mayinrain Apr 18, 2025
124d5c3
Merge pull request #796 from mayinrain/dev-1.13.0-webank
mayinrain Apr 18, 2025
2498bba
code optimization
kinsanities Apr 18, 2025
0474967
upd: 放大样式修改
mayinrain Apr 18, 2025
8d54b77
Merge branch 'dev-1.13.0-webank' of github.com:WeDataSphere/linkis in…
mayinrain Apr 18, 2025
afca287
Merge pull request #797 from mayinrain/dev-1.13.0-webank
mayinrain Apr 18, 2025
c99c172
compile error fix
kinsanities Apr 18, 2025
42eb462
upd: height adjustment
mayinrain Apr 18, 2025
a15f488
Merge branch 'dev-1.13.0-webank' of github.com:WeDataSphere/linkis in…
mayinrain Apr 18, 2025
a36a0f2
Merge pull request #798 from mayinrain/dev-1.13.0-webank
mayinrain Apr 18, 2025
865e166
code optimization
kinsanities Apr 21, 2025
f561b5e
Merge branch 'dev-1.13.0-webank' of https://github.com/WeDataSphere/l…
kinsanities Apr 21, 2025
448c44a
Dev 1.13.0 bug fix (#799)
v-kkhuang Apr 22, 2025
b73ce96
template conf optimization
kinsanities Apr 22, 2025
00513f4
classcastexception fix
kinsanities Apr 22, 2025
4a6ab9f
code optimization & format
kinsanities Apr 22, 2025
22b302b
code optimization
kinsanities Apr 23, 2025
772b45d
params optimization
kinsanities Apr 23, 2025
e29e89a
code optimization
kinsanities Apr 23, 2025
ca3a16e
fix: 逻辑兜底
mayinrain Apr 24, 2025
c5127e3
Merge branch 'dev-1.13.0-webank' of github.com:WeDataSphere/linkis in…
mayinrain Apr 24, 2025
e4234b5
Merge pull request #801 from mayinrain/dev-1.13.0-webank
mayinrain Apr 24, 2025
45b67f1
task error receiver sync
kinsanities Apr 24, 2025
2feb8ee
Merge branch 'dev-1.13.0-webank' of https://github.com/WeDataSphere/l…
kinsanities Apr 24, 2025
519b4e0
code optimization
kinsanities Apr 28, 2025
58d23a4
Dev 1.13.0 bug fix (#800)
v-kkhuang Apr 28, 2025
20156ef
add log
kinsanities Apr 28, 2025
74c2d1d
code update
kinsanities Apr 28, 2025
0497d34
add switch
kinsanities Apr 28, 2025
71e6cdd
update code to status rpc
kinsanities Apr 28, 2025
75a677a
add log
kinsanities Apr 29, 2025
63d7c8a
bug fix
kinsanities Apr 29, 2025
83f6f0c
code review fix
kinsanities May 7, 2025
304974b
code review fix (#802)
v-kkhuang May 7, 2025
5eb1a3e
Dev 1.13.0 code review fix (#803)
v-kkhuang May 9, 2025
80cd394
code optimization
kinsanities May 9, 2025
38144bf
add conf retry switch
kinsanities May 12, 2025
8fc7968
code uptate
kinsanities May 12, 2025
429e108
update code add retry code
kinsanities May 14, 2025
82f1fbe
Dev 1.13.0 code review fix (#804)
v-kkhuang May 14, 2025
f469b06
Dev 1.13.0 code review fix (#805)
v-kkhuang May 15, 2025
5b0a89e
Update version to 1.14.0
casionone May 15, 2025
a78fc70
close python safe check (#808)
v-kkhuang Jun 5, 2025
8859ad2
fix resource reset error (#807)
v-kkhuang Jun 5, 2025
901ea56
【1.14.0】Add Doctor functionality and support for switching between AI…
v-kkhuang Jun 5, 2025
282323c
Add BML client connection information retrieval function (#809)
v-kkhuang Jun 5, 2025
02508e4
support change engine type for aisql (#810)
casionone Jun 5, 2025
9682d87
fix todo & adjust interceptor (#811)
casionone Jun 5, 2025
12ffb45
Dev 1.14.0 ai sql support (#812)
v-kkhuang Jun 10, 2025
33284de
Fix resource statistics logic to correctly handle empty resources (#813)
v-kkhuang Jun 12, 2025
92cb02d
Dev 1.14.0 bug fix (#814)
v-kkhuang Jun 16, 2025
31b198d
Dev 1.14.0 bug fix (#815)
v-kkhuang Jun 17, 2025
2ec8fa2
code review fix (#816)
casionone Jun 17, 2025
540af07
Dev 1.14.0 bug fix (#817)
v-kkhuang Jun 17, 2025
ef3bf78
Dev 1.14.0 bug fix (#818)
v-kkhuang Jun 18, 2025
c9be3d4
Dev 1.14.0 bug fix (#819)
v-kkhuang Jun 19, 2025
19c5799
Dev 1.14.0 bug fix (#820)
v-kkhuang Jun 19, 2025
0ff28ab
Update version to 1.15.0-wds
casionone Jun 26, 2025
c0317e1
在JobHistory的搜索和查询接口中添加了runType参数,允许根据运行类型筛选作业历史记录 (#823)
v-kkhuang Jul 16, 2025
a2a50da
【1.15.0】Dev 1.15.0 sys user login (#822)
v-kkhuang Jul 18, 2025
ae34839
【1.15.0】Linkis token rsa (#821)
v-kkhuang Jul 18, 2025
f408749
spark3 dynamic params (#825)
v-kkhuang Jul 18, 2025
6adab49
linkis keytab (#824)
v-kkhuang Jul 18, 2025
17de8d7
upd: 令牌管理新增token查看;全局历史优化
mayinrain Jul 23, 2025
38e7760
Merge pull request #826 from mayinrain/dev-1.15.0-webank
mayinrain Jul 23, 2025
361a334
fix: 初始化问题修复
mayinrain Jul 23, 2025
3073448
Merge pull request #827 from mayinrain/dev-1.15.0-webank
mayinrain Jul 23, 2025
aa04987
upd: 格式化
mayinrain Jul 23, 2025
f26718a
Merge pull request #828 from mayinrain/dev-1.15.0-webank
mayinrain Jul 23, 2025
f3755ba
update conf & code format (#829)
casionone Jul 23, 2025
111bd88
Code optimization (#830)
v-kkhuang Jul 23, 2025
165d38f
i18n optimization
mayinrain Jul 25, 2025
cedd09e
Merge pull request #831 from mayinrain/dev-1.15.0-webank
mayinrain Jul 25, 2025
fb55a58
fix: 新增不禁用名字输入
mayinrain Jul 29, 2025
c60b8a8
Merge pull request #833 from mayinrain/dev-1.15.0-webank
mayinrain Jul 29, 2025
daf0f3c
Dev 1.15.0 code review fix (#832)
v-kkhuang Jul 30, 2025
7a0ba00
fix: has specific task id, ignore runtype
mayinrain Jul 31, 2025
ae90c04
Merge pull request #835 from mayinrain/dev-1.15.0-webank
mayinrain Jul 31, 2025
f7e96dc
Dev 1.15.0 code review fix (#834)
v-kkhuang Jul 31, 2025
a63330d
Dev 1.15.0 webank spark3 (#836)
casionone Jul 31, 2025
c82c5e2
add log for reuse engine
kinsanities Aug 4, 2025
5e8d559
add log
kinsanities Aug 5, 2025
f1a6a4e
update log
kinsanities Aug 5, 2025
ba729e7
update shuff
kinsanities Aug 5, 2025
9b08845
Dev 1.15.0 code review fix (#837)
v-kkhuang Aug 8, 2025
6b6f500
The openfile interface supports masking field information (#839)
v-kkhuang Aug 11, 2025
8da600e
Code optimization (#843)
v-kkhuang Aug 11, 2025
f5a82b9
update version to 1.8.0
casionone Aug 13, 2025
dac7e73
Upgrade `LINKIS_VERSION` to `1.8.0` to Fix Integration Test Failure i…
kazutoiris Aug 20, 2025
a29882a
entrance and linkismanager performance optimization (#853)
casionone Aug 21, 2025
7b6522c
add cache for ec reuse (#854)
casionone Aug 21, 2025
a2689d0
Dev 1.15.0 code review fix (#852)
v-kkhuang Aug 21, 2025
b03a4ce
update lock timeout
kinsanities Aug 21, 2025
27bcbd9
Dev 1.15.0 code review fix (#855)
v-kkhuang Aug 27, 2025
4ee7ea4
Fix KIND image loading, script typo, and cache directory creation (#5…
kazutoiris Aug 29, 2025
fc11506
Dev 1.15.0 code review fix (#856)
v-kkhuang Aug 29, 2025
8baf63a
Dev 1.15.0 code review fix (#857)
v-kkhuang Sep 1, 2025
75f23a1
chore: prepare to release 1.8.0 (#5254)
kazutoiris Sep 2, 2025
6da2f69
Dev 1.15.0 code review fix (#858)
v-kkhuang Sep 2, 2025
298e50f
Update version to 1.16.0
casionone Sep 8, 2025
d997570
add ai prompt base rule
kinsanities Sep 10, 2025
38dd1b2
[1.16.0]sensetive sql check (#860)
v-kkhuang Sep 12, 2025
3a30ffb
[1.16.0]feat: 历史任务信息获取接口添加brief参数优化 (#859)
v-kkhuang Sep 12, 2025
3a3ca19
feat: 从get接口读查openEngineLog用的参数 (#861)
daflyinbed Sep 12, 2025
d13d382
[1.16.0] get support engine log (#862)
v-kkhuang Sep 12, 2025
71c9d8e
refactor(web): remove request /ecrHistoryList (#863)
daflyinbed Sep 15, 2025
71b56c9
fix(web): 显示引擎日志的时候才显示UDF日志 (#864)
daflyinbed Sep 15, 2025
feadd39
Code optimization
v-kkhuang Sep 16, 2025
97b0c43
Merge pull request #865 from WeDataSphere/dev-1.16.0-code-review-fix
wushengyeyouya Sep 16, 2025
9a3d2f8
Code optimization
v-kkhuang Sep 17, 2025
cf96291
Code optimization
v-kkhuang Sep 17, 2025
39f99e7
Code optimization
v-kkhuang Sep 17, 2025
1d2eb9a
Code optimization
v-kkhuang Sep 17, 2025
370955e
Code optimization
v-kkhuang Sep 17, 2025
2bc4acc
Code optimization (#866)
v-kkhuang Sep 17, 2025
4148e73
Merge branch 'dev-1.16.0-webank' into dev-1.16.0-code-review-fix
v-kkhuang Sep 17, 2025
6e483c9
Code optimization
v-kkhuang Sep 17, 2025
7da37d6
Code optimization
v-kkhuang Sep 18, 2025
6db7f22
Dev 1.16.0 code review fix (#867)
v-kkhuang Sep 18, 2025
3fbc439
fix(web): 兼容老接口 (#868)
daflyinbed Sep 19, 2025
9a6c91f
Merge branch 'dev-1.16.0-webank' into dev-1.16.0-code-review-fix
v-kkhuang Sep 22, 2025
e406663
Code optimization
v-kkhuang Sep 22, 2025
8462339
Code optimization
v-kkhuang Sep 22, 2025
3eae827
Dev 1.16.0 code review fix (#869)
v-kkhuang Sep 22, 2025
7697578
support azure (#5214)
v-kkhuang Sep 22, 2025
872a492
chore(web): update axios (#870)
daflyinbed Sep 22, 2025
30a6af7
Merge branch 'dev-1.16.0-webank' into dev-1.16.0-code-review-fix
v-kkhuang Sep 23, 2025
db841d9
Code optimization
v-kkhuang Sep 23, 2025
37278bc
Merge pull request #871 from WeDataSphere/dev-1.16.0-code-review-fix
wushengyeyouya Sep 24, 2025
ffff2a4
Safety Work Order Repair
v-kkhuang Sep 25, 2025
bc68fac
Merge pull request #872 from WeDataSphere/dev-1.16.0-code-review-fix
wushengyeyouya Sep 25, 2025
7d58d35
Add OAuth2 authentication support (#5253)
kazutoiris Sep 28, 2025
59c29d7
fix azure compile error (#5264)
aiceflower Sep 30, 2025
feb03e5
remove default token (#5265)
aiceflower Oct 7, 2025
049ad8e
fix token security (#5266)
aiceflower Oct 8, 2025
cf6bc34
Merge upstream changes and apply additional improvements (#5279)
kazutoiris Oct 30, 2025
7a63e0f
docs(readme): remove underlines between badges (#5283)
kazutoiris Oct 31, 2025
2a3d1b1
feat(ci): add support for spark and hive engine integration tests (#5…
kazutoiris Nov 21, 2025
e0409b8
Merge Apache improvements to WDS linkis-commons (#913)
casionone Dec 26, 2025
b77404d
Merge computation governance to wds (#914)
casionone Dec 26, 2025
a441633
merge engineconn plugins (#915)
casionone Dec 26, 2025
2bc389d
merge pes (#917)
casionone Dec 29, 2025
610b7b5
merge linkis-mg (#918)
casionone Dec 29, 2025
a957dca
code merge
aiceflower Dec 30, 2025
8e781e2
fix compile error
kinghao007 Dec 31, 2025
9ec5d81
merge presto ec. scala to java
aiceflower Dec 31, 2025
f1b17dd
fix sparkMeasure support spark2 & spark3
kinghao007 Dec 31, 2025
1e76a0d
sparkMeasure support spark3
kinghao007 Dec 31, 2025
85e15c5
fix code compile error
kinghao007 Dec 31, 2025
46a9ec3
merge seatunnel
aiceflower Dec 31, 2025
e01fe24
Merge branch 'wds-master' of https://github.com/WeDataSphere/linkis i…
aiceflower Dec 31, 2025
a8ef133
code compile optimization
kinghao007 Dec 31, 2025
68d8c10
fix conflict
aiceflower Jan 4, 2026
25d8994
fix compile (#921)
casionone Jan 13, 2026
153cd49
feat(ci): add support for parallel build (#5330)
kazutoiris Mar 7, 2026
8d1ade2
#AI COMMIT# 增强 quick-build.sh 脚本版本自定义能力
kinghao007 Mar 10, 2026
b454d46
#AI COMMIT# fix: Update flatten-maven-plugin mode to oss
kinghao007 Mar 16, 2026
8769ef9
#AI commit# feat: Align default versions with dev-1.18.0-webank branch
kinghao007 Mar 20, 2026
7f01a24
#AI commit# fix: Add hbase-shims-1.2.1 module for default HBase 1.2.1…
kinghao007 Mar 20, 2026
ebacf49
update linkis gateway dependency
kinghao007 Mar 20, 2026
99c0f63
#AI COMMIT# update compile
kinghao007 Mar 23, 2026
5701485
#AI COMMIT# refactor: 优化 quick-build.sh 去除重复编译配置
aiceflower Mar 25, 2026
8851737
merge conflict
aiceflower Mar 25, 2026
115884b
#AI COMMIT# refactor: 优化代码结构和修复问题
aiceflower Mar 25, 2026
652e053
#AI COMMIT# refactor: 移除 known-dependencies.txt 中的注释
aiceflower Mar 25, 2026
b94c86c
#AI COMMIT# refactor: 更新 pom.xml 和 quick-build.sh
aiceflower Mar 25, 2026
395d06c
#AI COMMIT# fix: 更新 known-dependencies.txt 添加缺失的依赖
aiceflower Mar 25, 2026
de07000
#AI COMMIT# fix: 添加缺失的依赖到 known-dependencies.txt
aiceflower Mar 25, 2026
d8dce3f
Merge pull request #5345 from WeDataSphere/origin/dev-1.9.0
aiceflower Mar 26, 2026
744290a
Fix and update metrics information exception bug (#5296)
v-kkhuang Mar 26, 2026
2759fdc
The result set supports field truncation (#5297)
v-kkhuang Mar 26, 2026
e540d6e
Provide an interface for accessing available data sources (#5295)
v-kkhuang Mar 26, 2026
86f88c1
Merge branch 'master' into dev-1.9.0
aiceflower Mar 26, 2026
9847911
Fix mockito version property reference in pom.xml
aiceflower Mar 26, 2026
16b5183
#AI COMMIT# Refactor: simplify logger.error calls in engine services
aiceflower Mar 26, 2026
833afdc
#AI commit# feat: 优化bmlClient连接池参数 (#5359)
v-kkhuang Mar 26, 2026
3481d18
[feat][Linkis] integrate BES application server for domestic localiza…
aiceflower Mar 26, 2026
b245569
#AI commit# feat: AISQL支持starrocks切换 (#5363)
aiceflower Mar 26, 2026
6c553bd
[feat][Linkis] integrate BES application server for domestic localiza…
aiceflower Mar 26, 2026
8e196ad
#AI commit# feat: 优化bmlClient连接池参数 (#5366)
aiceflower Mar 26, 2026
3c0d6bf
#AI commit# 开发阶段:优化jdbc堆栈日志不全,monitor 清理定时任务时间优化,manager线程池优化 (#5368)
aiceflower Mar 26, 2026
177fc01
[feat][PES][datasource] add support for getting published datasource …
aiceflower Mar 26, 2026
2937222
#AI commit# 优化:解决引擎创建和复用时指标更新的空指针异常 (#5372)
aiceflower Mar 26, 2026
c6e38ac
#AI commit# 优化: AI规约文档提交,Linkis日志打印优化 (#5374)
aiceflower Mar 26, 2026
17af4ba
[feature][PES][datasource] add support for getting published datasour…
aiceflower Mar 26, 2026
7b130d9
#AI commit# perf: 优化引擎创建和复用服务性能 (#5378)
aiceflower Mar 26, 2026
cf2cbf3
#AI commit# feat: hadoop用户禁止登录管理台 (#5380)
aiceflower Mar 26, 2026
2354bd1
[feature][COM][commons] add log level filtering capability (#5382)
aiceflower Mar 26, 2026
0ec73b1
#AI commit# feat: 添加spark超时任务诊断功能和优化配置 (#5384)
aiceflower Mar 26, 2026
6085ce7
#AI commit# feat: 实现starrocks任务重试机制 (#5386)
aiceflower Mar 26, 2026
03e86df
#AI commit# feat: 添加批量队列资源获取功能 (#5388)
aiceflower Mar 26, 2026
f7a1822
#AI COMMIT# refactor: 代码格式化调整
aiceflower Mar 26, 2026
a9ef58d
#AI COMMIT# refactor: 移除 bes 相关依赖包
aiceflower Mar 26, 2026
f93a847
#AI COMMIT# ci: 更新 build-backend.yml 适配实际 Maven profile 配置
aiceflower Mar 26, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
188 changes: 188 additions & 0 deletions .ai/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
# Linkis AI 开发文档导航

> **版本信息**
> - 文档版本: 1.0.0
> - 最后更新: 2025-01-28
> - 适用版本: Apache Linkis 1.17.0+

---

## 🚀 快速开始

### 新手必读(按顺序阅读)
1. **[项目核心规约](./project-context.md)** - 包含技术栈、架构设计、开发规范和模板
2. **[强制性开发规则](./rules.md)** - 必须无条件遵守的开发规则
3. **[模块文档](#模块文档索引)** - 根据你要开发的功能选择对应模块

### 常见开发场景快速跳转
- 🆕 新增 REST 接口 → [REST接口开发模板](#rest接口开发)
- ⚙️ 添加配置项 → [配置管理规范](#配置管理)
- 🗄️ 修改数据库 → [数据库变更规范](#数据库变更)
- 🐛 异常处理 → [异常处理规范](#异常处理)
- 📝 日志记录 → [日志规范](#日志规范)

---

## 📚 核心文档索引

### 🎯 开发规范文档
| 文档 | 用途 | 何时查看 |
|------|------|----------|
| [project-context.md](./project-context.md) | 项目角色定位、技术栈、架构设计、开发模板 | 开始任何开发工作前必读 |
| [rules.md](./rules.md) | 强制性开发规则、需求实现步骤 | 每次开发新需求时参考 |

### 🏗️ 模块文档索引

#### 微服务治理服务(基础设施层)
| 服务 | 文档 | 主要功能 |
|------|------|----------|
| Gateway | [gateway.md](./modules/microservice-governance/gateway.md) | API网关、路由转发、安全认证 |
| Eureka | [eureka.md](./modules/microservice-governance/eureka.md) | 服务注册与发现 |
| 概览 | [README.md](./modules/microservice-governance/README.md) | 微服务治理服务概述 |

#### 计算治理服务(核心业务层)
| 服务 | 文档 | 主要功能 |
|------|------|----------|
| Entrance | [entrance.md](./modules/computation-governance/entrance.md) | 任务提交入口、调度管理 |
| JobHistory | [jobhistory.md](./modules/computation-governance/jobhistory.md) | 任务历史记录查询 |
| Manager | [manager.md](./modules/computation-governance/manager.md) | 资源管理、应用管理 |
| ECM | [ecm.md](./modules/computation-governance/ecm.md) | 引擎连接管理 |
| 概览 | [README.md](./modules/computation-governance/README.md) | 计算治理服务概述 |

#### 公共增强服务(支撑服务层)
| 服务 | 文档 | 主要功能 |
|------|------|----------|
| PublicService | [publicservice.md](./modules/public-enhancements/publicservice.md) | 公共服务、文件管理 |
| Configuration | [configuration.md](./modules/public-enhancements/configuration.md) | 配置管理 |
| BML | [bml.md](./modules/public-enhancements/bml.md) | 大数据物料库 |
| DataSource | [datasource.md](./modules/public-enhancements/datasource.md) | 数据源管理 |
| Context | [context.md](./modules/public-enhancements/context.md) | 上下文服务 |
| Monitor | [monitor.md](./modules/public-enhancements/monitor.md) | 监控服务 |
| 概览 | [README.md](./modules/public-enhancements/README.md) | 公共增强服务概述 |

---

## 🔍 按功能快速查找

### <a name="rest接口开发"></a>REST接口开发
- **开发模板**: [project-context.md - REST接口层](./project-context.md#1-rest接口层)
- **API规范**: [project-context.md - API设计规范](./project-context.md#api设计规范)
- **参考示例**:
- Entrance接口: [entrance.md - API Interfaces](./modules/computation-governance/entrance.md#api-interfaces)
- Configuration接口: [configuration.md - API Interfaces](./modules/public-enhancements/configuration.md#api-interfaces)

### <a name="配置管理"></a>配置管理
- **配置规范**: [project-context.md - 配置管理规范](./project-context.md#配置管理规范)
- **配置示例库**: [project-context.md - 常用配置示例库](./project-context.md#常用配置示例库)
- **配置模板**: [project-context.md - 配置类](./project-context.md#4-配置类)
- **参考实现**: linkis-jobhistory/conf/JobhistoryConfiguration

### <a name="数据库变更"></a>数据库变更
- **变更规则**: [rules.md - 数据库修改原则](./rules.md#数据库修改原则)
- **DDL脚本位置**: `linkis-dist/package/db/linkis_ddl.sql`
- **DML脚本位置**: `linkis-dist/package/db/linkis_dml.sql`
- **表结构参考**: 各模块文档的 "Database Table Structures" 章节

### <a name="异常处理"></a>异常处理
- **异常规范**: [project-context.md - 异常处理规范](./project-context.md#异常处理规范)
- **统一异常**: `org.apache.linkis.common.exception.LinkisException`
- **常见错误**: [project-context.md - 常见错误及避免方法](./project-context.md#常见错误及避免方法)

### <a name="日志规范"></a>日志规范
- **日志规范**: [project-context.md - 日志规范](./project-context.md#日志规范)
- **Logger定义**: 必须使用 `LoggerFactory.getLogger(ClassName.class)`
- **日志级别**: ERROR/WARN/INFO/DEBUG 使用场景

---

## 🎨 开发模板快速复制

### 新增功能完整流程
```
1. 查看 rules.md - 需求实现步骤
2. 创建需求文档和设计文档
3. 使用 project-context.md 中的代码模板:
- REST接口层模板
- 服务层模板
- 数据访问层模板
- 配置类模板
4. 添加功能开关(默认false)
5. 记录数据库变更
6. 编写测试和文档
```

### REST接口模板快速链接
👉 [project-context.md - 新功能开发模板](./project-context.md#新功能开发模板)

### 配置类模板快速链接
👉 [project-context.md - 配置类](./project-context.md#4-配置类)

---

## ⚠️ 重要提醒

### 🚫 禁止操作(来自 rules.md)
- **数据库结构**: 除非明确指定,严禁修改现有表结构
- **第三方依赖**: 不允许引入新的第三方依赖库
- **核心接口**: 不得修改现有公共接口的签名

### ✅ 必须遵守
- **最小改动原则**: 所有功能实现必须遵循最小改动原则
- **功能可配置**: 所有功能必须增加功能开关,默认关闭
- **向后兼容**: 新增功能必须考虑向后兼容性

---

## 💡 开发技巧

### 编程语言选择
- **Java**: REST API、Service层、Entity类、配置类
- **Scala**: 计算逻辑、RPC通信、复杂业务处理、配置对象

### 字符编码
统一使用 `StandardCharsets.UTF_8`,禁止使用字符串 `"UTF-8"`

### 统一返回体
所有REST接口返回 `org.apache.linkis.server.Message`

---

## 📖 如何使用这些文档

### 场景1: 我要在 Entrance 服务中新增一个接口
1. 阅读 [entrance.md](./modules/computation-governance/entrance.md) 了解服务结构
2. 查看 [project-context.md - REST接口层模板](./project-context.md#1-rest接口层)
3. 参考 entrance.md 中现有接口实现
4. 遵循 [rules.md](./rules.md) 中的开发规则
5. 添加功能开关配置

### 场景2: 我需要添加一个新的配置项
1. 查看 [project-context.md - 配置管理规范](./project-context.md#配置管理规范)
2. 参考 [project-context.md - 配置类模板](./project-context.md#4-配置类)
3. 查看 `JobhistoryConfiguration` 实现示例
4. 在当前模块的 conf 目录下的 Configuration 类中添加

### 场景3: 我需要修改数据库表
1. 查看 [rules.md - 数据库修改原则](./rules.md#数据库修改原则)
2. 确认是否能通过新增字段实现(优先选择)
3. 将变更记录到 `linkis-dist/package/db/linkis_ddl.sql`
4. 如有初始化数据,记录到 `linkis-dist/package/db/linkis_dml.sql`

---

## 🔄 文档更新记录

| 版本 | 日期 | 更新内容 | 更新人 |
|------|------|----------|--------|
| 1.0.0 | 2025-01-28 | 创建导航文档,优化文档结构 | AI |

---

## 📞 帮助与反馈

如果文档中有不清楚的地方,请:
1. 先查看对应模块的详细文档
2. 查看 project-context.md 中的开发模板和示例
3. 参考现有代码实现

**记住**: 遵循规范比快速开发更重要!
157 changes: 157 additions & 0 deletions .ai/modules/computation-governance/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
# Computation Governance Services

The computation governance services handle the core computation task lifecycle management in Linkis.

## Service Modules

- [Entrance Service](./entrance.md) - Task submission and entrance point
- [Manager Service](./manager.md) - Resource and application management
- [ECM Service](./ecm.md) - Engine Connection Manager
- [JobHistory Service](./jobhistory.md) - Task execution history tracking

## Overview

These services form the core of Linkis' computation governance capabilities, managing the complete lifecycle of computation tasks from submission to execution and monitoring.

## Common Features

### Task Lifecycle Management
- Task submission and validation
- Task scheduling and resource allocation
- Task execution monitoring
- Task result management
- Task error handling and recovery

### Engine Management
- Dynamic engine connection creation
- Engine lifecycle management
- Engine resource monitoring
- Engine scaling capabilities

### Resource Governance
- Multi-tenant resource isolation
- Load balancing across engines
- Resource usage tracking
- Quota management

## API Interface Summary

### Entrance Service APIs
- Task submission: `POST /api/entrance/submit`
- Task status query: `GET /api/entrance/{id}/status`
- Task progress: `GET /api/entrance/{id}/progress`
- Task log retrieval: `GET /api/entrance/{id}/log`
- Task cancellation: `GET /api/entrance/{id}/kill`

### Manager Service APIs
- Engine instance management
- Resource allocation and monitoring
- Node status querying
- Engine creation requests

### ECM Service APIs
- Engine connection management
- Engine lifecycle operations
- Resource reporting
- Engine metrics collection

### JobHistory Service APIs
- Job history querying
- Job detail retrieval
- Job statistics reporting

## Database Schema Summary

### Job History Group Table
```sql
CREATE TABLE `linkis_ps_job_history_group_history` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'Primary Key, auto increment',
`job_req_id` varchar(64) DEFAULT NULL COMMENT 'job execId',
`submit_user` varchar(50) DEFAULT NULL COMMENT 'who submitted this Job',
`execute_user` varchar(50) DEFAULT NULL COMMENT 'who actually executed this Job',
`source` text DEFAULT NULL COMMENT 'job source',
`labels` text DEFAULT NULL COMMENT 'job labels',
`params` text DEFAULT NULL COMMENT 'job params',
`progress` varchar(32) DEFAULT NULL COMMENT 'Job execution progress',
`status` varchar(50) DEFAULT NULL COMMENT 'Script execution status, must be one of the following: Inited, WaitForRetry, Scheduled, Running, Succeed, Failed, Cancelled, Timeout',
`log_path` varchar(200) DEFAULT NULL COMMENT 'File path of the job log',
`error_code` int DEFAULT NULL COMMENT 'Error code. Generated when the execution of the script fails',
`error_desc` varchar(1000) DEFAULT NULL COMMENT 'Execution description. Generated when the execution of script fails',
`created_time` datetime(3) DEFAULT CURRENT_TIMESTAMP(3) COMMENT 'Creation time',
`updated_time` datetime(3) DEFAULT CURRENT_TIMESTAMP(3) COMMENT 'Update time',
`instances` varchar(250) DEFAULT NULL COMMENT 'Entrance instances',
`metrics` text DEFAULT NULL COMMENT 'Job Metrics',
`engine_type` varchar(32) DEFAULT NULL COMMENT 'Engine type',
`execution_code` text DEFAULT NULL COMMENT 'Job origin code or code path',
`result_location` varchar(500) DEFAULT NULL COMMENT 'File path of the resultsets',
`observe_info` varchar(500) DEFAULT NULL COMMENT 'The notification information configuration of this job',
PRIMARY KEY (`id`),
KEY `idx_created_time` (`created_time`),
KEY `idx_submit_user` (`submit_user`)
);
```

### Job History Detail Table
```sql
CREATE TABLE `linkis_ps_job_history_detail` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'Primary Key, auto increment',
`job_history_id` bigint(20) NOT NULL COMMENT 'ID of JobHistory',
`result_location` varchar(500) DEFAULT NULL COMMENT 'File path of the resultsets',
`execution_content` text DEFAULT NULL COMMENT 'The script code or other execution content executed by this Job',
`result_array_size` int(4) DEFAULT 0 COMMENT 'size of result array',
`job_group_info` text DEFAULT NULL COMMENT 'Job group info/path',
`created_time` datetime(3) DEFAULT CURRENT_TIMESTAMP(3) COMMENT 'Creation time',
`updated_time` datetime(3) DEFAULT CURRENT_TIMESTAMP(3) COMMENT 'Update time',
`status` varchar(32) DEFAULT NULL COMMENT 'status',
`priority` int(4) DEFAULT 0 COMMENT 'order of subjob',
PRIMARY KEY (`id`)
);
```

### Common Lock Table
```sql
CREATE TABLE `linkis_ps_common_lock` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`lock_object` varchar(255) COLLATE utf8_bin DEFAULT NULL,
`locker` VARCHAR(255) CHARSET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT 'locker',
`time_out` longtext COLLATE utf8_bin,
`update_time` datetime DEFAULT CURRENT_TIMESTAMP,
`create_time` datetime DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`id`),
UNIQUE KEY `uniq_lock_object` (`lock_object`)
);
```

## RPC Methods Summary

### Entrance Service RPCs
- `submitTask(TaskRequest request)`
- `getTaskStatus(String taskId)`
- `cancelTask(String taskId)`
- `getTaskResult(String taskId)`

### Manager Service RPCs
- `requestEngine(EngineRequest request)`
- `releaseEngine(String engineId)`
- `getEngineStatus(String engineId)`
- `getNodeMetrics(String nodeId)`

### ECM Service RPCs
- `createEngineConnection(EngineCreateRequest request)`
- `terminateEngineConnection(String engineId)`
- `reportEngineResourceUsage(String engineId, ResourceUsage usage)`
- `getEngineMetrics(String engineId)`

### JobHistory Service RPCs
- `saveJobHistory(JobHistory history)`
- `queryJobHistory(JobHistoryQuery query)`
- `getJobDetails(Long jobId)`
- `updateJobStatus(Long jobId, String status)`

## Dependencies

- linkis-commons - Shared utilities
- linkis-protocol - Communication protocols
- linkis-rpc - Remote procedure calls
- Various engine connection plugins
- Spring Cloud ecosystem
Loading
Loading