如果未发送客户端，如何在APIM入站策略中获取/设置Traceparent标头？ 更新

问题描述

我们想在Azure APIM和Application Insight中关联请求。对于API，我们有一个在入站和出站部分使用send-request的策略。我们正在使用W3C distributed tracing Azure，specification

现在，如果客户端不发送traceparent标头，则入站中的send-request请求在应用程序洞察中将不相关。

如果我们尝试在入站策略中设置traceparent标头，它将在策略的后端部分被覆盖。看起来APIM会检查传入的请求，如果未设置traceparent，则会生成该请求。但是我们无法将标头添加到策略中的传入请求中（只读）。

样品政策

<policies>
    <inbound>
        <base />
        <send-request mode="new" response-variable-name="inboundresponse" timeout="10" ignore-error="true">
            <set-url>https://someUrl.com</set-url>
            <set-method>GET</set-method>
            <set-header name="traceparent" exists-action="skip">
                <value>00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01</value>
            </set-header>
            <set-body></set-body>
        </send-request>
        <!-- for test set fixed value,but this value is overwritten by Azure APIM in backend
         and all 3 requests are not coorrelated -->
        <set-header name="traceparent" exists-action="skip">
            <value>00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01</value>
        </set-header>
    </inbound>
    <backend>
        <base />
    </backend>
    <outbound>
        <base />
        <!-- traceparent value we get here is not the same that we set -->
        <send-request mode="new" response-variable-name="outboundresponse" timeout="10" ignore-error="true">
            <set-url>https://someUrl.com</set-url>
            <set-method>GET</set-method>
            <set-header name="traceparent" exists-action="skip">
                <value>00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01</value>
            </set-header>
            <set-body></set-body>
        </send-request>
        
    </outbound>
    <on-error>
        <base />
    </on-error>
</policies>

解决方法

您是否尝试过像这样使用set-header策略：

<set-header name="traceparent" exists-action="override">
     <value>00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01</value>
</set-header>

请注意覆盖 exists-action。在我的测试中，traceparent已按预期设置并发送到后端。

更新

如果您只想在没有可用的情况下设置新的关联上下文标头，建议您使用以下语句：

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

使用context.RequestId.ToString("N")，您可以获取请求的内部相关ID，并将其格式化为不带破折号的格式。另一件事要提到：

您是否已将“设置”标签中的相关格式设置为W3C？

,

我通过在入站中添加以下标头解决了我的问题。您可以查看documentation。

 <inbound> 
  <allowed-headers>
    .....
    <header>request-id</header>
    <header>request-context</header>
    <header>traceparent</header>
   </allowed-headers>
 </inbound>

,

可能发生的情况是它生成了非法格式的 traceID，当发生这种情况时，它会生成一个新的。

HEXDIGLC = DIGIT / "a" / "b" / "c" / "d" / "e" / "f" ; lowercase hex character
value           = version "-" version-format

See Documentation