获取 APIM 生成的 traceparent 并从响应头返回

Question

通过将 Azure APIM 和 Application Insight 中的请求与 W3C 分布式跟踪 Azure 相关联，如果客户端不发送 traceparent 标头，APIM 似乎会检查传入的请求，如果没有 traceparent，APIM 将生成并从请求中设置到后端。

在这种情况下，我们希望从前端响应标头中返回 traceparent 信息，以便调用 API 的消费者可以获取它，他们可以使用此 traceparent id 报告 API 问题，以便我们可以更好地使用服务进行跟踪/诊断记录。

问题是如何从入站/出站策略中获取 APIM 生成的 traceparent，请提出一种方法，谢谢！

Answer 1

traceparent HTTP 标头字段标识跟踪系统中的传入请求。 traceparent 以可移植的固定长度格式描述传入请求在其跟踪图中的位置。

如果此时traceparent HTTP 标头不可用，您可以使用 API 管理策略的 set-header 策略进行设置。 set-header 策略用于为现有响应和/或请求标头分配值或添加新响应和/或请求标头。

当放置在入站管道中时，此策略会设置传递给目标服务的请求的 HTTP 标头。当放置在出站管道中时，此策略会设置发送到网关客户端的响应的 HTTP 标头。

下面的 sn-p 显示了如果没有可用的相关上下文标头，您如何设置新的关联上下文标头。

<set-header name="traceparent" exists-action="skip">
    <value>@($"00-{context.RequestId.ToString("N")}-0000000000000000-01")</value>
</set-header>

使用context.RequestId.ToString("N")，您可以获得请求的内部相关ID，并对其进行格式化而不使用破折号。但不要忘记将设置选项卡中的关联格式设置为 W3C。

这样，您将在请求的标题部分获得 traceparent。

我建议您阅读有关 traceparent 标头的 W3C document 和 Correlation headers using W3C TraceContext 以了解更多信息。