Skip to content

Commit

Permalink
docs: trace introduction.
Browse files Browse the repository at this point in the history
  • Loading branch information
YuyueBalabala committed Oct 15, 2024
1 parent ea0e48f commit c05a2c2
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 0 deletions.
8 changes: 8 additions & 0 deletions ecp/directory.json
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@
"title": "告警规则列表",
"path": "monitor/rules"
},
{
"title": "链路追踪",
"path": "monitor/trace"
},
{
"title": "操作审计",
"path": "system_admin/operation_audit"
Expand Down Expand Up @@ -348,6 +352,10 @@
"title": "Alarm List",
"path": "monitor/rules"
},
{
"title": "Traces",
"path": "monitor/trace"
},
{
"title": "Audit",
"path": "system_admin/operation_audit"
Expand Down
Binary file added ecp/en_US/monitor/_assets/trace-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ecp/en_US/monitor/_assets/trace-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ecp/en_US/monitor/_assets/trace-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions ecp/en_US/monitor/trace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Trace

[OpenTelemetry Tracing](https://opentelemetry.io/docs/concepts/signals/traces/) is a specification for tracing the flow of requests in distributed systems, used to track the flow of requests within distributed systems. ECP integrates OpenTelemetry tracing and provides the capability for visual analysis of the performance and behavior of requests.

## Trace Setting

Log in to ECP as an administrator , you can view the traceability configuration under **Administration** -> **System Setting** -> **General Setting**, which is the address of the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started).

![image-20241015173721355](_assets/trace-config.png)

## Traceability Records

After the trace data is uploaded to ECP, on the **Workspace** interface, click the **Maintenance** -> Trace** menu on the left to enter the traceability list.

![image-20241015173421041](_assets/trace-list.png)

You can also quickly locate a specific trace record from aspects such as **service name, span name, attribute keyword, time** using ECP's filtering and sorting functions.

Click on **Trace ID** to view the trace details and observe the trace situation.

![image-20241015173511959](_assets/trace-detail.png)
Binary file added ecp/zh_CN/monitor/_assets/trace-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ecp/zh_CN/monitor/_assets/trace-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ecp/zh_CN/monitor/_assets/trace-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions ecp/zh_CN/monitor/trace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 链路追踪

[OpenTelemetry 追踪](https://opentelemetry.io/docs/concepts/signals/traces/)是一个用于追踪请求在分布式系统中的流动的规范,用于追踪请求在分布式系统中的流动情况。 ECP 集成OpenTelemetry 追踪,并提供了可视化分析请求的性能和行为的能力。

## 链路追踪配置

以管理员或普通用户身份登录 ECP,您可在**系统管理**->**系统配置**-> **通用配置**查看链路追踪配置,即 [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started)的地址。

![image-20241015174431606](_assets/trace-config.png)

## 链路追踪记录

当链路数据上传到ECP后,在**工作台**界面,点击左侧 **监控运维->链路追踪**菜单即可进入链路追踪列表

![image-20241015151726616](_assets/trace-list.png)

您同样可以通过 ECP 的过滤和筛选功能,从**服务名称、span名称、attribute关键字,时间**等方面快速定位某条追踪记录。

点击 **Trace ID**,可以查看链路详情,观察链路情况。

![image-20241015172418965](_assets/trace-detail.png)

0 comments on commit c05a2c2

Please sign in to comment.