Skip to content

Commit

Permalink
feat: update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Madxf committed Jun 6, 2024
1 parent 6f6352e commit 3575eb9
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,27 @@ The echo method uses the following configuration (0.3, 100) and other methods us
}
}
```

##### Degradation: Category=degradation

[JSON Schema](https://github.com/cloudwego/kitex/blob/develop/pkg/#L30)

| Variable |Introduction|
|------------|----|
| enable | Whether to enable degradation|
| percentage | The percentage of dropped requests|

Example:

The all requests uses the following configuration (true, 50)
> configDataId: `ClientName.ServiecName.degradation`

```json
{
"enable": true,
"percentage": 50
}
```
### More Info

Refer to [example](https://github.com/kitex-contrib/config-nacos/tree/main/example) for more usage.
Expand Down
20 changes: 20 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,26 @@ echo 方法使用下面的配置(0.3、100),其他方法使用全局默认
}
```

##### 降级: Category=degradation

[JSON Schema](https://github.com/cloudwego/kitex/blob/develop/pkg/#L30)

| 参数 | 说明 |
|------------|--------|
| enable | 是否开启降级 |
| percentage | 请求丢弃比例 |
例子:

客户端所有请求使用以下限流配置 (true, 50)
> configDataId: `ClientName.ServiecName.degradation`

```json
{
"enable": true,
"percentage": 50
}
```

### 更多信息

更多示例请参考 [example](https://github.com/kitex-contrib/config-nacos/tree/main/example)
Expand Down

0 comments on commit 3575eb9

Please sign in to comment.