Tracer des applications .NET Framework

Prise en main

Pour commencer le tracing d’applications écrites dans n’importe quel langage, installez et configurez tout d’abord l’Agent Datadog. Le traceur .NET instrumente vos applications et envoie leurs traces à l’Agent en s’exécutant au sein du processus.

Remarque : le traceur .NET prend en charge tous les langages basés sur .NET (C#, F#, Visual Basic, etc).

Instrumentation automatique

Avec l’instrumentation automatique, vous pouvez recueillir des données de performance sur votre application sans avoir à modifier son code. Il vous suffit juste de configurer quelques options. Le traceur .NET est prêt à l’emploi : il instrumente automatiquement toutes les bibliothèques prises en charge.

L’instrumentation automatique capture :

• Les durées d’exécution des appels instrumentés
• Les données de trace pertinentes, telles que l’URL et les codes de réponse de statut pour les requêtes Web ou les requêtes SQL pour l’accès à la base de données
• Les exceptions non traitées, y compris les traces de pile le cas échéant
• Le nombre total de traces (p. ex. les requêtes Web) transmises via le système

Le traceur .NET prend en charge l’instrumentation automatique sur .NET Framework 4.5 et ultérieur, ainsi que sur .NET Core.

Installation

Pour appliquer l’instrumentation automatique sur Windows, installez le traceur .NET sur le host à l’aide du programme d’installation MSI pour Windows. Choisissez le programme d’installation correspondant à l’architecture de votre système d’exploitation (x64 ou x86).

Une fois le traceur .NET installé, redémarrez les applications de sorte qu’elles puissent lire les nouvelles variables d’environnement. Pour redémarrer IIS, exécutez les commandes suivantes en tant qu’administrateur :

net stop /y was
net start w3svc

Variables d’environnement requises

Si votre application fonctionne dans IIS, passez directement à la section suivante.

Pour les applications Windows ne fonctionnant pas dans IIS, définissez les deux variables d’environnement suivantes avant de démarrer votre application pour activer l’instrumentation automatique :

Par exemple, pour définir les variables d’environnement à partir d’un fichier de commandes avant de démarrer votre application :

rem Définir des variables d'environment
SET COR_ENABLE_PROFILING=1
SET COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}

rem Démarrer l'application
example.exe

Pour définir les variables d’environnement pour un service Windows, utilisez la clé multi-chaînes HKLM\System\CurrentControlSet\Services\{nom du service}\Environment dans le registre Windows.

Remarque : le runtime .NET tente de charger un profileur dans n’importe quel processus .NET démarré lorsque ces variables d’environnement sont définies. Assurez-vous de limiter l’instrumentation aux applications devant être tracées. Nous vous conseillons de ne pas définir ces variables d’environnement globalement, au risque d’activer le chargement du profileur par tous les processus .NET sur le host.

Intégrations

Le traceur .NET peut instrumenter automatiquement les bibliothèques suivantes :

Mise à jour : depuis la version 1.12.0 du traceur .NET, l’intégration ASP.NET est activée automatiquement. Les packages NuGet Datadog.Trace.AspNet et Datadog.Trace.ClrProfiler.Managed ne sont donc plus requis. Supprimez-les de votre application lorsque vous mettez à jour le traceur .NET.

Remarque : l’intégration ADO.NET instrumente les appels effectués via la classe abstraite DbCommand ou l’interface IDbCommand, sans tenir compte de l’implémentation sous-jacente. Elle instrumente également les appels directs de SqlCommand.

Votre framework préféré n’est pas disponible ? Datadog élargit continuellement la liste des frameworks pris en charge. Contactez l’équipe Datadog pour obtenir de l’aide.

Instrumentation manuelle

Pour instrumenter manuellement votre code, ajoutez le paquet NuGet Datadog.Trace à votre application. Dans votre code, accédez au traceur global via la propriété Datadog.Trace.Tracer.Instance pour créer de nouvelles spans.

Pour en savoir plus sur l’instrumentation manuelle et l’application de tags personnalisés, consultez la documentation relative à l’instrumentation manuelle.

L’instrumentation manuelle est prise en charge pour .NET Framework 4.5 et ultérieur sur Windows, ainsi que pour .NET Core 2.1, 3.0 et 3.1 sur Windows et Linux.

Configuration

Il existe plusieurs façons de configurer le traceur .NET :

• en code .NET ;
• en définissant des variables d’environnement ;
• en modifiant le fichier app.config/web.config de l’application (.NET Framework uniquement) ;
• en créant un fichier datadog.json.

using Datadog.Trace;

// lire les sources de configuration par défaut (variables d'environnement, web.config, datadog.json)
var settings = TracerSettings.FromDefaultSources();

// modifier certains paramètres
settings.ServiceName = "MyService";
settings.AgentUri = new Uri("http://localhost:8126/");

// désactiver l'intégration AdoNet
settings.Integrations["AdoNet"].Enabled = false;

// créer un nouveau traceur à l'aide de ces paramètres
var tracer = new Tracer(settings);

// définir le traceur global
Tracer.Instance = tracer;

rem Définir des variables d'environnement
SET DD_TRACE_AGENT_URL=http://localhost:8126
SET DD_SERVICE_NAME=MyService
SET DD_ADONET_ENABLED=false

rem Démarrer l'application
example.exe

<configuration>
  <appSettings>
    <add key="DD_TRACE_AGENT_URL" value="http://localhost:8126"/>
    <add key="DD_SERVICE_NAME" value="MyService"/>
    <add key="DD_ADONET_ENABLED" value="false"/>
  </appSettings>
</configuration>

{
    "DD_TRACE_AGENT_URL": "http://localhost:8126",
    "DD_SERVICE_NAME": "MyService",
    "DD_ADONET_ENABLED": "false"
}

Variables de configuration

Le tableau suivant énumère les variables de configuration prises en charge. Utilisez le premier nom (p. ex., DD_TRACE_AGENT_URL) pour les variables d’environnement ou les fichiers de configuration. Lorsqu’il est précisé, le deuxième nom (p. ex., AgentUri) correspond au nom de la propriété de TracerSettings à utiliser lors du changement des paramètres dans le code.

Le premier tableau ci-dessous énumère les variables de configuration disponibles à la fois pour une instrumentation automatique ou manuelle.

Le tableau suivant énumère les variables de configuration qui sont disponibles uniquement lors de l’utilisation de l’instrumentation automatique.

Le tableau suivant énumère les variables de configuration qui sont uniquement disponibles en utilisant l’instrumentation automatique, et qui peuvent être définies pour chaque intégration. Utilisez le premier nom (p. ex., DD_<INTEGRATION>_ENABLED) pour les variables d’environnement et les fichiers de configuration. Le deuxième nom (p. ex., Enabled) correspond au nom de la propriété IntegrationSettings à utiliser lors du changement des paramètres dans le code. Accédez à ces propriétés à l’aide de l’indexeur TracerSettings.Integrations[]. Les noms d’intégrations sont énumérés dans la section Intégrations ci-dessus.

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles:

Code sourceGITHUB Surveillance .NET avec l'APM et le tracing distribué de DatadogBLOG Explorer vos services, ressources et tracesDOCUMENTATION Utilisation avancéeUTILISATION AVANCÉE