Merge pull request #89 from hengyoush/docs/vitepress

docs: add english docs
hengyoush · Oct 27, 2024 · d1be6b4 · d1be6b4
2 parents 2a696f5 + 40cad93
commit d1be6b4
Show file tree

Hide file tree

Showing 17 changed files with 663 additions and 252 deletions.
diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -156,6 +156,23 @@ jobs:
             sudo apt install -y python3 python3-pip pipx
 
       
+
+      - name: Test side
+        uses: cilium/little-vm-helper@97c89f004bd0ab4caeacfe92ebc956e13e362e6b # v0.0.19
+        with:
+          provision: 'false'
+          cmd: |
+            set -ex
+            uname -a
+            cat /etc/issue
+            pushd /host
+            if [ -f "/var/lib/kyanos/btf/current.btf" ]; then  
+                bash /host/testdata/test_side.sh '/host/kyanos/kyanos $kyanos_log_option --btf /var/lib/kyanos/btf/current.btf'
+            else  
+                bash /host/testdata/test_side.sh '/host/kyanos/kyanos $kyanos_log_option'
+            fi
+            popd
+
       - name: Test mysql
         uses: cilium/little-vm-helper@97c89f004bd0ab4caeacfe92ebc956e13e362e6b # v0.0.19
         with:

diff --git a/docs/api-examples.md b/docs/api-examples.md
diff --git a/docs/cn/how-to.md b/docs/cn/how-to.md
@@ -12,7 +12,7 @@ kyanos 共有三个子命令：watch、stat、overview。每个命令的作用
 2. stat：根据你指定的条件抓取请求响应记录并且聚合这些记录，得到更高维度的统计信息。
 3. overview：一键展示当前机器依赖的外部资源。
 
-## watch 流量采集简单用法
+## `watch` 流量采集简单用法
 
 最简单的用法如下，抓取所有 kyanos 当前能够识别的协议
 
@@ -45,7 +45,7 @@ kyanos 共有三个子命令：watch、stat、overview。每个命令的作用
 ```
 每种协议都具有不同的过滤条件，而且watch还可以根据很多其他条件过滤，详情参考：[如何抓取请求响应和耗时细节](./watch)
 
-## stat 聚合分析简单用法
+## `stat` 聚合分析简单用法
 
 在真实场景中，watch 输出的结果过于细粒度，因此 kyanos 提供了 stat 命令用于 **统计分析**。
 

diff --git a/docs/cn/index.md b/docs/cn/index.md
@@ -8,7 +8,7 @@ hero:
   tagline: 秒级分析定位网络问题
   image:
     src: /kyanos.png
-    alt: SnowAdmin
+    alt: Kyanos
   actions:
     - theme: brand
       text: What is Kyanos?
@@ -23,14 +23,19 @@ hero:
 features:
       - icon: 🚀
         title: 快速分析
-        details: 用户只需一条命令即可快速查看机器的网络性能，包括MySQL、Redis等常用服务的网络延迟和数据传输大小
+        details: 只需一条命令即可快速查看机器的网络性能，包括MySQL、Redis等常用服务的网络延迟和数据传输大小
         link: ./how-to
         linkText: Learn how to use kyanos
       - icon: 🎯️
         title: 高级数据过滤
         details: 支持根据协议字段（如HTTP的Path或Redis的Command）过滤数据，以及根据进程PID、容器ID、K8s Pod名称等多维度筛选数据，提供更精确的问题定位。
         link: ./watch#how-to-filter
         linkText: Learn how to filter traffic
+      - icon: 📈️
+        title: 强大的聚合分析
+        details: 支持根据远程IP、协议等维度自动聚合数据，快速获取特定信息，如特定IP的HTTP路径耗时情况。
+        link: ./stat
+        linkText: Learn how to analysis traffic
       - icon: 💻️
         title: 容器网络监控
         details: 在容器化环境中，能够统计数据包从容器网卡到宿主机网卡的耗时。
@@ -41,11 +46,6 @@ features:
         details: 基于命令行就地分析，提供可视化的输出，无需复杂的文件下载和分析步骤。
         link: ./how-to
         linkText: Learn how to use kyanos
-      - icon: 📈️
-        title: 强大的聚合分析
-        details: 支持根据远程IP、协议等维度自动聚合数据，快速获取特定信息，如特定IP的HTTP路径耗时情况。
-        link: ./stat
-        linkText: Learn how to analysis traffic
       - icon: 🌐️
         title: 轻量级与兼容性
         details: Kyanos作为一个网络问题排查工具，不依赖于任何外部依赖，能够在从3.10版本到最新版本的内核上运行

diff --git a/docs/cn/quickstart.md b/docs/cn/quickstart.md
@@ -25,7 +25,7 @@ kyanos watch
 ```
 
  如果显示了下面的表格：
