docs: add troubleshooting guide (dragonflyoss#752)

Signed-off-by: Jim Ma <[email protected]>
sungjunyoung · Oct 26, 2021 · 20eed27 · 20eed27
1 parent 2acfecf
commit 20eed27
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 9 deletions.
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -5,27 +5,28 @@ Dragonfly Document is written, drawn, memorialized representation of all things
 Organization of document is as following:
 
 * [Quick Start](quick-start.md)
-* [Design](design/README.md)
-  * [architecture](design/architecture.md)
-  * [manager](design/manager.md)
-  * [TODO scheduler](design/scheduler.md)
-  * [TODO cdn](design/cdn.md)
-  * [TODO dfdaemon](desigin/dfdaemon.md)
 * [Deployment](deployment/README.md)
   * [Installation](deployment/installation)
   * [Configuration](deployment/configuration)
+* [Troubleshooting](troubleshooting/README.md)
 * [CLI Reference](cli-reference/README.md)
   * [dfget](cli-reference/dfget.md)
   * [cdn](cli-reference/cdn.md)
   * [scheduler](cli-reference/scheduler.md)
   * [manager](cli-reference/manager.md)
+* [Preheat](preheat/README.md)
+  * [Console](preheat/console.md)
+  * [Api](preheat/api.md)
 * [Runtime Integration](runtime-integration/README.md)
   * [containerd](runtime-integration/containerd/README.md)
   * [cri-o](runtime-integration/cri-o.md)
   * [docker](runtime-integration/docker.md)
-* [Preheat](preheat/README.md)
-  * [Console](preheat/console.md)
-  * [Api](preheat/api.md)
+* [Design](design/README.md)
+  * [architecture](design/architecture.md)
+  * [manager](design/manager.md)
+  * [TODO scheduler](design/scheduler.md)
+  * [TODO cdn](design/cdn.md)
+  * [TODO dfdaemon](desigin/dfdaemon.md)
 * [Developer Guide](developer-guide/developer-guide.md)
 * [Test Guide](test-guide/test-guide.md)
 * [API Reference](api-reference/api-reference.md)
diff --git a/docs/en/troubleshooting/README.md b/docs/en/troubleshooting/README.md
@@ -0,0 +1,30 @@
+# Troubleshooting Guide
+
+## Download slowly than without Dragonfly
+
+1. Confirm limit rate in [dfget.yaml](https://github.com/dragonflyoss/Dragonfly2/blob/main/docs/en/deployment/configuration/dfget.yaml#L65)
+
+```yaml
+download:
+  # total download limit per second
+  totalRateLimit: 200Mi
+  # per peer task download limit per second
+  perPeerRateLimit: 100Mi # default is 20Mi, this default is in consideration of extreme environments.
+upload:
+  # upload limit per second
+  rateLimit: 100Mi
+```
+
+2. Confirm source connection speed in CDN and dfdaemon
+
+## 500 Internal Server Error
+
+1. Check error logs in /var/log/dragonfly/daemon/core.log
+2. Check source connectivity(dns error or certificate error)
+
+Example:
+```shell
+curl https://example.harbor.local/
+```
+
+When curl says error, please check the details in output.
diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md
@@ -11,6 +11,7 @@ Dragonfly Document 是关于 Dragonfly 的介绍。对于一般对 Dragonfly 感
     * [cdn](cli-reference/cdn.md)
     * [scheduler](cli-reference/scheduler.md)
     * [manager](cli-reference/manager.md)
+* [问题排查](troubleshooting/README.md)
 * [API 参考](#API参考)
 * [生态](#生态)
     * [Kubernetes 集成](ecosystem/Kubernetes-with-Dragonfly.md)

diff --git a/docs/zh-CN/troubleshooting/README.md b/docs/zh-CN/troubleshooting/README.md
@@ -0,0 +1,30 @@
+# 问题排查
+
+## 下载速度比不用蜻蜓的时候慢
+
+1. 确认限速值是否合适 [dfget.yaml](https://github.com/dragonflyoss/Dragonfly2/blob/main/docs/zh-CN/config/dfget.yaml#L61)
+
+```yaml
+download:
+  # 总下载限速
+  totalRateLimit: 200Mi
+  # 单个任务下载限速
+  perPeerRateLimit: 100Mi # 为了兼容极限环境下，默认值为 20Mi，可以按需调整
+upload:
+  # 上传限速
+  rateLimit: 100Mi
+```
+
+2. 确认回源速度是否正常
+
+## 500 Internal Server Error
+
+1. 检查日志 /var/log/dragonfly/daemon/core.log
+2. 检查源站可连接行(DNS 错误 or 证书)
+
+示例:
+```shell
+curl https://example.harbor.local/
+```
+
+如果`curl`有报错，请查看具体错误