apache / apache/incubator-seata

Documentation lacks explanation of `service.enableDegrade` property

Open
#6,347 2 comments 0 reactions 1 assignee Claimed by @slievrly View on GitHub
Dominant language
Java
Stars
26k
Forks
8.8k
Avg merge
1d 8h
Merged PRs (30d)
4

Description

- [x] I have searched the [issues](https://github.com/seata/seata/issues) of this repository and believe that this is not a duplicate.

### Ⅰ. Issue Description

- Documentation lacks explanation of `service.enableDegrade` property.

- In https://github.com/apache/incubator-seata/blob/v2.0.0/script/client/conf/file.conf , there is a property called `service.enableDegrade` and annotated as `degrade, current not support`.
```
service {
#transaction service group mapping
vgroupMapping.default_tx_group = "default"
#only support when registry.type=file, please don't set multiple addresses
default.grouplist = "127.0.0.1:8091"
#degrade, current not support
enableDegrade = false
#disable seata
disableGlobalTransaction = false
}
```

- But it doesn't look like it's documented at https://seata.apache.org/docs/user/configurations/ .
- At https://seata.apache.org/docs/user/configurations100/ , it looks like there is a very strange record.
```
key desc remark
service.disableGlobalTransaction service.enableDegrade transaction Group (Appendix 1)
```
- If you switch to https://seata.apache.org/zh-cn/docs/user/configurations100/ , it seems that the records are not consistent with the English documentation.

```
key desc remark
service.enableDegrade 降级开关(待实现)默认false。业务侧根据连续错误数自动降级不走seata事务
```
- According to the Chinese documentation, this appears to correspond to `client.tm.downgradeCheck` at https://seata.apache.org/zh-cn/docs/user/configurations/#client%E7%AB%AF .

```
key desc remark
client.tm.degradeCheck 降级开关 默认false。业务侧根据连续错误数自动降级不走seata事务(详细介绍请阅读附录6)
```

- This introduces a new problem. `client.tm.downgradeCheck` and `service.enableDegrade` seem to have exactly the same function. Why do we need two properties to do the same thing?

- An early investigation is at https://github.com/apache/shardingsphere/pull/30138 .

### Ⅱ. Describe what happened

- Null.

### Ⅲ. Describe what you expected to happen

- Possible documentation updates or template updates.

### Ⅳ. How to reproduce it (as minimally and precisely as possible)

1. Open https://seata.apache.org/docs/user/configurations/ .
2. Open https://github.com/apache/incubator-seata/blob/v2.0.0/script/client/conf/file.conf .
3. Open https://github.com/apache/incubator-seata/blob/2.x/script/client/conf/file.conf .

Minimal yet complete reproducer code (or URL to code):

- Null.

### Ⅴ. Anything else we need to know?

- Null.

### Ⅵ. Environment:

- JDK version(e.g. `java -version`):

```shell
openjdk version "21.0.2" 2024-01-16
OpenJDK Runtime Environment GraalVM CE 21.0.2+13.1 (build 21.0.2+13-jvmci-23.1-b30)
OpenJDK 64-Bit Server VM GraalVM CE 21.0.2+13.1 (build 21.0.2+13-jvmci-23.1-b30, mixed mode, sharing)
```

- Seata client/server version: `2.0.0`
- Database version: MySQL Server 8.3.0
- OS(e.g. `uname -a`): `Linux DESKTOP-J7M76VH 5.15.133.1-microsoft-standard-WSL2 #1 SMP Thu Oct 5 21:02:42 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux`
- Others: Null

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.