Datadog APM peut créer des spans déduits pour les requêtes qui transitent par Azure API Management vers vos services backend. Ces spans permettent d’obtenir des traces de bout en bout, des cartes de services et un échantillonnage basé sur la passerelle API Management.

Les spans déduits pour Azure API Management sont pris en charge uniquement pour .NET, JavaScript (Node.js), Python et Java. Les autres runtimes (par exemple Go ou PHP) n’émettent pas de spans déduits pour Azure API Management, même s’ils prennent en charge les spans déduits pour d’autres passerelles.

Prérequis

  • DD_TRACE_INFERRED_PROXY_SERVICES_ENABLED=true est défini dans les paramètres de votre application.
  • Votre backend utilise un runtime pris en charge, une version minimale du traceur et un framework web figurant dans le tableau ci-dessous.

Runtimes et frameworks web pris en charge

RuntimeTraceur DatadogVersion minimale du traceurFrameworks
Node.jsdd-trace-jsv5.87.0+express, fastify, hapi, koa, microgateway-core, next, paperplane, restify, router, apollo
Pythondd-trace-pyv4.6.0+aiohttp, asgi, bottle, cherrypy, django, djangorestframework, falcon, fastapi, flask, molten, pyramid, sanic, starlette, tornado, wsgi
.NETdd-trace-dotnetv3.39.0+ASP.NET, ASP.NET Core
Javadd-trace-javav1.64.0Servlet, Spring Web MVC, Spring WebFlux, Netty, Jetty, Tomcat, Undertow, Vert.x Web, Akka HTTP, Play, Ratpack, Grizzly, Liberty, Restlet, Synapse, Spray, Apache CXF, Axway API Gateway, Azure Functions

Configuration

Pour créer des spans déduits, Azure API Management doit transmettre les en-têtes suivants à vos services backend :

En-têteValeur
x-dd-proxyazure-apim
x-dd-proxy-request-time-msHorodatage de la requête en millisecondes Unix
x-dd-proxy-httpmethodMéthode HTTP (par exemple, depuis context.Operation.Method)
x-dd-proxy-pathModèle d’URL (par exemple, depuis context.Operation.UrlTemplate)
x-dd-proxy-regionRégion de déploiement (par exemple, depuis context.Deployment.Region)
x-dd-proxy-domain-nameHost de la requête (par exemple, depuis context.Request.OriginalUrl.Host)

Stratégie entrante

Ajoutez la stratégie suivante à la section inbound de votre API dans Azure API Management afin que ces en-têtes soient définis sur les requêtes vers votre backend :

<set-header name="x-dd-proxy" exists-action="override">
    <value>azure-apim</value>
</set-header>
<set-header name="x-dd-proxy-request-time-ms" exists-action="override">
    <value>@(new DateTimeOffset(context.Timestamp).ToUnixTimeMilliseconds().ToString())</value>
</set-header>
<set-header name="x-dd-proxy-httpmethod" exists-action="override">
    <value>@(context.Operation.Method)</value>
</set-header>
<set-header name="x-dd-proxy-path" exists-action="override">
    <value>@(context.Operation.UrlTemplate)</value>
</set-header>
<set-header name="x-dd-proxy-region" exists-action="override">
    <value>@(context.Deployment.Region)</value>
</set-header>
<set-header name="x-dd-proxy-domain-name" exists-action="override">
    <value>@(context.Request.OriginalUrl.Host)</value>
</set-header>

Vous pouvez ajouter cette stratégie au niveau de l’API dans le portail Azure sous API Management > votre API > Design → Inbound processing → Code view (voir Définir ou modifier des stratégies Azure API Management), en utilisant l’API REST Azure API Management, ou des stratégies dans votre définition d’API.

Mettre à jour les règles d’échantillonnage

L’échantillonnage basé sur l’en-tête s’applique toujours lors de l’utilisation du suivi Azure API Management. Comme le span déduit devient la nouvelle racine de trace, mettez à jour vos règles afin que la valeur du service corresponde au nom du service API Management affiché dans Datadog.

Par exemple, si la règle d’échantillonnage d’origine est :

DD_TRACE_SAMPLING_RULES='[{"service":"my-backend","sample_rate":0.5}]'

Mettez à jour la règle afin que la valeur service corresponde au nom de votre API API Management tel qu’il apparaît dans Datadog, ou supprimez la clé service pour appliquer la règle à tous les spans racines :

DD_TRACE_SAMPLING_RULES='[{"service":"my-azure-apim-api","sample_rate":0.5}]'

Ou appliquez à tous les spans racines :

DD_TRACE_SAMPLING_RULES='[{"sample_rate":0.5}]'

Pour aller plus loin