Skip to content

Commit 2e51158

Browse files
committed
fix: 更新文档
1 parent d3be334 commit 2e51158

File tree

3 files changed

+40
-20
lines changed

3 files changed

+40
-20
lines changed

docs/cn/error.md

+27-10
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,35 @@ data: "the error is caused by xxx"
1414
}
1515
```
1616

17+
18+
## 无堆栈异常
19+
一般情况下,业务的异常应该使用这种方式抛出。http返回值为500,respons code为-1,不返回错误堆栈。
20+
21+
```
22+
from ab.utils.exceptions import AlgorithmException
23+
raise AlgorithmException(data="this is an exception")
24+
25+
26+
返回值:
27+
{
28+
code: -1,
29+
data: "this is an exception"
30+
}
31+
```
32+
33+
1734
## 有堆栈异常
1835

36+
为什么有时需要把异常堆栈返回给前端呢?有些项目的交付环境很特殊,比如不方便登录服务器,这就需要把错误信息返回给前端,方便远程运维,当然,这么做是非常不安全的。
37+
1938
### 第一种异常
2039

2140
http返回值为500,response code为-1,返回错误堆栈。
2241
```
2342
i = 1 / 0
43+
44+
45+
2446
返回值:
2547
{
2648
code: -1,
@@ -45,7 +67,11 @@ data: [
4567
### 第二种异常
4668
不指定data属性,默认将堆栈附带到返回值中
4769
```
70+
from ab.utils.exceptions import AlgorithmException
4871
raise AlgorithmException()
72+
73+
74+
4975
返回值:
5076
{
5177
code: -1,
@@ -68,13 +94,4 @@ data: [
6894
```
6995

7096

71-
## 无堆栈异常
72-
http返回值为500,respons code为-1,不返回错误堆栈。
73-
```
74-
raise AlgorithmException(data="this is an exception")
75-
返回值:
76-
{
77-
code: -1,
78-
data: "this is an exception"
79-
}
80-
```
97+

examples/simple/.ab

+10-10
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ app_version=0.0.2
99
sl_namespace=Default
1010

1111
# [必填] 镜像仓库的地址
12-
acr_address=registry.<your-region>.aliyuncs.com
12+
acr_address=registry.your-region.aliyuncs.com
1313

1414
# [必填] 镜像仓库的namespace
15-
acr_namespace=<your-docker-namespace>
15+
acr_namespace=your-docker-namespace
1616

1717
# [必填] 在容器内部,应用的日志绝对路径
1818
log_path=/root/app/logs
1919

20-
# [必填] 你的远端oss bukect名称。上传下载命令,会自动把指定的文件同步到这个bucket下。部署时,也会从这个bucket下自动挂载文件。
21-
oss_bucket=<your-oss-bucket>
20+
# [选填] 你的远端oss bukect名称。上传下载命令,会自动把指定的文件同步到这个bucket下。部署时,也会从这个bucket下自动挂载文件。如果不使用阿里云的OSS作为模型存储功能,可以不填
21+
oss_bucket=
2222

23-
# [必填] 部署到SAE时的vpc,交换机,slb,安全组信息
24-
vpc=<your-SAE-vpc-id>
25-
vsw=<your-vswitch-id>
26-
slb=<your-slb-id>
27-
sg=<your-security-group-id>
28-
slb_ip=<your-slb-ip>
23+
# [选填] 部署到SAE时的vpc,交换机,slb,安全组信息。如果不使用阿里云的serverless服务,可以不填
24+
vpc=
25+
vsw=
26+
slb=
27+
sg=
28+
slb_ip=
2929

3030
# ================================================
3131
# ================================================

roadmap.md

+3
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@
88
# 3.2.0.0
99
- 完成插件的重构
1010
- 更便捷的访问主流db数据
11+
12+
# 3.3
13+
- todo: 瘦身基础镜像和业务镜像

0 commit comments

Comments
 (0)