微服务平台 TSF 外部组件接入 TSF 调用链

一、操作场景

这篇会介绍如何通过传递 HTTP header 使外部组件可在 TSF 依赖拓扑图和调用链查询中显示。

·当前仅以下 SDK 版本及其之后的 SDK 版本支持：1.29.5-Hoxton、1.29.12-Finchley、1.29.2-Greenwich。

·当前支持在依赖拓扑图中展示特定图标的外部组件包括：API 网关。

二、前提条件

在开始这篇的实践前，你需要先了解 TSF 的以下功能。

·调用链快速入门

·服务依赖拓扑

·调用链查询

三、API 网关（apigw）接入

调用链路为如下几种：

·consumer > apigw > provider，其中 consumer 与 provider 均部署在 TSF 上。TSF 依赖拓扑图将显示三个节点串联的链路，以及展示完整的两跳请求的调用详情。

·外部请求 > apigw > provider，其中 provider 部署在 TSF 上。TSF 依赖拓扑将显示 apigw 和 provider 两个节点的链路，以及 apigw > provider 一跳请求的调用详情。

·consumer > apigw > msgw，其中 consumer 与 msgw 均部署在 TSF 上，msgw 为微服务网关。TSF 依赖拓扑图将显示三个节点串联的链路，以及展示完整的两跳请求的调用详情。

·外部请求 > apigw > msgw，其中 msgw 部署在 TSF 上。TSF 依赖拓扑将显示 apigw 和 msgw 两个节点的链路，以及 apigw > msgw 一跳请求的调用详情。

consumer 侧注入

consumer 侧需要注入 apigw 的组件类型。因为通过 RestTemplate 或 Feign 调用 apigw，TSF sdk 无法得知下游服务的组件类型。若不注入，在 TSF 依赖拓扑图中，链路将会在 apigw 处中断。

consumer 侧还需要注入 apigw 的服务 ID 作为唯一标志。

TsfTracingContext tsfTracingContext = TsfTracingContextHolder.get();tsfTracingContext.setClientTag("remoteComponent", "api");tsfTracingContext.setServerServiceName("service-mygpdlyb"); // 设置为 apigw 的 service id

apigw 注入（注：该步骤由 apigw 实现）

apigw 需要透传 consumer 传递来的 trace 上下文信息。如果为第一跳可忽略。TSF 调用链功能使用基于 zipkin，因此需要透传如下信息。

apigw 接受 consumer 的请求，这一跳的 span 数据需要如下信息。如果为第一跳可忽略。

apigw 向 provider msgw 发送请求，这一跳的 span 数据需要如下信息。

四、外部组件接入

调用链路为如下几种：

·consumer > 任意多跳的外部组件 > provider，其中 consumer 与 provider 均部署在 TSF 上。TSF 依赖拓扑图将显示三个节点串联的链路，以及展示完整的两跳请求的调用详情。

·外部请求 >任意多跳的外部组件 > provider，其中 provider 部署在 TSF 上。TSF 依赖拓扑将显示外部组件和 provider 两个节点的链路，以及 外部组件 > provider 一跳请求的调用详情。

·consumer > 任意多跳的外部组件 > msgw，其中 consumer 与 msgw 均部署在 TSF 上，msgw 为微服务网关。TSF 依赖拓扑图将显示三个节点串联的链路，以及展示完整的两跳请求的调用详情。

·外部请求 > 任意多跳的外部组件 -> msgw，其中 msgw 部署在 TSF 上。TSF 依赖拓扑将显示外部组件和 msgw 两个节点的链路，以及外部组件 > msgw 一跳请求的调用详情。

consumer 侧注入

consumer 侧需要注入外部组件的组件类型，默认为 ms，表示微服务组件，无须注入。

TsfTracingContext tsfTracingContext = TsfTracingContextHolder.get();tsfTracingContext.setClientTag("remoteComponent", "ms");

consumer 侧需要注入外部组件的微服务名。注入的微服务名需要与后续传递的 HTTP header 中微服务名保持一致。

tsfTracingContext.setServerServiceName("my-service");

外部组件注入

apigw 需要透传 consumer 传递来的 trace 上下文信息。如果为第一跳，可忽略。TSF 调用链功能使用基于 zipkin，因此需要透传如下信息。

外部组件接受 consumer 的请求，这一跳的 span 数据需要如下信息。如果为第一跳可忽略。

外部组件向 provider 或 msgw 发送请求，这一跳的 span 数据需要如下信息。

五、说明与注意

注入失败不会影响业务的正常运行