文档

配置Trace链路追踪

更新时间:

您可以参考本文在API网关控制台配置Trace链路追踪,将日志上传到阿里云链路追踪平台,链路追Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具,可以帮助用户提高开发诊断效率。本功能仅支持专享实例。

前提条件

1 链路追踪授权

1.1 登录链路追踪控制台

1.2 在概览页面上,单击立即授权,授权链路追踪读写您的日志服务。

1.3 在云资源访问授权页面上,选择所需的权限,并单击同意授权。

1.4 授权后可在概览>接入流程,单击查看接入点信息,在接入点信息页,集群信息选择打开显示Token客户端采集工具选择Jaeger。即可查看到详细的接入点信息。保存通过HTTP上报数据中的接入点地址。

2 API网关配置Trace链路追踪

2.1 登录API网关控制台

2.2 在左侧导航栏选择API 管理>分组管理。在分组列表单击API分组进入分组详情。在分组详情页即可配置。

  • Trace字段位置:指定Trace字段的位置,可选位置有Header、Query。

  • Trace字段名称:自定义Trace字段的名称。

    • 如果客户端提供trace字段并且该字段的值符合标准的TraceId格式,即16位或32位的十六进制数。网关会透传给后端,并以该字段的值作为TraceId向链路追踪平台上报日志信息,并且会记录在用户API网关日志的 `CustomTraceId` 字段。

    • 如果客户端未提供Trace字段或字段值不符合规范,网关会随机生成一个TraceId向链路追踪平台上报信息。

  • 透传或生成EAGLEEYE相关头(Eagleeye-Rpcid、Eagleeye-Traceid、Eagleeye-Sampled):勾选配置后,若客户端传了EAGLEEYE相关头,网关会将相关头透传给后端服务,若没有传,网关将会生成相关头并传给后端服务。(共享实例和专享实例均可使用)

  • 透传或生成B3相关头(X-B3-traceid、X-B3-Parentspanid、X-B3-Spanid、X-B3-Sampled):勾选配置后,若客户端传了B3相关头,网关会将相关头透传给后端服务,若没有传,网关将会生成相关头并传给后端服务。(共享实例和专享实例均可使用)

  • 将追踪日志上传到阿里云链路追踪平台(仅专享实例使用):

    • 应用名称:自定义链路追踪的应用名称。

    • 接入点:填写1.4中的接入点地址,同region建议使用内网接入点,可以大幅提高效率。

    • 日志采样策略:支持全部上传、按百分比上传、每秒上传固定数,根据需要选择即可。

API网关配置Trace链路追踪后的请求可以在链路追踪控制台查看到请求链路。

关于链路追踪的使用可参考查看接口调用情况