-![kyanos quick start success](quickstart-success.png)
+![kyanos quick start success](/quickstart-success.png)
 🎉 恭喜你，kyanos启动成功了。
 
 > [!TIP]

diff --git a/docs/cn/stat.md b/docs/cn/stat.md
@@ -49,6 +49,34 @@ m 是 metric的缩写，t 是 total-time 的缩写，g 是 group-by 的缩写。
 按下 `enter` 即可进入这个 `remote-ip` 下具体的请求响应，这里其实就是 watch 命令的结果，操作方式和 watch 完全相同，你可以选择具体的请求响应，然后查看其耗时和请求响应内容，这里不再赘述。
 
 
+
+## 目前支持的指标
+kyanos目前支持通过 `--metric` 指定的指标如下：
+
+| 观测指标            | short flag |long flag |
+| :-------------- | :--- |:--- |
+| 总耗时             | t    |total-time    |
+| 响应数据大小          | p    | respsize    |
+| 请求数据大小          | q    | reqsize    |
+| 在网络中的耗时         | n    | network-time    |
+| 在服务进程中的耗时         | i    | internal-time    |
+| 从Socket缓冲区读取的耗时 | s    |socket-time    |
+
+## 目前支持的聚合方式
+kyanos目前支持通过 `--group-by` 指定的指标如下：
+
+| 聚合维度          | 值 |
+| :-------------- | :--- |
+| 聚合到单个连接             |  conn   |
+| 远程ip          | remote-ip    |
+| 远程端口          | remote-port    |
+| 本地端口         | local-port    |
+| L7协议 | protocol    |
+| HTTP PATH | http-path    |
+| Redis命令 | redis-command    |
+| 聚合所有的请求响应 | none    |
+
+
 ## 这些选项记不住怎么办？
 如果你记不得这些选项，stat 同样提供了三个选项用于快速分析：
 
@@ -87,31 +115,3 @@ m 是 metric的缩写，t 是 total-time 的缩写，g 是 group-by 的缩写。
 ```bash
 ./kyanos stat http --bigresp
 ```
-
-
-## 目前支持的指标
-kyanos目前支持通过 `--metric` 指定的指标如下：
-
-| 观测指标            | short flag |long flag |
-| :-------------- | :--- |:--- |
-| 总耗时             | t    |total-time    |
-| 响应数据大小          | p    | respsize    |
-| 请求数据大小          | q    | reqsize    |
-| 在网络中的耗时         | n    | network-time    |
-| 在服务进程中的耗时         | i    | internal-time    |
-| 从Socket缓冲区读取的耗时 | s    |socket-time    |
-
-## 目前支持的聚合方式
-kyanos目前支持通过 `--group-by` 指定的指标如下：
-
-| 聚合维度          | 值 |
-| :-------------- | :--- |
-| 聚合到单个连接             |  conn   |
-| 远程ip          | remote-ip    |
-| 远程端口          | remote-port    |
-| 本地端口         | local-port    |
-| L7协议 | protocol    |
-| HTTP PATH | http-path    |
-| Redis命令 | redis-command    |
-| 聚合所有的请求响应 | none    |
-
diff --git a/docs/cn/what-is-kyanos.md b/docs/cn/what-is-kyanos.md
@@ -13,7 +13,7 @@ Kyanos 是一个基于eBPF的网络问题分析工具，你可以用它来抓取
 
 ### 传统的tcpdump抓包排查的缺点  
 
-1. 难以根据协议特定信息过滤，以 HTTP 协议为例，很难做到根据特定 HTTP Path 抓包。
+1. 难以根据协议特定信息过滤，以 HTTP 协议为例，很难做到根据特定 HTTP Path 抓包，必须依赖 wireshark/tshark 这类工具进行二次过滤。
 2. 难以根据数据包收发的进程/容器等过滤，尤其在一个机器上部署多个进程/容器的时候，只需要抓取某个业务进程的数据包。
 3. 排查效率较低，一般排查流程：首先是进入生产环境使用 tcpdump 抓包生成 pcap 文件，然后需要下载到本地再通过 wireshark 工具分析，往往消耗了大量时间。
 4. 较弱的分析能力，tcpdump 只提供底层的抓包能力，几乎不具备高阶的分析能力，必须要和 wireshark 搭配使用，而传统的网络监控工具比如 iftop 和 nestat 只能提供粗粒度的监控，想要排查根因很难。