This is an automated email from the ASF dual-hosted git repository.
albumenj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dubbo-website.git
The following commit(s) were added to refs/heads/master by this push:
new 392de30ba3 [fix] 优化 QOS 命令手册 (#1209)
392de30ba3 is described below
commit 392de30ba38d0a04227d222eeede4889965f1a86
Author: JIAN ZHONG <[email protected]>
AuthorDate: Mon Jul 11 09:41:45 2022 +0800
[fix] 优化 QOS 命令手册 (#1209)
---
.../java-sdk/reference-manual/qos/command.md | 128 +++++++++------------
1 file changed, 52 insertions(+), 76 deletions(-)
diff --git a/content/zh/docs3-building/java-sdk/reference-manual/qos/command.md
b/content/zh/docs3-building/java-sdk/reference-manual/qos/command.md
index 40eaa6cc6c..488bdbe09e 100644
--- a/content/zh/docs3-building/java-sdk/reference-manual/qos/command.md
+++ b/content/zh/docs3-building/java-sdk/reference-manual/qos/command.md
@@ -5,45 +5,68 @@ linkTitle: "QOS 命令手册"
weight: 2
description: "新版本 telnet 命令使用说明"
---
-
+## 特性说明
dubbo `2.5.8` 新版本增加了 QOS 模块，提供了新的 telnet 命令支持。
-## 端口
-新版本的 telnet 端口 与 dubbo 协议的端口是不同的端口，默认为 `22222`，可通过配置文件`dubbo.properties` 修改:
+#### 相关参数说明
+QoS 提供了一些启动参数，来对启动进行配置，他们主要包括：
+
+| 参数 | 说明 | 默认值 |
+| ------------------ | ----------------- | ------ |
+| qos-enable | 是否启动QoS | true |
+| qos-port | 启动QoS绑定的端口 | 22222 |
+| qos-accept-foreign-ip | 是否允许远程访问 | false |
+
+>
注意，从2.6.4/2.7.0开始，qos-accept-foreign-ip默认配置改为false，如果qos-accept-foreign-ip设置为true，有可能带来安全风险，请仔细评估后再打开。
+
+#### QoS 参数配置
+
+* 系统属性
+* dubbo.properties
+* XML方式
+* Spring-boot 自动装配方式
+
+其中，上述方式的优先顺序为系统属性 > dubbo.properties > XML/Spring-boot 自动装配方式。
+
+## 使用场景
+- 当线上的 QPS 比较高的时候，当刚重启机器的时候，由于没有进行 JIT
预热或相关资源没有预热，可能会导致大量超时，这个时候，可通过分批发布服务，逐渐加大流量。
+- 当由于某台机器由于某种原因，需要下线服务，然后又需要重新上线服务。
+
+## 使用说明
+#### 端口
+新版本的 telnet 端口 与 dubbo 协议的端口是不同的端口，默认为 `22222`
+
+可以通过配置文件`dubbo.properties` 修改:
```
dubbo.application.qos-port=33333
```
-
-或者通过设置 JVM 参数:
-
+或者
+可以通过设置 JVM 参数:
```
-Ddubbo.application.qos-port=33333
```
-## 安全
-
-默认情况下，dubbo 接收任何主机发起的命令，可通过配置文件`dubbo.properties` 修改:
+#### 安全
+默认情况下，dubbo 接收任何主机发起的命令
+可以通过配置文件`dubbo.properties` 修改:
```
dubbo.application.qos-accept-foreign-ip=false
```
+或者
-或者通过设置 JVM 参数:
-
+可以通过设置 JVM 参数:
```
-Ddubbo.application.qos-accept-foreign-ip=false
```
+拒绝远端主机发出的命令，只允许服务本机执行。
-拒绝远端主机发出的命令，只允许服务本机执行
-
-## telnet 与 http 协议
+#### telnet 与 http 协议
telnet 模块现在同时支持 http 协议和 telnet 协议，方便各种情况的使用
-
-示例如下：
-
+示例：
```
➜ ~ telnet localhost 22222
Trying ::1...
@@ -91,9 +114,9 @@ As Consumer side:
+---------------------+---+
```
-## 支持的命令
+#### 支持的命令
-### ls 列出消费者和提供者
+#### ls 列出消费者和提供者
```
dubbo>ls
@@ -108,13 +131,10 @@ As Consumer side:
|Consumer Service Name|NUM|
+---------------------+---+
```
-
列出 dubbo 的所提供的服务和消费的服务，以及消费的服务地址数
-### Online 上线服务命令
-
+#### Online 上线服务命令
当使用延迟发布功能的时候(通过设置 org.apache.dubbo.config.AbstractServiceConfig#register 为
false)，后续需要上线的时候，可通过 Online 命令
-
```
//上线所有服务
dubbo>online
@@ -124,19 +144,8 @@ OK
dubbo>online com.*
OK
```
-
-常见使用场景：
-
- - 当线上的 QPS 比较高的时候，当刚重启机器的时候，由于没有进行JIT
预热或相关资源没有预热，可能会导致大量超时，这个时候，可通过分批发布服务，逐渐加大流量
- - 当由于某台机器由于某种原因，需要下线服务，然后又需要重新上线服务
-
-
-
-### Offline 下线服务命令
-
+#### Offline 下线服务命令
由于故障等原因，需要临时下线服务保持现场，可以使用 Offline 下线命令。
-
-
```
//下线所有服务
dubbo>offline
@@ -147,10 +156,7 @@ dubbo>offline com.*
OK
```
-### help 命令
-
-
-
+#### help 命令
```
//列出所有命令
dubbo>help
@@ -166,49 +172,23 @@ dubbo>help online
dubbo>
```
-
-## 相关参数说明
-
-QoS提供了一些启动参数，来对启动进行配置，他们主要包括：
-
-| 参数 | 说明 | 默认值 |
-| ------------------ | ----------------- | ------ |
-| qos-enable | 是否启动QoS | true |
-| qos-port | 启动QoS绑定的端口 | 22222 |
-| qos-accept-foreign-ip | 是否允许远程访问 | false |
-
->
注意，从2.6.4/2.7.0开始，qos-accept-foreign-ip默认配置改为false，如果qos-accept-foreign-ip设置为true，有可能带来安全风险，请仔细评估后再打开。
-
-QoS参数可以通过如下方式进行配置
-
-* 系统属性
-* dubbo.properties
-* XML方式
-* Spring-boot自动装配方式
-
-其中，上述方式的优先顺序为系统属性 > dubbo.properties > XML/Spring-boot自动装配方式。
-
-### 使用系统属性方式进行配置
-
+#### 使用系统属性方式配置
```
-Ddubbo.application.qos-enable=true
-Ddubbo.application.qos-port=33333
-Ddubbo.application.qos-accept-foreign-ip=false
```
-### 使用dubbo.properties文件进行配置
-
-在项目的`src/main/resources`目录下添加dubbo.properties文件，内容如下:
+#### 使用 dubbo.properties 文件配置
+在项目的`src/main/resources`目录下添加 dubbo.properties文件，内容如下:
```
dubbo.application.qos-enable=true
dubbo.application.qos-port=33333
dubbo.application.qos-accept-foreign-ip=false
```
-### 使用XML方法进行配置
-
-如果要通过XML配置响应的QoS相关的参数，可以进行如下配置：
-
+#### 使用XML方法配置
+如果要通过 XML 配置响应的QoS相关的参数，可以进行如下配置：
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans";
@@ -229,15 +209,11 @@ dubbo.application.qos-accept-foreign-ip=false
</beans>
```
-### 使用spring-boot自动装配方式配置
-
-如果是spring-boot的应用，可以在`application.properties`或者`application.yml`上配置:
+#### 使用 spring-boot 自动装配方式配置
+如果是 spring-boot 的应用，可以在`application.properties`或者`application.yml`上配置:
```
dubbo.application.qos-enable=true
dubbo.application.qos-port=33333
dubbo.application.qos-accept-foreign-ip=false
```
-
-
-
