midnight2104 commented on a change in pull request #428: URL: https://github.com/apache/incubator-shenyu-website/pull/428#discussion_r779311783
########## File path: i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/tracing.md ########## @@ -72,4 +78,68 @@ plugins: opentelemetry 插件使用的sdk基于 `opentelemetry-sdk-extension-autoconfigure` 初始化，更多使用请参考 [OpenTelemetry SDK自动配置说明](https://github.com/open-telemetry/opentelemetry-java/tree/v1.9.1/sdk-extensions/autoconfigure#opentelemetry-sdk-autoconfigure) -##### Zipkin +##### zipkin + +| 名称 | 类型 | 默认值 | 说明 | +| :------------------- | :----: | :----------- | :----------------------- | +| SERVICE_NAME | String | shenyu-agent | 在traces系统中显示的名称 | +| URL_VERSION | String | /api/v2/spans | Zipkin的版本 | +| SAMPLER_TYPE | String | const | Zipkin 采样率类型 | +| SAMPLER_PARAM | String | 1 | Zipkin 采样率参数 | + + +## 使用 zipkin 插件 + +- 修改配置文件 + +在 `shenyu-agent.yaml` 文件中通过`supports.tracing`指定使用 `zipkin` 插件，通过 `plugins.tracing` 填写 `zipkin` 的配置信息。 + +```yaml +appName: shenyu-agent +supports: + tracing: + - zipkin + +plugins: + tracing: + zipkin: + host: "localhost" + port: 9411 + props: + SERVICE_NAME: "shenyu-agent" + URL_VERSION: "/api/v2/spans" + SAMPLER_TYPE: "const" + SAMPLER_PARAM: "1" +``` + +关于拦截点的配置，默认已经对网关的全部插件加上了链路追踪的拦截点，如果不想记录某个插件的链路信息，可以在 `tracing-point.yaml` 文件中去掉目标类。 + +- 重新打包 + +配置信息修改完成后，需要重新打包 `shenyu-agent-dist` 模块： + +```shell +> cd shenyu-agent-dist +> mvn clean install +``` + +- 启动 zipkin-server + +请参考 [zipkin-quickstart](https://zipkin.io/pages/quickstart) 启动 `zipkin-server` 。 + +- 启动网关 Review comment: done ########## File path: i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/tracing.md ########## @@ -72,4 +78,68 @@ plugins: opentelemetry 插件使用的sdk基于 `opentelemetry-sdk-extension-autoconfigure` 初始化，更多使用请参考 [OpenTelemetry SDK自动配置说明](https://github.com/open-telemetry/opentelemetry-java/tree/v1.9.1/sdk-extensions/autoconfigure#opentelemetry-sdk-autoconfigure) -##### Zipkin +##### zipkin + +| 名称 | 类型 | 默认值 | 说明 | +| :------------------- | :----: | :----------- | :----------------------- | +| SERVICE_NAME | String | shenyu-agent | 在traces系统中显示的名称 | +| URL_VERSION | String | /api/v2/spans | Zipkin的版本 | +| SAMPLER_TYPE | String | const | Zipkin 采样率类型 | +| SAMPLER_PARAM | String | 1 | Zipkin 采样率参数 | + + +## 使用 zipkin 插件 + +- 修改配置文件 + +在 `shenyu-agent.yaml` 文件中通过`supports.tracing`指定使用 `zipkin` 插件，通过 `plugins.tracing` 填写 `zipkin` 的配置信息。 + +```yaml +appName: shenyu-agent +supports: + tracing: + - zipkin + +plugins: + tracing: + zipkin: + host: "localhost" + port: 9411 + props: + SERVICE_NAME: "shenyu-agent" + URL_VERSION: "/api/v2/spans" + SAMPLER_TYPE: "const" + SAMPLER_PARAM: "1" +``` + +关于拦截点的配置，默认已经对网关的全部插件加上了链路追踪的拦截点，如果不想记录某个插件的链路信息，可以在 `tracing-point.yaml` 文件中去掉目标类。 + +- 重新打包 Review comment: done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
