This is an automated email from the ASF dual-hosted git repository.
luzhijing pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 5031ffcb51 [docs](tracing) Update tracing docs of version 1.2 (#700)
5031ffcb51 is described below
commit 5031ffcb5172f642e9b0840c1ba83d8d6c90bd90
Author: KassieZ <[email protected]>
AuthorDate: Thu Jun 6 09:18:13 2024 +0700
[docs](tracing) Update tracing docs of version 1.2 (#700)
---
.../version-1.2/admin-manual/tracing.md | 46 ++++++++++++----------
versioned_docs/version-1.2/admin-manual/tracing.md | 7 +++-
2 files changed, 31 insertions(+), 22 deletions(-)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/admin-manual/tracing.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/admin-manual/tracing.md
index aab76ff462..abf32e97a2 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/admin-manual/tracing.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/admin-manual/tracing.md
@@ -24,16 +24,20 @@ specific language governing permissions and limitations
under the License.
-->
-# 链路追踪
+
链路追踪（tracing）记录了一次请求在系统中的执行的生命周期，包括请求及其子过程调用链路、执行时间及统计信息，可用于慢查询定位、性能瓶颈分析等。
+:::caution 注意
+该功能只维护于 Doris 1.2 版本，自 Doris 2.0 版本起已不再支持。
+:::
+
## 原理
-doris负责收集traces，并导出到第三方链路分析系统，由链路分析系统负责traces的展示和存储。
+Doris 负责收集 traces，并导出到第三方链路分析系统，由链路分析系统负责 traces 的展示和存储。
## 快速搭建
-doris目前支持直接将traces导出到 [zipkin](https://zipkin.io/) 中。
+Doris 目前支持直接将 traces 导出到 [zipkin](https://zipkin.io/) 中。
### 部署 zipkin
@@ -42,9 +46,9 @@ curl -sSL https://zipkin.io/quickstart.sh | bash -s
java -jar zipkin.jar
```
-### 配置及启动Doris
+### 配置及启动 Doris
-#### 添加配置到fe.conf
+#### 添加配置到 fe.conf
```
# 开启链路追踪
@@ -54,7 +58,7 @@ enable_tracing = true
trace_export_url = http://127.0.0.1:9411/api/v2/spans
```
-#### 添加配置到be.conf
+#### 添加配置到 be.conf
```
# 开启链路追踪。
enable_tracing = true
@@ -72,7 +76,7 @@ max_span_export_batch_size=512
export_span_schedule_delay_millis=500
```
-#### 启动fe和be
+#### 启动 fe 和 be
```
sh fe/bin/start_fe.sh --daemon
sh be/bin/start_be.sh --daemon
@@ -83,25 +87,25 @@ sh be/bin/start_be.sh --daemon
...
```
-### 查看zipkin UI
+### 查看 zipkin UI
浏览器打开`http://127.0.0.1:9411/zipkin/` 可查看查询链路。
-## 使用opentelemetry collector
+## 使用 opentelemetry collector
-使用opentelemetry collector
可将traces导出到其他系统例如zipkin、jaeger、skywalking，或者数据库系统和文件中。 详情参考 [collector
exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter)
。
+使用 opentelemetry collector 可将 traces 导出到其他系统例如
zipkin、jaeger、skywalking，或者数据库系统和文件中。详情参考 [collector
exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter)
。
-同时 opentelemetry collector 提供了丰富的算子用来处理traces。例如[过滤
spans](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor)
、[尾采样](hhttps://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/tailsamplingprocessor)。详情参考[collector
processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor)。
+同时 opentelemetry collector 提供了丰富的算子用来处理 traces。例如[过滤
spans](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor)
、[尾采样](hhttps://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/tailsamplingprocessor)。详情参考[collector
processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor)。
-traces导出的路径：doris -> collector -> zipkin等。
+traces 导出的路径：doris -> collector -> zipkin 等。
### 部署 opentelemetry collector
-opentelemetry 发布了collector
[core](https://github.com/open-telemetry/opentelemetry-collector) 和
[contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib),
contrib提供了更丰富的功能，这里以contrib版举例。
+opentelemetry 发布了 collector
[core](https://github.com/open-telemetry/opentelemetry-collector) 和
[contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib),
contrib 提供了更丰富的功能，这里以 contrib 版举例。
#### 下载 collector
-下载 otelcol-contrib，
可在官网下载[更多平台预编译版](https://github.com/open-telemetry/opentelemetry-collector-releases/releases)
+下载
otelcol-contrib，可在官网下载[更多平台预编译版](https://github.com/open-telemetry/opentelemetry-collector-releases/releases)
```
wget
https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v0.55.0/otelcol-contrib_0.55.0_linux_amd64.tar.gz
@@ -111,9 +115,9 @@ tar -zxvf otelcol-contrib_0.55.0_linux_amd64.tar.gz
#### 生成配置文件
-collector
配置文件分为5部分：`receivers`、`processors`、`exporters`、`extensions`、`service`。其中receivers、processors、exporters分别定义了接收、处理、导出数据的方式；extensions是可选的，用于扩展主要用于不涉及处理遥测数据的任务；service指定在collector中使用哪些组件。可参考
[collector configuration](https://opentelemetry.io/docs/collector/deployment/)。
+collector 配置文件分为 5
部分：`receivers`、`processors`、`exporters`、`extensions`、`service`。其中
receivers、processors、exporters 分别定义了接收、处理、导出数据的方式；extensions
是可选的，用于扩展主要用于不涉及处理遥测数据的任务；service 指定在 collector 中使用哪些组件。可参考 [collector
configuration](https://opentelemetry.io/docs/collector/deployment/)。
-下面配置文件使用otlp(OpenTelemetry Protocol)协议接收traces数据，进行批处理并过滤掉时间超过50ms的traces,
最终导出到zipkin和文件中。
+下面配置文件使用 otlp(OpenTelemetry Protocol) 协议接收 traces 数据，进行批处理并过滤掉时间超过 50ms 的
traces, 最终导出到 zipkin 和文件中。
```
cat > otel-collector-config.yaml << EOF
receivers:
@@ -154,9 +158,9 @@ EOF
nohup ./otelcol-contrib --config=otel-collector-config.yaml &
```
-### 配置及启动Doris
+### 配置及启动 Doris
-#### 添加配置到fe.conf
+#### 添加配置到 fe.conf
```
# 开启链路追踪
@@ -169,7 +173,7 @@ trace_exporter = collector
trace_export_url = http://127.0.0.1:4318/v1/traces
```
-#### 添加配置到be.conf
+#### 添加配置到 be.conf
```
# 开启链路追踪。
enable_tracing = true
@@ -190,7 +194,7 @@ max_span_export_batch_size=512
export_span_schedule_delay_millis=500
```
-#### 启动fe和be
+#### 启动 fe 和 be
```
sh fe/bin/start_fe.sh --daemon
sh be/bin/start_be.sh --daemon
@@ -200,7 +204,7 @@ sh be/bin/start_be.sh --daemon
```
...
```
-### 查看traces
+### 查看 traces
```
...
```
diff --git a/versioned_docs/version-1.2/admin-manual/tracing.md
b/versioned_docs/version-1.2/admin-manual/tracing.md
index 17802252b8..589827e49f 100644
--- a/versioned_docs/version-1.2/admin-manual/tracing.md
+++ b/versioned_docs/version-1.2/admin-manual/tracing.md
@@ -24,10 +24,15 @@ specific language governing permissions and limitations
under the License.
-->
-# tracing
+
Tracing records the life cycle of a request execution in the system, including
the request and its sub-procedure call links, execution time and statistics,
which can be used for slow query location, performance bottleneck analysis, etc.
+:::caution
+Please note that Tracing is only supported in Doris 1.2 and is no longer
avialable since Doris 2.0.
+:::
+
+
## Principle
doris is responsible for collecting traces and exporting them to a third-party
tracing analysis system, which is responsible for the presentation and storage
of traces.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
