Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ISSUE #2790] Add Jaeger tracing plugin docs #2869

Merged
merged 3 commits into from
Jan 9, 2023
Merged

[ISSUE #2790] Add Jaeger tracing plugin docs #2869

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29fd240
[ISSUE #2790] Add Jaeger tracing plugin en docs
seriouszyx Jan 9, 2023
c58bf83
[ISSUE #2790] Add Jaeger tracing plugin zh docs
seriouszyx Jan 9, 2023
8db6711
Add Apache header
seriouszyx Jan 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[ISSUE #2790] Add Jaeger tracing plugin zh docs 
Signed-off-by: Yixiang Zhao <seriouszyx@foxmail.com>
  • Loading branch information
@seriouszyx
seriouszyx committed Jan 9, 2023
commit c58bf83502614ed33279f2727463ce177d29240f
44 changes: 44 additions & 0 deletions docs/zh/desing-document/13-jaeger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# 通过 Jaeger 观察 Trace

## Jaeger

[Jaeger](https://www.jaegertracing.io/) 是 [Uber](https://uber.github.io/) 开发的分布式跟踪系统，现已成为 [CNCF](https://cncf.io/) 开源项目，其灵感来源于 Google 的 [Dapper](https://research.google.com/pubs/pub36356.html) 和 Twitter 的 [Zipkin](https://zipkin.io/)，用于监控基于微服务的分布式系统。

Jaeger 的安装可以参考[官方文档](https://www.jaegertracing.io/docs/latest/getting-started/)，推荐使用官方的 Docker 镜像 `jaegertracing/all-in-one` 来快速搭建环境进行测试。

## 配置

为了启用 EventMesh Runtime 的 trace exporter，请将 `conf/eventmesh.properties` 文件中的 `eventMesh.server.trace.enabled` 字段设置为 true。

```conf
# Trace plugin
eventMesh.server.trace.enabled=true
eventMesh.trace.plugin=jaeger
```

为了定义 trace exporter 的行为，如超时时间或导出间隔，请编辑 `exporter.properties` 文件。

```conf
# Set the maximum batch size to use
eventmesh.trace.max.export.size=512
# Set the queue size. This must be >= the export batch size
eventmesh.trace.max.queue.size=2048
# Set the max amount of time an export can run before getting(TimeUnit=SECONDS)
eventmesh.trace.export.timeout=30
# Set time between two different exports (TimeUnit=SECONDS)
eventmesh.trace.export.interval=5
```

为了将导出的 trace 数据发送到 Jaeger，请编辑 `conf/jaeger.properties` 文件中的 `eventmesh.trace.jaeger.ip` 和 `eventmesh.trace.jaeger.port` 字段，来匹配 Jaeger 服务器的配置。

```conf
# Jaeger's IP and Port
eventmesh.trace.jaeger.ip=localhost
eventmesh.trace.jaeger.port=14250
```

## 从 Zipkin 迁移

Jaeger 采集器服务暴露了与 Zipkin 兼容的 REST API，`/api/v1/spans` 可以接收 Thrift 和 JSON，`/api/v2/spans` 可以接收 JSON 和 Proto。

因此你也可以使用 `eventmesh-trace-zipkin` 插件来通过 Jaeger 观察 trace，具体配置细节请参考 `eventmesh-trace-zipkin` 的文档。默认情况下这个特性在 Jaeger 中是关闭的，可以通过 `--collector.zipkin.host-port=:9411` 启用。