This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new dbb6d83 add: add the jaeger-plugin doc. (#430)
dbb6d83 is described below
commit dbb6d830cc8b974a5ca833f8ca021596792ed6cb
Author: YuI <[email protected]>
AuthorDate: Fri Jan 7 10:55:43 2022 +0800
add: add the jaeger-plugin doc. (#430)
* modify: the download version card.
* fix: downloadCard, the url is wrong
* add: add the jaeger-plugin doc.
Co-authored-by: 艺铭 <[email protected]>
---
docs/user-guide/observability/tracing.md | 40 ++++++++++++++++++++
.../current/user-guide/observability/tracing.md | 41 +++++++++++++++++++++
.../agent/shenyu-agent-plugin-tracing-jaeger-1.jpg | Bin 0 -> 250826 bytes
.../agent/shenyu-agent-plugin-tracing-jaeger-2.jpg | Bin 0 -> 286629 bytes
4 files changed, 81 insertions(+)
diff --git a/docs/user-guide/observability/tracing.md
b/docs/user-guide/observability/tracing.md
index 4f43c99..7e82486 100644
--- a/docs/user-guide/observability/tracing.md
+++ b/docs/user-guide/observability/tracing.md
@@ -85,6 +85,46 @@ The SDK used by the opentelemetry plugin is initialized
based on `opentelemetry-
| SAMPLER_PARAM | String | 1 | zipkin sampler param |
+## Agent Plugin Tracing Jaeger
+
+- modify yaml file
+
+Specify the use of the `jaeger` plugin via `supports.tracing` in the
`shenyu-agent.yaml` file, and fill in the `jaeger` configuration information
via `plugins.tracing`.
+
+```yaml
+appName: shenyu-agent
+supports:
+ tracing:
+ - jaeger
+
+plugins:
+ tracing:
+ jaeger:
+ host: "localhost"
+ port: 5775
+ props:
+ SERVICE_NAME: "shenyu-agent"
+ JAEGER_SAMPLER_TYPE: "const"
+ JAEGER_SAMPLER_PARAM: "1"
+```
+
+- start jaeger server
+
+please see
[jaeger-quickstart](https://www.jaegertracing.io/docs/1.28/getting-started/) to
start `jaeger`
+
+- tracing test
+ - Reference [Deployment](../../deployment/deployment-local.md) to start
`shenyu-admin`.
+ - Start the gateway by referring to the above procedure.
+ - Refer to [Quick start with Http](../../quick-start/quick-start-http.md) to
start `shenyu-examples-http`.
+ - Launch a request to the gateway.
+ > GET http://localhost:9195/http/order/findById?id=1
+ >
+ > Accept: application/json
+
+ - After a successful request, you can see that the link log has been
reported to jaeger:
+ 
+ 
+
## Agent Plugin Tracing Zipkin
- modify yaml file
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/tracing.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/tracing.md
index 024b91d..394279a 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/tracing.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/tracing.md
@@ -88,6 +88,47 @@ opentelemetry 插件使用的sdk基于
`opentelemetry-sdk-extension-autoconfigur
| SAMPLER_PARAM | String | 1 | Zipkin 采样率参数 |
+## 使用 jaeger 插件
+
+- 修改配置文件
+
+在 `shenyu-agent.yaml` 文件中通过`supports.tracing`指定使用 `jaeger` 插件，通过
`plugins.tracing` 填写 `jaeger` 的配置信息。
+
+```yaml
+appName: shenyu-agent
+supports:
+ tracing:
+ - jaeger
+
+plugins:
+ tracing:
+ jaeger:
+ host: "localhost"
+ port: 5775
+ props:
+ SERVICE_NAME: "shenyu-agent"
+ JAEGER_SAMPLER_TYPE: "const"
+ JAEGER_SAMPLER_PARAM: "1"
+```
+
+- 启动 jaeger 服务
+
+请参考
[jaeger-quickstart](https://www.jaegertracing.io/docs/1.28/getting-started/) 启动
`jaeger`
+
+- 测试
+ - 参考 [运维部署](../../deployment/deployment-local.md) 的相关文章，启动 `shenyu-admin`；
+ - 参考上述操作步骤，启动网关；
+ - 参考 [Http快速开始](../../quick-start/quick-start-http.md) ，启动
`shenyu-examples-http`。
+ - 向网关发起请求：
+ > GET http://localhost:9195/http/order/findById?id=1
+ >
+ > Accept: application/json
+
+- 请求成功后，可以看到链路日志已经上报到 jaeger 中：
+ 
+ 
+
+
## 使用 zipkin 插件
- 修改配置文件
diff --git a/static/img/shenyu/agent/shenyu-agent-plugin-tracing-jaeger-1.jpg
b/static/img/shenyu/agent/shenyu-agent-plugin-tracing-jaeger-1.jpg
new file mode 100644
index 0000000..82901e9
Binary files /dev/null and
b/static/img/shenyu/agent/shenyu-agent-plugin-tracing-jaeger-1.jpg differ
diff --git a/static/img/shenyu/agent/shenyu-agent-plugin-tracing-jaeger-2.jpg
b/static/img/shenyu/agent/shenyu-agent-plugin-tracing-jaeger-2.jpg
new file mode 100644
index 0000000..8e98134
Binary files /dev/null and
b/static/img/shenyu/agent/shenyu-agent-plugin-tracing-jaeger-2.jpg differ
